installation.md

Linguflex Installation Guide

Welcome to the Linguflex installation guide. Try to keep close to the recommended environment to enhance the likelihood of a successful installation and smooth operation. This software was developed and tested under Windows. Although primarily developed and tested for Windows, compatibility with other platforms might be possible but remains unverified. Any insights on Linux or Mac installation or operational challenges are greatly welcomed.

Table of Contents

1. Prerequisites
2. Windows Installation
   • For Windows Users
   • For Other Platforms
3. Adjust Settings
4. Environment Variables
   • Temporary Setting
   • Permanent Setting
5. Starting the Application

Prerequisites

Before you begin, ensure you have the following:

• Operating System: Windows 10 or 11 (Linux may work but requires additional experience)
• Graphics Card: Nvidia (recommended for full feature access)
• Python Version: 3.10.9
• NVIDIA CUDA Toolkit 11.8 (STRONGLY recommended)
• NVIDIA cuDNN 8.7.0 for CUDA 11.x (recommended)
  🎥 Setup Tutorial for CUDA + cuDNN
• ffmpeg
  🎥 Setup Tutorial for ffmpeg

Windows Installation

For Windows Users

1. Clone the Project:

git clone https://github.com/KoljaB/Linguflex.git
cd Linguflex

2. Installation Process:

• If Python 3.10.9 is your main Python environment:

  • Proceed directly to running the installation script.

• If Python 3.10.9 is not your main Python environment:

  • Open _install_win.bat.
  • Enter the path to Python 3.10.9 .exe on the second line, e.g.,

    set PYTHON_EXE=D:\Programme\miniconda3\envs\textgen\python.exe

  • Save the file.

• Run the Installation Script:

  _install_win.bat

For Other Platforms

(Linux, Mac, etc. - Note: These require additional expertise)

• Install the requirements and dependencies:

  pip install -r requirements.txt
  pip install torch==2.1.2+cu118 torchaudio==2.1.2+cu118 --index-url https://download.pytorch.org/whl/cu118
  pip install deepspeed
  pip install llama-cpp-python
  python download_models.py   

Adjust Settings

Edit the lingu/settings.yaml file to tailor Linguflex to your setup requirements. For the mail module to function properly, you must configure the IMAP server, username, and password in this settings file.

To use the project's default language model, you need to set the OPENAI_API_KEY. Alternatively, to switch to a local language model, adjust the use_local_llm parameter in the local_llm section of settings.yaml to true.

Environment Variables

Setting Environment Variables:

Temporary Setting (Session-only):

For temporary usage (lasts until the Command Prompt session is closed):

set OPENAI_API_KEY=your_openai_api_key_here

Permanent Setting:

For permanent usage (persists across sessions and reboots):

setx OPENAI_API_KEY "your_openai_api_key_here"

Required Variables:

• OPENAI_API_KEY (for GPT API)
• AZURE_SPEECH_KEY and AZURE_SPEECH_REGION (for Azure TTS)
• ELEVENLABS_API_KEY (for Elevenlabs TTS)
• GOOGLE_API_KEY (for Music Playout)
• OPENWEATHERMAP_API_KEY (for Weather module)

Starting the Application

Run the application using:

python -m lingu.core.run

Or execute run.bat.