docs: Add comprehensive GPU support documentation #155
Conversation
This file contains hidden or 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
- Add GPU configuration section to configuration-options.mdx with enable_gpu and cuda_visible_devices parameters - Enhance gui-mode.mdx with advanced GPU configuration examples - Update environment-variables.mdx with detailed GPU variable descriptions - Add complete GPU support guide to SDK docker-sandbox.mdx with code examples - Include prerequisites, verification steps, and use cases for GPU-enabled workspaces Co-authored-by: openhands <[email protected]>
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.
HUMAN: this needs testing
Description
This PR adds comprehensive documentation for GPU support in OpenHands Docker workspaces, covering both the main OpenHands application and the Software Agent SDK.
Changes
OpenHands Application Documentation
1. Configuration Options (
openhands/usage/advanced/configuration-options.mdx)enable_gpuparameter (boolean, default: false)cuda_visible_devicesparameter for selective GPU mountingconfig.tomlconfigurationsnvidia-smi2. GUI Mode (
openhands/usage/run-openhands/gui-mode.mdx)config.tomlconfiguration example3. Environment Variables (
openhands/usage/environment-variables.mdx)SANDBOX_ENABLE_GPUandSANDBOX_CUDA_VISIBLE_DEVICESSoftware Agent SDK Documentation
4. Docker Sandbox (
sdk/guides/agent-server/docker-sandbox.mdx)DockerWorkspaceDockerDevWorkspacewith CUDASource References
All documentation is based on analysis of the following source code:
OpenHands Main Application:
OpenHands/openhands/core/config/sandbox_config.py(lines 86, 96)OpenHands/openhands/runtime/impl/docker/docker_runtime.py(lines 497-511)OpenHands/openhands/core/config/arg_utils.py(line 182)OpenHands/config.template.tomlSoftware Agent SDK:
software-agent-sdk/openhands-workspace/openhands/workspace/docker/workspace.py(lines 113-116, ~295)External Documentation:
Documentation Verification
✅ All configuration options documented match the actual code implementation
✅ All examples are based on verified code patterns
✅ All prerequisites are necessary for the feature to work
✅ Installation commands are from official NVIDIA documentation
✅ No speculative or unverified information included
Testing
The documentation describes features that can be tested with:
nvidia-smiin the OpenHands workspace to verify GPU accessNote: This is a documentation-only PR with no code changes.
@neubig can click here to continue refining the PR