Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Place Configuration Options under Advanced Configuration #5316

Merged
merged 3 commits into from
Nov 28, 2024
Merged

Conversation

mamoodi
Copy link
Collaborator

@mamoodi mamoodi commented Nov 28, 2024

End-user friendly description of the problem this fixes or functionality that this introduces

  • Include this change in the Release Notes. If checked, you must provide an end-user friendly description for your change below

Place Configuration Options under Advanced Configuration


Give a summary of what the PR does, explaining any non-trivial design decisions

  • Place Configuration Options under Advanced Configuration
  • Add an extra note about GUI Mode
  • Add extra lines on how to pass them in to docker commands for GUI, headless, CLI, etc.

Link of any specific issues this addresses


To run this PR locally, use the following command:

docker run -it --rm   -p 3000:3000   -v /var/run/docker.sock:/var/run/docker.sock   --add-host host.docker.internal:host-gateway   -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:51aefdf-nikolaik   --name openhands-app-51aefdf   docker.all-hands.dev/all-hands-ai/openhands:51aefdf

@mamoodi mamoodi requested a review from enyst November 28, 2024 18:44
The LLM (Large Language Model) configuration options are defined in the `[llm]` section of the `config.toml` file.

To use these with the docker command, pass in `-e LLM_<option>`. Example: `-e LLM_API_KEY`.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is accurate, we may want to choose an example that isn't available in the UI Settings. Like LLM_MAX_RETRIES maybe?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated per your suggestion. LLM_NUM_RETRIES. Thanks!

Copy link
Collaborator

@enyst enyst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had a minor suggestion, but LGTM!

@mamoodi mamoodi merged commit 59532c9 into main Nov 28, 2024
16 checks passed
@mamoodi mamoodi deleted the mh/doc-config branch November 28, 2024 20:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants