Memslides

环境要求

• Linux 环境（README 使用 apt-get 安装系统依赖，需 sudo 权限）
• 已安装 Conda（用于 conda env create 创建环境）
• Python 环境由仓库内的 environment.yml 定义
• 需自备模型与服务凭证（通过环境变量、.env 或私有 YAML 提供）
• Docker 方式需已安装 Docker 与 docker compose

安装与启动步骤

1. 1安装系统依赖

   安装 LibreOffice、字体、CJK 字体与 poppler 工具，供幻灯片渲染与转换使用；仅适用于 Debian/Ubuntu 系。

   sudo apt-get update
   sudo apt-get install -y libreoffice fontconfig fonts-noto-cjk poppler-utils

   复制

2. 2创建 Conda 环境

   在仓库根目录根据 environment.yml 创建名为 memslides 的环境，需先克隆仓库并进入目录。

   conda env create -f environment.yml

   复制

3. 3激活并安装项目

   激活环境后以可编辑模式安装项目，并附带 research 可选依赖组。

   conda activate memslides
   pip install -e ".[research]"

   复制

4. 4安装浏览器依赖

   安装 Playwright 的 chromium 浏览器与 ffmpeg，供生成流程调用。

   python -m playwright install chromium ffmpeg

   复制

5. 5查看命令帮助

   确认包已正确安装，并查看 experiment 子命令支持的参数。

   python -m memslides.experiment --help

   复制

6. 6配置凭证

   把模型与服务凭证放在环境变量、.env 或私有 YAML 中，用 MEMSLIDES_CONFIG_FILE 指向私有配置文件。

   export MEMSLIDES_CONFIG_FILE=/your/path/private.yaml

   复制

7. 7运行冒烟测试

   运行内置的 smoke_minimal 小型验证套件，输出写入指定目录，并行度设为 1。

   python -m memslides.experiment run smoke_minimal 
     --output-base .memslides/experiments 
     --parallel 1

   复制

8. 8Docker 方式运行

   先用 compose 构建镜像，再在容器中执行同一套 smoke_minimal 验证。

   docker compose build
   docker compose run --rm memslides python -m memslides.experiment run smoke_minimal 
     --output-base /app/.cache/memslides/experiments 
     --parallel 1

   复制

关键配置

如何确认成功

python -m memslides.experiment --help 能正常输出帮助信息；运行 smoke_minimal 无报错并在输出目录生成结果。

常见问题

注意事项

• 生成的输出、缓存、私有 YAML 文件与凭证都不应提交到仓库。
• 真实生成实验必须自行提供模型和服务凭证。
• Docker 按 Docker Hub 上的 huohua325/memslides 镜像与本地 docker compose 配置使用。
• apt 安装步骤针对 Debian/Ubuntu，其它发行版需自行等价替换。