Adding image_uri to docstring of runtime_env #48884
Conversation
|
cc @angelinalg |
| # Example for using image_uri | ||
| RuntimeEnv( | ||
| image_uri="anyscale/ray:2.30.0-py39") |
There was a problem hiding this comment.
Can you change this to the public ray docker image instead of the private anyscale one?
|
@zcin could you review this PR? |
|
@japneet-anyscale lint failed, could you fix it? |
| 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.
you can use it with config and env_vars
| # Example for using image_uri | ||
| RuntimeEnv( | ||
| image_uri="anyscale/ray:2.30.0-py39") |
| @@ -266,6 +270,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. Does not work with runtime env | |||
There was a problem hiding this comment.
| in a container with this image. Does not work with runtime env | |
| in a container with this image. This parameter only works alone or with the |
| @@ -266,6 +270,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. Does not work with runtime env | |||
| fields that are not ``config`` and ``env_vars`` | |||
There was a problem hiding this comment.
| fields that are not ``config`` and ``env_vars`` | |
| ``config`` or ``env_vars`` parameter. You can't use it with any other option. |
There was a problem hiding this comment.
Just trying to avoid a double negative sentence. Please adjust accordingly. I'm not sure what the sentence is trying to say. To clarify, are you trying to say that this parameter can only be used with config and env_vars?
Also, can we capture these requirements in the signature? Otherwise the signature is misleading.
|
@zcin @jjyao fixed image_uri wording and style per @angelinalg |
Adding image_uri description 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.