Skip to content

Latest commit

 

History

History
144 lines (106 loc) · 4.28 KB

README.md

File metadata and controls

144 lines (106 loc) · 4.28 KB
Raw

README.md:

# 🤖 Auto-GPT: An Autonomous GPT-4 Experiment 🚀

Welcome to the **Auto-GPT Repository**, an experimental project showcasing the capabilities of GPT-4 in achieving fully autonomous tasks. This project pushes the boundaries of AI, chaining together GPT-4's reasoning to execute complex objectives with minimal human intervention. 🌐

---

## 📂 Repository Contents

### 🔑 **Core Files**
- **`.env`**: Environment configuration file for sensitive variables (e.g., API keys).
- **`Dockerfile`**: Instructions to containerize the application using Docker.
- **`requirements.txt`**: Python dependencies needed to run Auto-GPT.
- **`main.py`**: The main entry point for running Auto-GPT.

### 🧠 **Additional Features**
- **Memory Backends**: Includes support for Pinecone, Redis, Milvus, and Weaviate for storing and recalling information.
- **Speech Mode**: Integrate ElevenLabs API for text-to-speech capabilities.
- **Data Ingestion**: `data_ingestion.py` pre-seeds memory for faster and more accurate results.
- **Web Interaction**: Includes internet access for searches and summarization.

### 🌟 **Notable Additions**
- **`Financial-Planning-main.zip`** and **`kujali-main.zip`**: Example financial planning and accounting resources.
- **`startbootstrap-landing-page.zip`**: Templates for front-end web development.
- **`tests.py`**: Unit tests to ensure stability and functionality.

---

## 🚀 Features
- 🌐 **Internet Access**: Fetch real-time information for dynamic tasks.
- 💾 **Memory Management**: Store short-term and long-term context using multiple backends.
- 🧠 **GPT-4 Autonomy**: Run fully autonomous tasks with minimal input.
- 🗂️ **File Handling**: Summarize and analyze local files via GPT-4/3.5.

---

## 📋 Requirements
To run Auto-GPT, ensure the following:

### **Mandatory**
- 🐍 Python 3.10 or later  
- 🌐 OpenAI API Key ([Get it here](https://platform.openai.com/account/api-keys))  
- Docker (optional for containerization)  

### **Optional**
- Pinecone, Redis, Milvus, or Weaviate for memory backends.
- ElevenLabs API Key for TTS (Text-to-Speech) features.

---

## 💾 Installation

1. **Clone the Repository**:
   ```bash
   git clone https://github.com/ali3brt/autigpt1111.git
   cd Auto-GPT

  1. Install Dependencies:

    pip install -r requirements.txt

  2. Configure Environment Variables:

    • Copy .env.template to .env: 
      cp .env.template .env
    • Add your OpenAI API Key and any additional keys (e.g., ElevenLabs, Pinecone) to .env.

  3. Run Auto-GPT:

    python -m autogpt

🧠 Memory Backend Setup

  • Redis: Run Redis with Docker: 
    docker run -d --name redis -p 6379:6379 redis
  • Pinecone: Add your Pinecone API Key and environment details to .env.
  • Weaviate: Install the client: 
    pip install weaviate-client

🔧 Usage

Basic Commands

  • Start Auto-GPT: 
    ./run.sh start
  • Run in Continuous Mode (⚠️ Use with caution): 
    python -m autogpt --continuous
  • Run with Debugging: 
    python -m autogpt --debug

Docker Usage

  1. Build and run the Docker image: 
    docker build -t autogpt .
docker run -it --env-file=.env autogpt

⚠️ Limitations

  • Experimental: This is not a polished product and may not work well in complex, real-world business scenarios.
  • Expensive: Ensure you monitor your OpenAI token usage to avoid unexpected charges.

🛡 Disclaimer

Auto-GPT is provided "as-is" and comes with no warranties. By using this project, you assume all risks associated with it. Please use responsibly and within the boundaries of applicable laws.

📬 Contact

❤️ Contribute

Contributions are welcome! Fork this repo, make your changes, and submit a pull request. Let's build something incredible together! 🤝

⭐ If you find this project useful, don't forget to star it! ⭐