-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
Add comprehensive OpenHands glossary #6310
base: main
Are you sure you want to change the base?
Conversation
…ction Execution Client under Runtime
|
||
#### Local Runtime | ||
A runtime environment that executes on the local machine, suitable for development and testing. | ||
#### Modal Runtime |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit. Not newlined like the others
### Browser | ||
A system for web-based interactions and tasks. | ||
|
||
#### Browser Environment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This definition isn't filled in yet, if it matters
Terminal and execution related functionality. | ||
|
||
#### Bash Parser | ||
A component that processes and interprets bash commands and their outputs for agent interaction. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this implies an interaction between Bash Parser, Bash Session, and the Runtime, but it isn't spelled out. Also Bash is one specific shell, we might consider calling this Shell or Console at some point.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now we have tmux integrated, i don't think we have a explicit bash parser anymore, i.e., most things are handled by tmux automatically. Maybe we could remove this to reduce confusion?
The current context and status of an agent, including its memory, active tools, and ongoing tasks. | ||
|
||
#### CodeAct Agent | ||
A specialized agent type in OpenHands designed specifically for software development tasks and code manipulation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A specialized agent type in OpenHands designed specifically for software development tasks and code manipulation. | |
[A generalist agent in OpenHands](https://arxiv.org/abs/2407.16741) designed to perform tasks by editing and executing code. |
Terminal and execution related functionality. | ||
|
||
#### Bash Parser | ||
A component that processes and interprets bash commands and their outputs for agent interaction. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now we have tmux integrated, i don't think we have a explicit bash parser anymore, i.e., most things are handled by tmux automatically. Maybe we could remove this to reduce confusion?
|
||
#### Local Runtime | ||
A runtime environment that executes on the local machine, suitable for development and testing. | ||
#### Modal Runtime |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#### Modal Runtime | |
#### Modal Runtime |
This PR adds a comprehensive glossary of OpenHands-specific terms to help users and contributors better understand the system.
The glossary includes:
The glossary is stored in
.openhands/microagents/glossary.md
for easy access and maintenance.To run this PR locally, use the following command: