View Code? Open in Web Editor NEW

OpenAGI: When LLM Meets Domain Experts

License: MIT License

Python 78.16% MATLAB 1.09% Shell 0.11% Dockerfile 0.07% Makefile 0.05% TypeScript 20.24% JavaScript 0.21% CSS 0.06% HTML 0.01%

openagi's Introduction

OpenAGI: Package for AI Agent Creation

✈️ 1. Getting Started

1.1 Installation

(1) use OpenAGI in AIOS

follow AIOS instruction to install the virtual environment
Allow your code to be able to see 'openagi'

$ pip install -e .

(2) use OpenAGI alone

set up virtual environment and install the required packages using pip

conda create -n OpenAGI python=3.11
source activate OpenAGI
cd OpenAGI
pip install -r requirements.txt

Allow your code to be able to see 'openagi'

$ pip install -e .

1.2 Usage

If you use external tool APIs in your agents, you can follow instructions of setting up tools in How to setup external tools.

You can also create .env file from the .env.example file, and then use dotenv to load the environment variables using .env file into your application's environment at runtime.

cp .env.example .env

2. Contributing

Run tests: Add your test code into the tests/ directory if any, then run test via pytest

cd openagi
pytest -v tests

sample output

============================================================================================================================= test session starts ==============================================================================================================================
platform darwin -- Python 3.11.9, pytest-8.1.1, pluggy-1.5.0 -- ""
cachedir: .pytest_cache
rootdir: ""
plugins: anyio-4.3.0
collected 2 items                                                                                                                                                                                                                                                              

tests/test_agent_creation.py::test_agent_creation PASSED                                                                                                                                                                                                                 [ 50%]
tests/test_tools.py::test_currency_converter_api PASSED                                                                                                                                                                                                                  [100%]

🖋️ 3. Research

Please check out our implementation for our research paper OpenAGI: When LLM Meets Domain Experts.

@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}
}