| Name | pyopenagi JSON |
| Version |
0.0.11
JSON |
| download |
| home_page | None |
| Summary | OpenAGI: Package for AI Agent Creation |
| upload_time | 2024-09-11 17:52:42 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 AGI Research Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
agi
llm
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
python-dotenv
Requests
Pympler
click
python-dotenv
beautifulsoup4
playwright
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# OpenAGI: Package for AI Agent Creation
<a href='https://arxiv.org/abs/2304.04370'><img src='https://img.shields.io/badge/Paper-PDF-red'></a>
[](https://github.com/agiresearch/OpenAGI/blob/main/LICENSE)
<a href='https://discord.gg/B2HFxEgTJX'><img src='https://img.shields.io/badge/Community-Discord-8A2BE2'></a>
## ✈️ Getting Started
OpenAGI is used as the agent creation package to build agents for [AIOS](https://github.com/agiresearch/AIOS).
### Installation
From PyPI
```
pip install pyopenagi
```
Locally
```
git clone https://agiresearch/OpenAGI
cd OpenAGI
pip install -e .
```
### Usage
#### Add a new agent
To add a new agent, first you need to create a folder under the pyopenagi/agents folder.
The folder needs to be the following structure:
```
- pyopenagi/agents
- author
- agent_name
- agent.py # main code for the agent execution logic
- config.json # set up configurations for agent
- meta_requirements.txt # dependencies that the agent needs
```
If you want to use external tools provided by openagi in your agents, you can follow instructions of setting up tools in [How to setup external tools](./tools.md).
If you want to add new tools for your developing agent,
you need to add a new tool file in the [folder](./pyopenagi/tools/).
#### Upload agent
If you have developed and tested your agent, and you would like to share your agents, you can use the following to upload your agents
```
python pyopenagi/agents/interact.py --mode upload --agent <author_name/agent_name>
```
💡Note that the `agent` param must exactly match the folder you put your agent locally.
#### Download agent
If you want to look at implementations of other agents that others have developed, you can use the following command:
```
python pyopenagi/agents/interact.py --mode download --agent <author_name/agent_name>
```
## 🚀 Contributions
For detailed information on how to contribute, see [CONTRIBUTE](./CONTRIBUTE.md). If you would like to contribute to the codebase, [issues](https://github.com/agiresearch/OpenAGI/issues) or [pull requests](https://github.com/agiresearch/OpenAGI/pulls) are always welcome!
## 🖋️ Research
Please check out our [implementation](https://github.com/agiresearch/OpenAGI/tree/research) for our research paper [OpenAGI: When LLM Meets Domain Experts](https://arxiv.org/abs/2304.04370).
```
@article{openagi,
title={OpenAGI: When LLM Meets Domain Experts},
author={Ge, Yingqiang and Hua, Wenyue and Mei, Kai and Ji, Jianchao and Tan, Juntao and Xu, Shuyuan and Li, Zelong and Zhang, Yongfeng},
journal={In Advances in Neural Information Processing Systems (NeurIPS)},
year={2023}
}
```
## 🌍 OpenAGI Contributors
[](https://github.com/agiresearch/OpenAGI/graphs/contributors)
## 🌟 Star History
[](https://star-history.com/#agiresearch/OpenAGI&Date)
Raw data
{
"_id": null,
"home_page": null,
"name": "pyopenagi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "agi, llm",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/3a/33/68041ccff0b78335c4820378602cef7384bd193a027acce68ad45f9c6716/pyopenagi-0.0.11.tar.gz",
"platform": null,
"description": "# OpenAGI: Package for AI Agent Creation\n<a href='https://arxiv.org/abs/2304.04370'><img src='https://img.shields.io/badge/Paper-PDF-red'></a>\n[](https://github.com/agiresearch/OpenAGI/blob/main/LICENSE)\n<a href='https://discord.gg/B2HFxEgTJX'><img src='https://img.shields.io/badge/Community-Discord-8A2BE2'></a>\n\n\n## \u2708\ufe0f Getting Started\nOpenAGI is used as the agent creation package to build agents for [AIOS](https://github.com/agiresearch/AIOS).\n### Installation\nFrom PyPI\n```\npip install pyopenagi\n```\nLocally\n```\ngit clone https://agiresearch/OpenAGI\ncd OpenAGI\npip install -e .\n```\n\n### Usage\n\n#### Add a new agent\nTo add a new agent, first you need to create a folder under the pyopenagi/agents folder.\nThe folder needs to be the following structure:\n```\n- pyopenagi/agents\n - author\n - agent_name\n - agent.py # main code for the agent execution logic\n - config.json # set up configurations for agent\n - meta_requirements.txt # dependencies that the agent needs\n```\nIf you want to use external tools provided by openagi in your agents, you can follow instructions of setting up tools in [How to setup external tools](./tools.md).\nIf you want to add new tools for your developing agent,\nyou need to add a new tool file in the [folder](./pyopenagi/tools/).\n\n#### Upload agent\nIf you have developed and tested your agent, and you would like to share your agents, you can use the following to upload your agents\n```\npython pyopenagi/agents/interact.py --mode upload --agent <author_name/agent_name>\n```\n\ud83d\udca1Note that the `agent` param must exactly match the folder you put your agent locally.\n\n#### Download agent\nIf you want to look at implementations of other agents that others have developed, you can use the following command:\n```\npython pyopenagi/agents/interact.py --mode download --agent <author_name/agent_name>\n```\n\n## \ud83d\ude80 Contributions\n\nFor detailed information on how to contribute, see [CONTRIBUTE](./CONTRIBUTE.md). If you would like to contribute to the codebase, [issues](https://github.com/agiresearch/OpenAGI/issues) or [pull requests](https://github.com/agiresearch/OpenAGI/pulls) are always welcome!\n\n## \ud83d\udd8b\ufe0f Research\nPlease check out our [implementation](https://github.com/agiresearch/OpenAGI/tree/research) for our research paper [OpenAGI: When LLM Meets Domain Experts](https://arxiv.org/abs/2304.04370).\n\n```\n@article{openagi,\n title={OpenAGI: When LLM Meets Domain Experts},\n author={Ge, Yingqiang and Hua, Wenyue and Mei, Kai and Ji, Jianchao and Tan, Juntao and Xu, Shuyuan and Li, Zelong and Zhang, Yongfeng},\n journal={In Advances in Neural Information Processing Systems (NeurIPS)},\n year={2023}\n}\n```\n\n## \ud83c\udf0d OpenAGI Contributors\n[](https://github.com/agiresearch/OpenAGI/graphs/contributors)\n\n\n\n## \ud83c\udf1f Star History\n\n[](https://star-history.com/#agiresearch/OpenAGI&Date)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 AGI Research Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "OpenAGI: Package for AI Agent Creation",
"version": "0.0.11",
"project_urls": {
"Homepage": "https://github.com/agiresearch/OpenAGI",
"Repository": "https://github.com/agiresearch/OpenAGI.git",
"Tools Docs": "https://github.com/agiresearch/OpenAGI/tools.md"
},
"split_keywords": [
"agi",
" llm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e7a7159ae2f8b161d6cbcb559499ef954882a10e0c32c023cbd3fd7e07f92fdf",
"md5": "5e26459aa1f92decc14654d059a6d98b",
"sha256": "2b03262a2b7e96005818e52b85d4a04d4ae9f315e1bbd0a67518e94b4308e43a"
},
"downloads": -1,
"filename": "pyopenagi-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e26459aa1f92decc14654d059a6d98b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 185121,
"upload_time": "2024-09-11T17:52:40",
"upload_time_iso_8601": "2024-09-11T17:52:40.117438Z",
"url": "https://files.pythonhosted.org/packages/e7/a7/159ae2f8b161d6cbcb559499ef954882a10e0c32c023cbd3fd7e07f92fdf/pyopenagi-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3a3368041ccff0b78335c4820378602cef7384bd193a027acce68ad45f9c6716",
"md5": "4d2c89287fd7de2e2a2fa033f6cfe9e2",
"sha256": "b535924fe6cff1c7f924d3e1059e77aacdedf3e829fdd738491615ddeda9bcee"
},
"downloads": -1,
"filename": "pyopenagi-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "4d2c89287fd7de2e2a2fa033f6cfe9e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 127327,
"upload_time": "2024-09-11T17:52:42",
"upload_time_iso_8601": "2024-09-11T17:52:42.150775Z",
"url": "https://files.pythonhosted.org/packages/3a/33/68041ccff0b78335c4820378602cef7384bd193a027acce68ad45f9c6716/pyopenagi-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-11 17:52:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "agiresearch",
"github_project": "OpenAGI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "python-dotenv",
"specs": []
},
{
"name": "Requests",
"specs": []
},
{
"name": "Pympler",
"specs": [
[
"==",
"1.0.1"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.7"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "beautifulsoup4",
"specs": []
},
{
"name": "playwright",
"specs": []
}
],
"lcname": "pyopenagi"
}
