什么是CML? - 是什么? - 是什么? - What is CML? 连续机器学习(CML)是一个开源 CLI 工具 执行连续一体化和交付(CI/CD),重点是 (原始内容存档于2018-09-29). MLOPS. 用于自动化开发工作流程——包括机器 提供、示范培训和评价,比较跨行业的ML实验 项目历史,以及监测不断变化的数据集.

CML 可以帮助训练和评价模型——然后生成一个可视化报告,其中 结果和衡量标准——在每次拉出请求时自动.

一个 示例报告 神经风格传输模式。 。 。 .

CML 原则 :

• 吉特风 数据 科学. 使用 GitLab 或 GitHub 来管理 ML 实验, 跟踪培训 ML 的操作者 模型或修改后的数据和时间。 将数据和模型编码为 家庭暴力中心 而不是推动一个Git Repo.
• 用于ML实验的自动报告. 带有计量标准的自动生成报告 每个 Git 拖放请求中的地块 。 严格的工程实践帮助你的团队 作出知情、由数据驱动的决定.
• 没有额外服务. 使用 GitLab 建立自己的 ML 平台, Bitbucket,或叫"GitHub". 可选使用 云存储 以及两个 自行托管或云跑道(如AWS EC2或Azure). 没有数据库, 需要服务或复杂的设置.

问:需要帮助吗? 只想谈谈ML的连续整合? 访问我们的Discord频道!

: play or 暂停 按钮:检查我们的 YouTube视频系列 使用 CML 操作的 MLOPs 教程 !

目录

1. 设置( GitLab, GitHub, Bitbucket) Name
2. 使用量
3. 正在启动( 教程)
4. 使用 DVC 的 CML
5. 高级设置( 自动托管, 本地软件包)
6. 实例项目

设置

你需要一个GitLab,GitHub,或者Bitbucket账户开始. 用户可能希望 熟悉情况 Github 动作 或者说 GitLab CI/光盘。 。 。 . 在这里,将讨论GitHub的使用案例.

吉特拉布语Name

请看文件 带 GitLab CI/CD 的 CML 特别是 个人访问令牌 页:1.

键盘

请看文件 带 Bitbucket 云的 CML。 。 。 .

GitHub 图像

任何 CML 项目中的密钥文件是 .github/workflows/cml.yaml数字 :

name: your-workflow-name
on: [push]
jobs:
  run:
    runs-on: ubuntu-latest
    # optionally use a convenient Ubuntu LTS + DVC + CML image
    # container: ghcr.io/iterative/cml:0-dvc2-base1
    steps:
      - uses: actions/checkout@v3
      # may need to setup NodeJS & Python3 on e.g. self-hosted
      # - uses: actions/setup-node@v3
      #   with:
      #     node-version: '16'
      # - uses: actions/setup-python@v4
      #   with:
      #     python-version: '3.x'
      - uses: iterative/setup-cml@v1
      - name: Train model
        run: |
          # Your ML workflow goes here
          pip install -r requirements.txt
          python train.py
      - name: Write CML report
        env:
          REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          # Post reports as comments in GitHub PRs
          cat results.txt >> report.md
          cml comment create report.md

使用量

我们帮助提供了 CML 和其他有用的图书馆 预先安装在我们的 自定义嵌入图像。 。 。 . 在上述例子中,没有评论的领域 container: ghcr.io/iterative/cml:0-dvc2-base1会让跑者拉出 CML Docker 图像 。 该图像已经设置了节点JS、 Python 3、 DVC 和 CML 方便使用 Ubuntu LTS 基础.

CML 函数

CML 提供一些功能来帮助包装 ML 工作流程的产出 (包括数字数据和关于模型性能的可视化) 报告.

以下是用于撰写下调报告和交付的 CML 函数表 报告给你的CI系统.

CML 报告

这个 cml comment create 命令可用于发布报告。 CML 报告为 以下标写( i)GitHub 图像, (中文(简体) ), 吉特拉布语Name,或 键盘 风味。 这意味着它们可以包含图像,表格,格式化的文本,HTML 块, 代码片段, 以及更多—— 实际上, 您在 CML 报告中给出的内容是 你吗? 一些例子:

: sspiral 注解: 文本 用你喜欢的方法写报告. 例如,复制包含 ML 模型结果的文本文件的内容 培训:

cat results.txt >> report.md

