Skip to main content

AI-driven task automation system

Project description

AgentForge

AgentForge is a low-code framework tailored for the rapid development, testing, and iteration of AI-powered autonomous agents. Compatible with a range of LLM models — currently supporting OpenAI, Anthopic's Claude, and Oobabooga — it offers the flexibility to run different models for different agents based on your specific needs.

Whether you're a newbie looking for a user-friendly entry point or a seasoned developer aiming to build complex cognitive architectures, this framework has you covered.

Our database-agnostic framework is designed for seamless extensibility. While ChromaDB is our go-to database, integration with other databases is straight-forward, making it an ideal playground and solid foundation for various AI projects.

In summary, AgentForge is your beta-testing ground and future-proof hub for crafting intelligent, model-agnostic, and database-flexible autonomous agents.

Table of Contents

  1. Pre-Installation
  2. Installation
  3. Dev-build Installation
  4. Usage
  5. Documentation
  6. Contributing
  7. Contact Us
  8. License

Pre-Installation

Before you get started with AgentForge, there are a few things you should know:

LLM Models

  • Local: AgentForge can run using local models via the Oobabooga implementation. You'll need to host the model locally yourself as the Oobabooga implementation in AgentForge only handles the connection to the local server created by Oobabooga; it doesn't load or install any models.
  • Cloud-Based: To use cloud-based LLM models like OpenAI, you'll need to obtain and set up API keys in your user environment variables.

Other Services

  • If you're planning to use Google Search functionalities, you'll need both a Google API key and a Google Search Engine ID key.

3rd-Party API Documentation

  • We haven't provided guides for obtaining these API keys as it's outside the scope of this project. Plenty of resources are available online to guide you through the process.

Environment Variables

Set your User Environment Variables names to the following:

  • Claude: ANTHROPIC_API_KEY
  • OpenAI: OPENAI_API_KEY
  • Google: GOOGLE_API_KEY
  • Google Search Engine ID: SEARCH_ENGINE_ID

Environment Variables


Installation

  1. Install AgentForge:
pip install agentforge
  1. Navigate to where you want your bot's project folder:
cd c:\bot\folder
  1. Run the initialization script:
agentforge init

Additionally, if you want to try our demo agent, run the following command to copy our bot script to your project folder:

agentforge salience

Dev-build Installation

If you want to install the build from the dev branch and help with development, follow these instructions instead:

Clone the GitHub repository:

git clone https://github.com/DataBassGit/AgentForge.git

Install the required dependencies:

pip install -e .

Usage

Each bot or architecture you create should contain an .agentforge folder that holds its configuration files, including default.json which currently represents the persona and contains each agent's prompts.

For Custom Agents

To get started with custom agents, navigate to Examples/CustomAgents/.agentforge/. Inside, you'll find a default.json file where you can edit the persona's name, objective, and tasks. To know more about how to use and create your own agents, check out the Agents Page.

For SalienceBot Example

If you've installed our Salience example, head over to Examples/SalienceBot/.agentforge/ to find its default.json and other configuration files.

To run the SalienceBot demo, go to Examples/SalienceBot/ in your console and run:

python salience.py

This will execute a simple bot script that uses our default SubAgents to complete an objective by breaking it down into tasks, subsequently executing them and checking for completion.

For a more detailed break-down of our Salience example please refer to the Salience Page

Note: We're planning to expand how personas work to offer more flexibility in future releases.


Documentation

For more in-depth documentation, please refer to the following sections:

Note: The documentation outlined in this section is a work in progress some links and files may not be correctly linked nor available yet.

  • Agent: Comprehensive guides on how Agents work.
  • Config: Documentation on system related configurations.
  • LLM: All you need to know about integrating LLM models.
  • Persona: How to configure and use personas.
  • SubAgents: Creating and customizing SubAgents.
  • Tools: How tools and actions are defined and executed by Agents.
  • Utils: Miscellaneous utilities.

Contributing

Feel free to open issues or submit pull requests with improvements or bug fixes. Your contributions are welcome!

Special Note

We're on the lookout for a UI/UX collaborator who's passionate about open-source and wants to join the team to help develop a front-end for this framework. This isn't a job offer, but rather an invitation to be a part of something cool. Interested? We'd love to chat! (See the Contact Us section below for details.)


Contact Us

If you're keen on contributing or just want to reach out to us, here's how to get in touch:

  • Email: contact@agentforge.net
  • Discord: We're evaluating opening our Discord server to the public. For now, we're extending direct invites to community members who are active in the AI and Autonomous Agents space.

License

This project is licensed under the GNU General Public License. See LICENSE for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agentforge-0.1.3.tar.gz (49.2 kB view hashes)

Uploaded Source

Built Distribution

agentforge-0.1.3-py3-none-any.whl (58.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page