Installation Guide
This guide walks you through the process of installing AIGauntlet and configuring your environment for AI agent evaluation.
System Requirements
AIGauntlet requires:
- Python 3.12 or higher
- pip (Python package installer)
- An Actualization.ai account and API key
Installation Options
Standard Installation
Install AIGauntlet directly from PyPI using pip:
API Access Setup
AIGauntlet connects to our backend service to run evaluations. To access this service:
- Visit https://actualization.ai/signup to register
- Copy your key and store it securely
API Key Security: Your API key provides access to your Actualization.ai account. Never commit it to public repositories or share it in insecure channels.
Configuration
Environment Variables
We recommend storing your Actualization.ai credentials as environment variables instead of hardcoding them. For more convenient development, and to use AIGauntlet in production, create a .env
file in your project:
# Create a .env file
touch .env
# Add the following lines to your .env file
echo "ACTUALIZATION_API_KEY=your-api-key-here" >> .env
echo "ACTUALIZATION_EMAIL=your-email@example.com" >> .env
Then load them in your script:
from dotenv import load_dotenv
import os
# Load environment variables from .env file
load_dotenv()
# Access credentials
api_key = os.getenv("ACTUALIZATION_API_KEY")
email = os.getenv("ACTUALIZATION_EMAIL")
Getting Help
- GitHub Issues: Report bugs at https://www.actualization.ai/dashboard
- Support: Contact customer-service@actualization.ai for account or API issues
Next Steps
With AIGauntlet installed and configured, you're ready to evaluate your AI system! Continue to the Quick Start Guide for your first evaluation.