: 框架 图片 : 图像 使用下标或 HTML 显示图像。 请注意: 如果图像是您 ML 工作流程的输出( 即由您生成) 工作流程,可以上传并自动包含到您的CML报告. 对于 示例,如果 graph.png 输出为 python train.py,运行 :

echo "![](./graph.png)" >> report.md
cml comment create report.md

开始

1. 我们的叉子 实例项目存储器。 。 。 .

:警告:注意,如果你使用GitLab, 您需要创建个人访问托肯 这个例子可以发挥作用.

: warning: GitHub 浏览器界面中可以全部完成以下步骤. 但是,为了配合命令 我们建议克隆你的叉子 您的本地工作站:

git clone https://github.com/<your-username>/example_cml

2. 要创建 CML 工作流程, 请将以下内容复制到新文件 , .github/workflows/cml.yaml数字 :

name: model-training
on: [push]
jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
      - uses: iterative/setup-cml@v1
      - name: Train model
        env:
          REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          pip install -r requirements.txt
          python train.py

          cat metrics.txt >> report.md
          echo "![](./plot.png)" >> report.md
          cml comment create report.md

3. 在您选择的文本编辑器中,编辑 train.py 改为 depth = 5。 。 。 .

4. 提交并推进更改 :

git checkout -b experiment
git add . && git commit -m "modify forest depth"
git push origin experiment

5. 在 GitHub 中,打开拉动请求以比较 experiment 分支改为 main。 。 。 .

很快,你应该看到一个评论 从 github-actions 显示在拉出 请使用您的 CML 报告。 这是由于 cml send-comment 函数在工作流程中.

这是CML工作流程的大纲:

• 您将更改推向您的 GitHub 仓库,
• 您的工作流程中 .github/workflows/cml.yaml 文件会运行,以及
• 生成报告并张贴到 GitHub.

CML 函数允许您显示工作流程的相关结果, 如模型 性能测量和可视化——用GitHub的检查和评论. 什麽 您想要运行的工作流程, 并想要在您的 CML 报告中显示, 最多 你吗.

使用 DVC 的 CML

在许多ML项目中,数据不是存储在Git寄存器中,而是需要存储 从外部来源下载. 家庭暴力中心 是一种常见的方法 将数据带入您的 CML 运行程序 。 DVC 也允许您直观地看到测量值的不同 承诺做这样的报告:

这个 .github/workflows/cml.yaml 用于创建此报表的文件是 :

name: model-training
on: [push]
jobs:
  run:
    runs-on: ubuntu-latest
    container: ghcr.io/iterative/cml:0-dvc2-base1
    steps:
      - uses: actions/checkout@v3
      - name: Train model
        env:
          REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        run: |
          # Install requirements
          pip install -r requirements.txt

          # Pull data & run-cache from S3 and reproduce pipeline
          dvc pull data --run-cache
          dvc repro

          # Report metrics
          echo "## Metrics" >> report.md
          git fetch --prune
          dvc metrics diff main --show-md >> report.md

          # Publish confusion matrix diff
          echo "## Plots" >> report.md
          echo "### Class confusions" >> report.md
          dvc plots diff --target classes.csv --template confusion -x actual -y predicted --show-vega main > vega.json
          vl2png vega.json -s 1.5 > confusion_plot.png
          echo "![](./confusion_plot.png)" >> report.md

          # Publish regularization function diff
          echo "### Effects of regularization" >> report.md
          dvc plots diff --target estimators.csv -x Regularization --show-vega main > vega.json
          vl2png vega.json -s 1.5 > plot.png
          echo "![](./plot.png)" >> report.md

          cml comment create report.md

:警告:如果使用有云存储的DVC,请注意环境 变量.

配置云存储提供者

还有很多 支持的存储提供者。 。 。 . 以下是一些最常用供应商的几个例子:

# Github
env:
  AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
  AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
  AWS_SESSION_TOKEN: ${{ secrets.AWS_SESSION_TOKEN }}

env:
  AZURE_STORAGE_CONNECTION_STRING:
    ${{ secrets.AZURE_STORAGE_CONNECTION_STRING }}
  AZURE_STORAGE_CONTAINER_NAME: ${{ secrets.AZURE_STORAGE_CONTAINER_NAME }}

env:
  OSS_BUCKET: ${{ secrets.OSS_BUCKET }}
  OSS_ACCESS_KEY_ID: ${{ secrets.OSS_ACCESS_KEY_ID }}
  OSS_ACCESS_KEY_SECRET: ${{ secrets.OSS_ACCESS_KEY_SECRET }}
  OSS_ENDPOINT: ${{ secrets.OSS_ENDPOINT }}

env:
  GOOGLE_APPLICATION_CREDENTIALS: ${{ secrets.GOOGLE_APPLICATION_CREDENTIALS }}

env:
  GDRIVE_CREDENTIALS_DATA: ${{ secrets.GDRIVE_CREDENTIALS_DATA }}

高级设置

自行主持(现场或云)

GitHub Actions默认运行在由GitHub托管的跑者上. 然而,还有 利用GPU, 或者在云中训练.

: 点起: 小费! 看看这个 官方 GitHub 文档 开始安排自己的跑道.

用 CML 分配云计算资源

当工作流程需要计算资源(例如GPU)时,CML可以 使用 cml runner你可以旋转起来 aWS、Azure、GCP或Kubernetes上的例子.

例如,以下工作流程部署a g4dn.xlarge 实例在 AWS EC2 并训练一个样板 工作完成后,这个案例 自动关闭.

你可能注意到,这个工作流程与 基本使用大小写 见上文。 唯一的补充是 cml runner 还有几个 将您的云服务证书传递到 工作流程.

请注意: cml runner 将自动重新启动您的工作( 无论来自 GitHub 动作35天工作流程超时 或一个 AWS EC2 点实例中断) (中文(简体) ).

name: Train-in-the-cloud
on: [push]
jobs:
  deploy-runner:
    runs-on: ubuntu-latest
    steps:
      - uses: iterative/setup-cml@v1
      - uses: actions/checkout@v3
      - name: Deploy runner on EC2
        env:
          REPO_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        run: |
          cml runner launch \
            --cloud=aws \
            --cloud-region=us-west \
            --cloud-type=g4dn.xlarge \
            --labels=cml-gpu
  train-model:
    needs: deploy-runner
    runs-on: [self-hosted, cml-gpu]
    timeout-minutes: 50400 # 35 days
    container:
      image: ghcr.io/iterative/cml:0-dvc2-base1-gpu
      options: --gpus all
    steps:
      - uses: actions/checkout@v3
      - name: Train model
        env:
          REPO_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
        run: |
          pip install -r requirements.txt
          python train.py

          cat metrics.txt > report.md
          cml comment create report.md

在上述工作流程中 deploy-runner 级发射 EC2 g4dn.xlarge 实例 us-west 区域。 这个 model-training 步骤然后运行在 新启动的案例。 [环境变量] secrets 所需经费.

: 塔达: 注意,工作可以使用任何多克容器! 使用这样的函数 作为 cml send-comment 从工作,唯一的要求是 已安装 CML。 。 。 .

Docker 图像

CML Docker 图像 (ghcr.io/iterative/cml 或者说 iterativeai/cml已装入 与皮森,库达, git, (中文(简体) ), node 以及完整数据的其他基本内容 科学。 不同版本的这些基本内容可从不同来源获得 图像标记。 标签公约是 {CML_VER}-dvc{DVC_VER}-base{BASE_VER}{-gpu}数字 :

譬如说, iterativeai/cml:0-dvc2-base1-gpu,或 ghcr.io/iterative/cml:0-dvc2-base1。 。 。 .

参数

这个 cml runner launch 函数接受以下参数:

  --labels                                  One or more user-defined labels for
                                            this runner (delimited with commas)
                                                       [string] [default: "cml"]
  --idle-timeout                            Time to wait for jobs before
                                            shutting down (e.g. "5min"). Use
                                            "never" to disable
                                                 [string] [default: "5 minutes"]
  --name                                    Name displayed in the repository
                                            once registered
                                                    [string] [default: cml-{ID}]
  --no-retry                                Do not restart workflow terminated
                                            due to instance disposal or GitHub
                                            Actions timeout            [boolean]
  --single                                  Exit after running a single job
                                                                       [boolean]
  --reuse                                   Don't launch a new runner if an
                                            existing one has the same name or
                                            overlapping labels         [boolean]
  --reuse-idle                              Creates a new runner only if the
                                            matching labels don't exist or are
                                            already busy               [boolean]
  --docker-volumes                          Docker volumes, only supported in
                                            GitLab         [array] [default: []]
  --cloud                                   Cloud to deploy the runner
                         [string] [choices: "aws", "azure", "gcp", "kubernetes"]
  --cloud-region                            Region where the instance is
                                            deployed. Choices: [us-east,
                                            us-west, eu-west, eu-north]. Also
                                            accepts native cloud regions
                                                   [string] [default: "us-west"]
  --cloud-type                              Instance type. Choices: [m, l, xl].
                                            Also supports native types like i.e.
                                            t2.micro                    [string]
  --cloud-permission-set                    Specifies the instance profile in
                                            AWS or instance service account in
                                            GCP           [string] [default: ""]
  --cloud-metadata                          Key Value pairs to associate
                                            cml-runner instance on the provider
                                            i.e. tags/labels "key=value"
                                                           [array] [default: []]
  --cloud-gpu                               GPU type. Choices: k80, v100, or
                                            native types e.g. nvidia-tesla-t4
                                                                        [string]
  --cloud-hdd-size                          HDD size in GB              [number]
  --cloud-ssh-private                       Custom private RSA SSH key. If not
                                            provided an automatically generated
                                            throwaway key will be used  [string]
  --cloud-spot                              Request a spot instance    [boolean]
  --cloud-spot-price                        Maximum spot instance bidding price
                                            in USD. Defaults to the current spot
                                            bidding price [number] [default: -1]
  --cloud-startup-script                    Run the provided Base64-encoded
                                            Linux shell script during the
                                            instance initialization     [string]
  --cloud-aws-security-group                Specifies the security group in AWS
                                                          [string] [default: ""]
  --cloud-aws-subnet,                       Specifies the subnet to use within
  --cloud-aws-subnet-id                     AWS           [string] [default: ""]

环境变量

:警告:您需要 创建个人访问符 (PAT) 包含寄存器读取/写入访问权限和工作流程权限。 实例 工作流程,此令牌被存储为 PERSONAL_ACCESS_TOKEN。 。 。 .

: 信息 来源:如果使用 --cloud 选项,您还需要 提供您云计算资源的秘密访问证书。 在那个 例如, AWS_ACCESS_KEY_ID 财务报告和审定财务报表 AWS_SECRET_ACCESS_KEY (有特权) 以创建并销毁 EC2 实例.

对AWS来说,同样的证书也可以用于: 配置云存储。 。 。 .

代理支持

通过已知环境变量的 CML 支持代理 http_proxy 财务报告和审定财务报表 https_proxy。 。 。 .

现场( 当地) 运行者

这意味着使用室内机器作为自备跑手。 这个 cml runner launch 函数用于设置本地自动托管的跑车。 在一个 本地机器或原地GPU集群, 将 CML 作为软件包安装 然后运行 :

cml runner launch \
  --repo=$your_project_repository_url \
  --token=$PERSONAL_ACCESS_TOKEN \
  --labels="local,runner" \
  --idle-timeout=180

机器会从您的项目仓库中收听工作流程 .

本地软件包

在以上示例中,CML由 setup-cml 动作,或来 预安装在自定义 Docker 图像中 。 你也可以这样 作为软件包安装 CML :

npm install --location=global @dvcorg/cml

你用得着 cml 不通过下载正确的独立二进制的节点 您的系统从资产部分 释放。 。 。 .

您可能需要安装额外的依赖关系来使用 DVC 地块和 Vega- Lite CLI 命令 :

sudo apt-get install -y libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev \
                        librsvg2-dev libfontconfig-dev
npm install -g vega-cli vega-lite

CML 和 Vega- Lite 软件包安装需要节点JS 软件包管理器 (单位:千美元)npm)与NodeJS同船. 安装指令如下.

安装节点JS

• GitHub 图像: 当使用 GitHub 默认值时, 可能没有必要 容器或CML的一个多克容器。 自营的跑者可能需要 使用设置动作安装节点JS:

uses: actions/setup-node@v3
  with:
    node-version: '16'

• 吉特拉布语Name:需要直接安装.

curl -sL https://deb.nodesource.com/setup_16.x | bash
apt-get update
apt-get install -y nodejs

另见

这些是使用CML的一些实例项目.

• 基本CML项目
• 用 DVC 调取数据的 CML
• 带有 Tensor 板的 CML
• 带小EC2实例的CML 键 :
• 带 EC2 GPU 的 CML 键 :

键:需要 PAT 计划。 。 。 .

: 警告: 维护: 警告:

• ~2023-07 Nvidia 已投放容器 CUDA 图像,带有 10.x 电话编号 :cudnn7 (中文(简体) ) 财务报告和审定财务报表 11.2.1 国家, (中文(简体) ), CML 图像将加速更新