LocalAGI 项目使用教程

LocalAGI 项目使用教程

LocalAGI 100% Local AGI with LocalAI 项目地址: https://gitcode.com/gh_mirrors/lo/LocalAGI

1. 项目目录结构及介绍

LocalAGI 是一个基于 LocalAI 的简单虚拟助手项目，其目录结构如下：

.
├── .dockerignore
├── .env
├── .gitignore
├── Dockerfile
├── LICENSE
├── README.md
├── docker-compose.yaml
├── main.py
├── pyproject.toml
├── requirements.txt
├── src/
│   └── localagi/
└── workflows/

• .dockerignore: 指定在构建 Docker 镜像时应忽略的文件和目录。
• .env: 环境变量配置文件，用于定义项目运行时所需的环境变量。
• .gitignore: 指定在 Git 仓库中应忽略的文件和目录。
• Dockerfile: 定义如何构建 LocalAGI 的 Docker 镜像。
• LICENSE: 项目使用的许可证文件。
• README.md: 项目说明文件。
• docker-compose.yaml: 定义 Docker 容器的配置，用于启动和运行项目。
• main.py: 项目的主要 Python 脚本文件，用于启动虚拟助手。
• pyproject.toml: 项目配置文件，用于定义项目的依赖和构建系统。
• requirements.txt: 项目依赖文件，列出项目运行所需的 Python 包。
• src/localagi/: 包含项目的主要代码和模块。
• workflows/: 包含 GitHub Actions 工作流文件。

2. 项目的启动文件介绍

项目的启动文件是 main.py。该文件负责初始化和运行 LocalAGI 虚拟助手。以下是 main.py 的主要部分：

# 导入必要的模块
from localagi import LocalAGI

# 初始化虚拟助手
agi = LocalAGI()

# 运行虚拟助手
agi.run()

要启动项目，可以使用以下命令：

docker-compose run -i --rm localagi

这将运行 Docker 容器中的 main.py 脚本，并启动虚拟助手。

3. 项目的配置文件介绍

项目的配置文件是 .env。该文件包含了项目运行时所需的环境变量，如 API 基地址、模型配置等。以下是一些示例配置：

# API 基地址
TTS_API_BASE=http://api:8080
LOCALAI_API_BASE=http://api:8080
IMAGES_API_BASE=http://api:8080
EMBEDDINGS_API_BASE=http://api:8080

# 模型配置
FUNCTIONS_MODEL=functions
EMBEDDINGS_MODEL=all-MiniLM-L6-v2
LLM_MODEL=gpt-4
TTS_MODEL=en-us-kathleen-low.onnx
STABLEDIFFUSION_MODEL=stablediffusion
STABLEDIFFUSION_PROMPT=DEFAULT_PROMPT

在运行项目前，可以修改 .env 文件以适应不同的环境和需求。

LocalAGI 100% Local AGI with LocalAI 项目地址: https://gitcode.com/gh_mirrors/lo/LocalAGI