Updated OpenEnv docs #4418
Updated OpenEnv docs #4418
Conversation
… into openenv-docs-improvement
docs/source/openenv.md
Outdated
|
|
||
| # Create HTTP client for Echo Environment | ||
| client = EchoEnv.from_docker_image("echo-env:latest") | ||
| client = EchoEnv.from_docker_image("echo-env:latest") # or client = EchoEnv(base_url=f"{ENV_URL}") |
There was a problem hiding this comment.
We could also use a separate snippet for the client and thenhfoptions to expose the options as tabs.
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
burtenshaw
left a comment
burtenshaw
left a comment
There was a problem hiding this comment.
Just some small changes and check. Also, note that there are PRs on OpenEnv that impact this flow and be merged in the coming days. Maybe we should hold back?
| docker run -d -p 8001:8001 registry.hf.space/openenv-echo-env:latest | ||
| ``` | ||
|  | ||
| 2. **Local Python process**: Launch the environment directly using Uvicorn. |
There was a problem hiding this comment.
The user will need to know to be in the OpenEnv repo for this to work.
|
|
||
| Example: | ||
| ```bash | ||
| docker run -d -p 8001:8001 registry.hf.space/openenv-echo-env:latest |
There was a problem hiding this comment.
I'm not sure that this port mapping will work because the env doesn't use 8001, it uses 8000.
There was a problem hiding this comment.
8000 is for vLLM in the snippets we provide 🤔
There was a problem hiding this comment.
sorry for the late reply. I meant that the internal port in the mapping needs to match what the container is using (8000). the external post can be changed to match the host network.
docs/source/openenv.md
Outdated
| ``` | ||
| Alternatively, you can manually start the Echo environment in a Docker container before running the training. | ||
| In this case, initialize the client with |
There was a problem hiding this comment.
I think this should the start docker snippet should come before the change EchoEnv change.
| ```bash | ||
| # Launch the Echo environment | ||
| docker run -d -p 8001:8001 registry.hf.space/openenv-echo-env:latest |
There was a problem hiding this comment.
as above, I think we should double check this port mapping.
|
Updated!
Since this belongs to the |
qgallouedec
left a comment
qgallouedec
left a comment
There was a problem hiding this comment.
LGTM, I'm mostly relying on you for this part, so feel free to make updates whenever you think it makes sense
What does this PR do?
I'm playing with the OpenEnv integration and I'd like to add some more details about how to setup up everything.
For example:
Before submitting
Pull Request section?
to it if that's the case.
Who can review?
@qgallouedec @burtenshaw