diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 8 insertions, 8 deletions
@@ -6,15 +6,15 @@ Unlock the power of AI—right from your Linux terminal. This project delivers a fully local AI environment, running open source language models directly on your machine. -No cloud. No GAFAM. Just full privacy, control, and the freedom to manipiulate commands in your shell. +No cloud. No GAFAM. Just full privacy, control, and the freedom to manipulate commands in your shell. ## How it works * [Ollama](https://ollama.com/) run language models on the local machine. -* [openedai-speech](https://github.com/matatonic/openedai-speech) provide text to speech capability. +* [openedai-speech](https://github.com/matatonic/openedai-speech) provides text-to-speech capability. * [speaches-ai](https://github.com/speaches-ai/speaches) provide transcription, translation, and speech generation. * [nginx](https://nginx.org/en/) add an authentication to the API. -* [aichat](https://github.com/sigoden/aichat) is used as LLM CLI tool featuring Shell Assistant, Chat-REPL, RAG, AI Tools & Agents. +* [AIChat](https://github.com/sigoden/aichat) is used as LLM CLI tool featuring Shell Assistant, Chat-REPL, RAG, AI Tools & Agents. Everything is free, open-source and automated using Docker Compose and shell scripts. @@ -22,7 +22,7 @@ Everything is free, open-source and automated using Docker Compose and shell scr To run this project efficiently, a modern computer with a recent NVIDIA GPU is required. -As an example, I achieve good performance with an Intel(R) Core(TM) i7-14700HX, a GeForce RTX 4050, and 32GB of RAM. +As an example, I achieved good performance with an Intel(R) Core(TM) i7-14700HX, a GeForce RTX 4050, and 32GB of RAM. You must use Linux and the [NVIDIA Container Toolkit](https://github.com/NVIDIA/nvidia-container-toolkit). @@ -42,9 +42,9 @@ docker compose up --build -d ## How to use -The `setup_desktop.sh` script allows for copying a compiled static version of [aichat](https://github.com/sigoden/aichat) from a container to your host and configuring the tool. +The `setup_desktop.sh` script allows for copying a compiled static version of [AIChat](https://github.com/sigoden/aichat) from a container to your host and configuring the tool. -### Aichat essentials +### AIChat essentials To launch a chatbot while maintaining context: ```bash @@ -74,7 +74,7 @@ Example: ### Speech To Text -For the Speech to Text functionality use `tools/stt.sh`. +For the Speech to Text functionality, use `tools/stt.sh`. The function record allows you to use PulseAudio to record the computer's audio (for example, a video in the browser). The transcription function converts the audio file into text. @@ -90,7 +90,7 @@ The API authentication via Nginx allows you to open the API on the internet and By adding a reverse proxy like Caddy in front of it, you can also add TLS encryption. This way, you can securely use this environment remotely. -To use the scripts tools in a remote context, use the environment variables TTS_API_HOST and STT_API_HOST and modify ~/.config/aichat/config.yaml . +To use script tools in a remote context, use the environment variables TTS_API_HOST and STT_API_HOST and modify AIChat config (~/.config/aichat/config.yaml) . Example: ``` |