Adding image_uri to docstring of runtime_env #47905
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adding image_uri description and example to docstring Signed-off-by: Japneet <[email protected]>
angelinalg
reviewed
Oct 4, 2024
Co-authored-by: angelinalg <[email protected]> Signed-off-by: Japneet <[email protected]>
Co-authored-by: angelinalg <[email protected]> Signed-off-by: Japneet <[email protected]>
rkooo567
approved these changes
Oct 4, 2024
| @@ -263,6 +267,9 @@ class MyClass: | |||
| config: config for runtime environment. Either | |||
| a dict or a RuntimeEnvConfig. Field: (1) setup_timeout_seconds, the | |||
| timeout of runtime environment creation, timeout is in seconds. | |||
| image_uri: URI to a container image. The Ray worker process runs | |||
| in a container with this image. You can't use this parameter with other fields | |||
| of runtime_env. | |||
There was a problem hiding this comment.
can you specify what happens when the image cannot be found? does it raise an exception?
There was a problem hiding this comment.
RuntimeError: {"message":"failed to pull image after 5 retries: containerd client pull: failed to resolve reference "docker.io/<image_uri>": docker.io/<image_uri>: not found"}
Reduce line length Signed-off-by: Japneet <[email protected]>
japneet-anyscale
commented
Oct 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding
image_uridescription and example to docstring. The parameter is in the signature, but not in the description section for the parameters.cc: @jjyao
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.