agential 0.1.0

A flexible agent library.

Language agent experimentation made easy.

Agential provides clear implementations of popular LLM-based agents across a variety of reasoning/decision-making and language agent benchmarks, making it easy for researchers to evaluate and compare different agents.

🤔 Getting Started

First, install the library with pip:

pip install agential

Next, let's query the ReActAgent!

from agential.llm.llm import LLM
from agential.cog.react.agent import ReActAgent

question = 'Who was once considered the best kick boxer in the world, however he has been involved in a number of controversies relating to his "unsportsmanlike conducts" in the sport and crimes of violence outside of the ring?'

llm = LLM("gpt-3.5-turbo")
agent = ReActAgent(llm=llm, benchmark="hotpotqa")
out = agent.generate(question=question)

🧭 Project Organization

---

├── agential                           <- Source code for this project.
│   ├── cog   
│   │   ├── agent                      <- Model/agent-related modules.
│   │   │     ├── strategies           <- Strategies encapsulate agent logic for each benchmark/benchmark type.
│   │   │     │       ├── base.py  
│   │   │     │       ├── qa.py
│   │   │     │       ├── math.py
│   │   │     │       └── code.py
│   │   │     │
│   │   │     ├── agent.py             <- Agent class responsible for selecting the correct strategy, prompts/few-shots, and generating responses.
│   │   │     ├── functional.py        <- Functional methods for agent. The lowest level of abstraction.
│   │   │     ├── output.py            <- Output class responsible for formatting the response from the agents.
│   │   │     ├── prompts.py           <- Prompt templates.
│   │   │     └── <modules>.py         <- Any additional modules you may have for the strategies. Agnostic to benchmarks/benchmark-types.
│   │
│   ├── eval                           <- Evaluation-related modules.
│   │
│   ├── llm                            <- LLM class.
│   │
│   └── utils                          <- Utility methods.
│       
├── docs                               <- An mkdocs project.
│
├── notebooks                          <- Jupyter notebooks. Naming convention is a number 
│                                         (for ordering), the creator's initials, and a short `-` delimited │ description, e.g. `1.0-jqp-initial-data-exploration`.
│  
├── references                         <- Data dictionaries, manuals, and all other explanatory materials.
│
├── reports                            <- Generated analysis as HTML, PDF, LaTeX, etc.
│   └── figures                        <- Generated graphics and figures to be used in reporting.
│
└── tests                              <- Tests.

---

🙏 Acknowledgement

😀 Contributing

If you want to contribute, please check the contributing.md for guidelines! Please check out the project document timeline on Notion and reach out to us if you have any questions!

😶‍🌫️ Contact Us!

If you have any questions or suggestions, please feel free to reach out to [e-mail]!