Installation Guide¶
This document provides detailed instructions for installing and setting up Agent. Follow these steps to ensure a smooth installation process.
Cloning the Repository¶
Begin by cloning the Agent repository and navigating to the project directory:
Clone the repository:
git clone [Repository URL]
Change directory to the cloned repository:
cd agent
Installing Conda¶
Next, install Conda. You can choose any preferred method for this, but we recommend the microconda distribution. For detailed instructions, please visit the official Conda installation guide.
Creating and Activating the Environment¶
After installing Conda, create and activate the agent environment:
To create the environment, run:
conda create -n agent --file conda-linux-64.lock
To activate the environment, execute:
conda activate agent
Installing Dependencies¶
With the environment active, proceed to install the dependencies:
poetry install
Optionally, you can install all extra dependencies:
poetry install --all-extras
Note: if the poetry install fails, run multiple times until successful. Failing this it is recommended that you check your proxy/internet restrictions. You can also export poetry’s dependencies to a requirements.txt format by running:
poetry export --without-hashes --format=requirements.txt > requirements.txt
and then installing with
pip install -r requirements.txt
Explanation of Extras¶
The extra dependencies are categorized as follows:
backend: For running LLM servers.
training: For RL or SFT training.
Extras for different environments include:
alfworld
babyai
humaneval
webshop
These can be installed separately if not included in –all-extras. For example, to install only the alfworld extras, run:
poetry install --extras alfworld