Skip to content

Commit

Permalink
Fix arg names in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AlbertDominguez authored Oct 16, 2024
1 parent 806ce89 commit 9fda402
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/train.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ You can train a model using the CLI as follows:

.. code-block:: console
spotiflow-train /path/to/spots_data --save-dir /my/trained/model
spotiflow-train /path/to/spots_data -o /my/trained/model
where `/path/to/spots_data` is the path to the directory containing the data in the format described above and `/my/trained/model` is the directory where the trained model will be saved. You can also pass other parameters to the training, such as the number of epochs, the learning rate, etc. For more information on the arguments allowed, see the documentation of the CLI command:

Expand All @@ -62,7 +62,7 @@ To illustrate with an example, to train a Spotiflow model on 2-channel 3D data f

.. code-block:: console
spotiflow-train /path/to/spots_data --save-dir /my/trained/model --is-3d True --num-epochs 100 --in-channels 2
spotiflow-train /path/to/spots_data -o /my/trained/model --is-3d True --num-epochs 100 --in-channels 2
Basic training (API)
^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 9fda402

Please sign in to comment.