Skip to content

Latest commit

 

History

History
132 lines (94 loc) · 6.44 KB

InstallationGuide.md

File metadata and controls

132 lines (94 loc) · 6.44 KB
Raw

AgentForge Installation and Usage Guide

Pre-Installation

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

LLM Models

  • Local: AgentForge can run using self-hosted models via the Oobabooga implementation. You'll need to host the model either locally yourself or on a cloud server as the Oobabooga implementation in AgentForge only handles the connection to the server created by Oobabooga; it doesn't download 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.

LLM API Keys

  • You don't need API keys for all providers if you plan on using just one. No API keys are needed if you're using the Oobabooga implementation. The model you wish to use can be specified in the Model Configuration file.

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.

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

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.

Microsoft C++ Build Tools (WINDOWS ONLY)

Note: If you already have all the Microsoft C++ Build Tools below, you can skip ahead to the Installation section.

  1. ChromaDB requires Microsoft C++ Build Tools in order to work with Windows.
  2. Once downloaded, mark the 'Desktop Development with C++' for installation. It should automatically select these optional packages for you. Cpp_Setup
  3. When the installation is complete, you'll see a message that says, 'All installations are up-to-date.' Cpp_Completion
  4. Done! Close the Visual Studio installer.

Installation Guide for AgentForge

Follow these steps to install and set up AgentForge:

Prerequisites

Ensure your system has Python 3 and pip installed:

sudo apt-get update
sudo apt-get install python3 python3-pip

Installation Steps

  1. (Optional) Set Up a Virtual Environment: It's highly recommended to use a virtual environment to avoid conflicts with system-wide packages.

    • Install the virtual environment package if you haven't already: 
      sudo pip3 install virtualenv
    • Create and activate a virtual environment (replace my_project with your desired directory): 
      mkdir my_project
cd my_project
virtualenv venv
source venv/bin/activate

  2. Install AgentForge: Navigate to your project directory and install AgentForge using pip:

    pip install agentforge

  3. Initialize Your Project: Initialize your AgentForge project by running the following command in your project's root directory:

    python -m agentforge.init_agentforge

    This command will create a new .agentforge folder in your project with sub-folders containing YAML files as shown below:

    my_project_root/
   .agentforge/
      actions/
      agents/
      personas/
      settings/
      tools/

    At this point your project is ready to start using the AgentForge framework.

When you're done working in the virtual environment, deactivate it with deactivate. Remember to activate the virtual environment (source venv/bin/activate) whenever you return to work on your project.

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
cd agentforge
pip install -e .

Usage

Each Cognitive Architecture (bot) you create should contain an .agentforge folder which contains everything pertaining to its agents and personas along with other configuration files.

Important: Before running any bot, we need to make sure that the configuration files have the correct LLM settings. If you've selected an OpenAI model, for example, the system will look for the corresponding API key in your environment variables. This applies not only to the default settings but also to individual Custom Agents as they can override these settings and call different models if needed.

Note: We define Cognitive Architectures or Bots as Multi-Agent Scripts!

Custom Agents

With AgentForge, you have the flexibility to create any number of Custom Agents and structure them however you want in the project. Put simply, a custom agent is a user-defined agent that can specifically meet your needs.

Agent and Prompt Yaml Files

You need to ensure that each agent has a corresponding prompt yaml file. These prompt yaml files need to be placed inside the .agentforge/agents folder. You are free to nest your prompt yaml files within folders however you want. The system is capable of finding the corresponding file as long as it's nested somewhere within the .agentforge/agents folder.

Once your custom agents have been set up, you can leverage them in the same way as predefined agents. Remember that each agent must be properly tested and configured to ensure optimal results.

Module Agents

Inside the .agentforge/agents folder, there's a ModuleAgents folder. This folder contains the prompts for the agents used in our Predefined Modules (multi-agent scripts). These are standard agents that we have created to provide built-in functionalities for common tasks.

Important Note: Whenever a bot runs, it will first initialize ChromaDB (or whichever database is used) as it will act as the memory for the agents. The first time Chroma is initialized on a system it needs to download a few language models for sentence embedding, so it is normal for it to take several minutes to run the first time. Any subsequent runs will not have this issue as long as Chroma has previously downloaded the models being used.