Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warning on argparse gpus flag #7236

Closed
wants to merge 1 commit into from
Closed

Add warning on argparse gpus flag #7236

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/source/common/trainer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,10 @@ In Python scripts, it's recommended you use a main function to call the Trainer.

main(args)

.. warning::

When using argparse, note that integers are passed as strings, so passing ``--gpus 3`` is equivalent to ``--gpus [0, 1, 2]``. To select a GPU by it's index, pass it as a list (``--gpus [3]``).

So you can run it like so:

.. code-block:: bash
Expand Down