Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
beat
beat.editor
Commits
f6114eae
Commit
f6114eae
authored
Feb 18, 2020
by
André Anjos
💬
Browse files
[doc] Some minor edits on the quick-start guide
parent
cb55ffc6
Pipeline
#37437
passed with stage
in 6 minutes and 37 seconds
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
doc/quick_start_guide.rst
View file @
f6114eae
...
...
@@ -60,7 +60,7 @@ either a reduced or different dataset. Once you have everything working as
expected, push the resulting code to the platform and execute it there, for
validation.
The following steps describe the procedure to start from an existing
The following steps describe the procedure to start from an
**
existing
**
experiment and build on that.
#. Get (or pull) the reference experience you would like to base your work on:
...
...
@@ -77,7 +77,7 @@ experiment and build on that.
Values within angle brackets (``<`` and ``>``) will depend on the asset
name. Replace these values by appropriate actual values.
#. Create your own fork f
rom
the experiment:
#. Create your own fork
o
f the experiment:
.. code-block:: sh
...
...
@@ -89,7 +89,6 @@ experiment and build on that.
(beat) $ beat algorithm fork <author>/<algorithm>/<version> <your-beat-user-id>/<algorithm>/<version>
This will allow you to use your own modified algorithm for your fork.
.. note::
...
...
@@ -100,7 +99,7 @@ experiment and build on that.
.. note::
You do not need to fork an algorithm, you can use a different one as
long as its inputs and outputs match
es
the one you want to replace.
long as its inputs and outputs match the one you want to replace.
#. Edit the code:
...
...
@@ -123,7 +122,7 @@ experiment and build on that.
also allows to start your favorite editor for code or documentation
modification.
#. Once the editing is done, you can run an experiment like this:
#. Once the editing is done, you can run an experiment
**locally**
like this:
.. code-block:: sh
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment