iterativeai/cml

Continuous Machine Learning (CML) 镜像文档

镜像概述

Continuous Machine Learning (CML) 是专为机器学习工作流设计的持续集成/持续部署（CI/CD）工具，致力于将软件工程中的CI/CD方法论与最佳实践引入机器学习领域。通过自动化模型训练、实验跟踪、结果报告生成及模型部署等关键流程，CML帮助数据科学家与ML工程师提升团队协作效率，保障ML工作流的可复现性与可追溯性。

核心功能与特性

• CI/CD平台集成：无缝对接GitHub Actions、GitLab CI等主流CI/CD工具，支持在ML工作流中嵌入自动化任务（如触发训练、生成报告）。
• 实验跟踪与报告：自动生成包含模型性能指标、训练日志、可视化图表的结构化实验报告，并与Git仓库深度关联，便于追踪实验历史与版本对比。
• 数据与模型版本协同：与Git及Data Version Control（DVC）集成，实现代码、数据、模型版本的统一管理，解决ML工作流中"版本碎片化"问题。
• 跨环境一致性：支持Docker容器化部署，确保开发、测试、生产环境的配置一致性，降低"环境依赖导致的实验不可复现"风险。

使用场景与适用范围

• 数据科学团队协作：统一团队ML实验记录规范，支持多人协作时的实验结果共享与评审。
• 自动化模型训练：基于代码或数据变更自动触发模型训练流程，减少人工干预，加速迭代效率。
• ML项目可复现性保障：通过记录每次实验的环境配置、参数设置与输出结果，确保实验可追溯、可复现。
• 模型部署流程简化：衔接模型训练与生产部署环节，支持模型版本控制、部署验证与回滚机制。

使用方法与配置说明

基本部署方式

CML提供Docker镜像供快速部署，可通过以下命令启动基础容器（具体版本标签可参考https://github.com/iterative/cml%EF%BC%89%EF%BC%9A

bash
docker run -it --rm iterative/cml:latest

环境变量配置

运行CML容器时，可通过环境变量定制行为，核心变量包括：

• GITHUB_TOKEN：GitHub仓库访问令牌（用于提交报告至仓库，需具备仓库写入权限）。
• CML_REPOSITORY：目标Git仓库URL（如https://github.com/[用户名]/[仓库名].git），指定报告存储位置。
• CML_BRANCH：用于提交实验报告的Git分支名称（默认使用当前分支）。
• CML_COMMIT_MESSAGE：提交报告时的Git commit信息（默认生成标准化描述）。

典型工作流示例（GitHub Actions）

1. 配置CI文件：在Git仓库中创建.github/workflows/cml.yml，定义触发条件与执行步骤：

   yaml
   name: CML Workflow
   on: [push]
   jobs:
     train-model:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v4
         - uses: iterative/setup-cml@v2
         - name: Train model & generate report
           run: |
             # 安装依赖、训练模型（示例命令）
             pip install -r requirements.txt
             python train.py --epochs 10
             
             # 生成CML报告
             cml report create results.md --title "Model Training Report"
   

2. 执行与查看结果：推送代码后，CI流程自动触发，训练完成后CML将生成报告并提交至指定Git分支或PR评论区，可通过GitHub界面直接查看实验结果。

更多资源

• 官方源码仓库：https://github.com/iterative/cml
• 详细文档：[***]
• npm包信息：[***]