INSTALL.md 2.2 KB

安装说明

依赖管理

问题说明

在安装过程中,某些依赖可能会因为编译问题而失败:

  1. faiss-cpu: 需要 SWIG 编译器,在某些系统上编译困难
  2. selenium: 需要浏览器驱动,可能增加复杂性
  3. 开发工具: black, isort, flake8 等是可选工具

解决方案

我们提供了两个依赖文件:

1. requirements-minimal.txt(推荐)

包含核心功能必需的依赖,安装成功率最高:

pip install -r requirements-minimal.txt

2. requirements.txt

包含所有依赖,包括可选工具:

pip install -r requirements.txt

如果仍然遇到问题

对于 faiss-cpu 问题:

# 方法1:使用 conda 安装
conda install -c conda-forge faiss-cpu

# 方法2:使用预编译包
pip install faiss-cpu --no-build-isolation

# 方法3:暂时跳过,只使用 ChromaDB
# 项目已经配置为默认使用 ChromaDB

对于其他编译问题:

# 安装编译工具
# Ubuntu/Debian
sudo apt-get install build-essential

# macOS
xcode-select --install

# Windows
# 安装 Visual Studio Build Tools

功能影响

移除某些依赖后的功能影响:

  1. FAISS 向量数据库: 暂时禁用,但 ChromaDB 功能完整
  2. Selenium: 网页抓取功能受限,但其他功能正常
  3. 开发工具: 代码格式化功能受限,但不影响核心功能

验证安装

安装完成后,运行以下命令验证:

# 运行基本示例
python examples/basic_usage.py

# 或使用运行器
python run_examples.py

系统要求

  • Python 3.8+
  • 内存: 至少 2GB RAM
  • 磁盘空间: 至少 500MB 可用空间

支持的平台

  • ✅ Linux (Ubuntu 18.04+, CentOS 7+)
  • ✅ macOS (10.14+)
  • ✅ Windows (10+)

故障排除

如果遇到安装问题,请:

  1. 检查 Python 版本:python --version
  2. 更新 pip:pip install --upgrade pip
  3. 使用虚拟环境:

    python -m venv ai_arch_env
    source ai_arch_env/bin/activate  # Linux/macOS
    # 或
    ai_arch_env\Scripts\activate     # Windows
    
    1. 尝试最小化安装:pip install -r requirements-minimal.txt