AI-Companion

Your AI companion to support you during your lows and highs, providing intelligent, real-time assistance.

---

Overview

The AI Companion is a low-latency voice assistant that:

• Converts voice input to text using OpenAI's Whisper.
• Processes text using Hugging Face's Large Language Model (LLM).
• Converts responses back to speech with Edge-TTS.
• Features a web interface and real-time performance optimization for seamless interaction.

---

Features

• Voice Activity Detection (VAD): Detects speech activity and ignores silence.
• Speech-to-Text (STT): High-accuracy transcription using the faster-whisper model.
• Text-to-Speech (TTS): Converts text to natural speech with tunable pitch, speed, and voice type.
• LLM Integration: Generates intelligent responses with Hugging Face models.
• Streamlit Interface: Offers a user-friendly web-based interaction mode.

---

Installation

Install Daytona

1. Run the following command to install Daytona:

   curl -sf -L https://download.daytona.io/daytona/install.sh | sudo bash

2. Start the Daytona server:

   daytona server -y && daytona

3. If the server daemon stops at any point, restart it using:

   daytona serve

4. Create a workspace for the AI Companion:

   daytona create https://github.com/Ankur2606/AI-Companion.git --devcontainer-path=.devcontainer/devcontainer.json

5. Ensure dependencies are installed (if not already present):

   apt-get update && apt-get install -y portaudio19-dev python3-pyaudio
   pip install black pylint autopep8 yapf bandit flake8 mypy pycodestyle pydocstyle

---

Manual Setup

Prerequisites

• Python 3.11+
• Git
• Hugging Face API Token

Steps

1. Clone the Repository:

   git clone https://github.com/Ankur2606/AI-Companion.git
   cd AI-Companion

2. Install System Dependencies (if not available):

   sudo apt-get update && sudo apt-get install -y portaudio19-dev python3-pyaudio

3. Set Up a Virtual Environment:

   python -m venv .venv
   source .venv/bin/activate  # On Windows: .venv\Scripts\activate

4. Install Development Dependencies:

   pip install black pylint autopep8 yapf bandit flake8 mypy pycodestyle pydocstyle

5. Install Project Dependencies:

   pip install --upgrade pip
   pip install -r requirements.txt

6. Configure Hugging Face Token:

   • Create an account at Hugging Face and generate an API token.
   • Set the token as an environment variable:

     export HUGGINGFACE_API_TOKEN=your_token  # On Windows: set HUGGINGFACE_API_TOKEN=your_token

7. Run the Application:

   streamlit run app.py

---

Usage

Daytona Mode

Run the project through Daytona for optimized performance:

1. Start Daytona if not already running:

   daytona serve

2. Launch the AI Companion:

   daytona run

---

Manual Mode

1. Web Interface: Launch the Streamlit web app:

   streamlit run app.py

---

Troubleshooting

• Daytona Server Issues:
  If the server stops, restart it with:

  daytona serve

• Initial Model Downloads:
  The faster-whisper model may take time to download (~2GB). Ensure a stable internet connection.

• Environment Variable Issues:
  Verify the Hugging Face API token is correctly set in your environment.

---

Contributing

We welcome contributions! Please feel free to:

• Open issues for bugs or suggestions.
• Submit pull requests for improvements.

---

License

This project is licensed under the MIT License.