hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-06 02:21:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add warning about entrpoint command in quotes (#25519)

Browse source
This commit is contained in:
Archit Kulkarni 2022-06-08 09:38:55 -07:00 • committed by GitHub
parent 98685f415e
commit 3296345557
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/source/cluster/job-submission.rst
View file

@ -167,6 +167,11 @@ Here are some examples of CLI commands from the Quick Start example and their ou
{'raysubmit_AYhLMgDJ6XBQFvFP': JobInfo(status='SUCCEEDED', message='Job finished successfully.', error_type=None, start_time=1645908622, end_time=1645908623, metadata={}, runtime_env={}),
'raysubmit_su9UcdUviUZ86b1t': JobInfo(status='SUCCEEDED', message='Job finished successfully.', error_type=None, start_time=1645908669, end_time=1645908670, metadata={}, runtime_env={})}
.. warning::
When using the CLI, do not wrap the entrypoint command in quotes. For example, use
``ray job submit --working_dir="." -- python script.py`` instead of ``ray job submit --working_dir="." -- "python script.py"``.
Otherwise you may encounter the error ``/bin/sh: 1: python script.py: not found``.
Using the CLI on a remote cluster
"""""""""""""""""""""""""""""""""

6
doc/source/cluster/jobs-package-ref.rst
View file

@ -15,6 +15,12 @@ Job Submission CLI
.. click:: ray.dashboard.modules.job.cli:submit
:prog: ray job submit
.. warning::
When using the CLI, do not wrap the entrypoint command in quotes. For example, use
``ray job submit --working_dir="." -- python script.py`` instead of ``ray job submit --working_dir="." -- "python script.py"``.
Otherwise you may encounter the error ``/bin/sh: 1: python script.py: not found``.
.. _ray-job-status-doc:
.. click:: ray.dashboard.modules.job.cli:status