CI/CD for Machine Learning

使用工作流建立持续集成和交付管道，以可靠地迭代应用程序。 # intuition 持续集成 (CI) 允许团队以结构化的方式开发、测试和集成代码。这使团队可以更加自信和频繁地开发，因为他们的工作将被正确集成。持续交付 (CD) 将集成代码交付给依赖它的各种应用程序。借助 CI/CD 管道，可以开发和部署，因为知道系统可以快速适应并按预期工作。 ## GitHub 操作 在本课中，将使用[GitHub Actions](https://docs.github.com/en/actions)创建与推送到 git 的代码相关的 CI/CD。将在[编排课程](https://franztao.github.io/2022/11/10/Orchestration/)中了解有关 CI/CD 的更多信息，将更广泛地将其应用于 DataOps 和 MLOps。 GitHub Actions 具有与 GitHub 很好地集成的额外优势，并且由于所有的工作都在那里进行版本控制，可以轻松地基于 GitHub 事件（推送、PR、发布等）创建工作流。GitHub Actions 还拥有一个丰富的市场，其中包含可以用于自己的项目的工作流。而且，最重要的是，GitHub Actions[对公共存储库是免费的](https://docs.github.com/en/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions)。 ## 成分 将通过了解构成 Action 的组件来了解 GitHub Actions。这些组件遵循特定的[工作流语法](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions)，可以使用适当的[上下文和表达式语法](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions)进行扩展。 ![带有 github 操作的 ci/cd](https://upload-images.jianshu.io/upload_images/27840083-a3583a5243b0a7f1.png) ### 工作流程 使用 GitHub Actions，正在创建自动**工作流**来为做一些事情。将首先创建一个 .github/workflows 目录来组织所有的工作流。 ``` mkdir -p .github/workflows touch .github/workflows/testing.yml touch .github/workflows/documentation.yml ``` 每个工作流文件都将包含该操作的具体说明。例如，这个[测试工作流程](https://github.com/GokuMohandas/mlops-course/blob/main/.github/workflows/testing.yml)负责对代码库进行测试。可以在 YAML 文件的顶部指定工作流的名称。 ``` # .github/workflows/testing.yml name: testing ``` ### 活动 工作流由**事件**触发，事件可以是按计划 ( [cron](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html) )、webhook 或手动发生的事情。在应用程序中，当有人直接向主分支推送或提交 PR 时，将使用 [push](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#push) and [pull request](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request) 请求webhook 事件来运行测试工作流程。 ``` # .github/workflows/testing.yml on: push: branches: - main - master pull_request: branches: - main - master ``` > 请务必查看可以触发工作流的不同事件的[完整列表](https://docs.github.com/en/actions/reference/events-that-trigger-workflows)。 ### 工作 触发事件后，一组**作业**将在[**runner**](https://github.com/actions/runner)上运行，这是使用特定操作系统运行作业的应用程序。第一个（也是唯一一个）工作是`test-code`在最新版本的 ubuntu 上运行。 ``` # .github/workflows/testing.yml jobs: test-code: runs-on: ubuntu-latest ``` > 作业并行运行，但如果您需要创建从属作业，如果特定作业失败，则所有相关作业都将被跳过，那么请务必使用[需求](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds)键。一个类似的说明，还可以在工作之间[共享](https://docs.github.com/en/actions/learn-github-actions/essential-features-of-github-actions#sharing-data-between-jobs)数据。 ### Steps 每个作业都包含一系列按顺序执行的步骤。每个步骤都有一个名称，以及要从 GitHub Action 市场使用的操作或要运行的命令。对于这项`test-code`工作，步骤是checkout repo，安装必要的依赖项并运行测试。 ``` name: testing on: push: branches: - master - main pull_request: branches: - master - main jobs: test-code: runs-on: ubuntu-latest steps: - name: Checkout repo uses: actions/checkout@v2 - name: Set up Python uses: actions/setup-python@v2 with: python-version: 3.7.13 - name: Caching uses: actions/cache@v2 with: path: $/{/{ env.pythonLocation /}/} key: $/{/{ env.pythonLocation /}/}-$/{/{ hashFiles('setup.py') /}/}-$/{/{ hashFiles('requirements.txt') /}/} - name: Install dependencies run: | python -m pip install -e ".[test]" --no-cache-dir - name: Execute tests run: pytest tests/tagifai --ignore tests/tagifai/test_main.py --ignore tests/tagifai/test_data.py ``` 请注意，步骤之一是使用特定键[缓存](https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows)整个 Python 环境。只要密钥保持不变（相同的 python 位置、setup.py 和 requirements.txt），这将显着加快下一次运行 Action 所需的时间。 ![caching with github actions](https://upload-images.jianshu.io/upload_images/27840083-dac1bc8e62a03189.png) 其他工作流程负责自动生成和部署 mkdocs 文档。下面的“部署文档”步骤将在存储库中创建/更新一个名为[gh-pages](https://github.com/GokuMohandas/mlops-course/tree/gh-pages)的新分支，该分支将包含文档的生成 UI 文件。可以通过转到`Settings`>`Pages`并将源分支设置为`gh-pages`并将文件夹设置为`/root`>来将此分支部署为 GitHub 页面网站`Save`。这将为文档生成公共 URL，并在每次 PR 之后运行工作流时自动更新。 ``` # .github/workflows/documentation.yml name: documentation ... jobs: build-docs: ... - name: Deploy documentation run: mkdocs gh-deploy --force ``` > View `.github/workflows/documentation.yml` > > > name: documentation > > on: > > push: > > branches: > > - master > > - main > > pull_request: > > branches: > > - master > > - main > > jobs: > > build-docs: > > runs-on: ubuntu-latest > > steps: > > - name: Checkout repo > > uses: actions/checkout@v2 > > - name: Set up Python > > uses: actions/setup-python@v2 > > with: > > python-version: 3.7.13 > > - name: Caching > > uses: actions/cache@v2 > > with: > > path: $/{/{ env.pythonLocation /}/} > > key: $/{/{ env.pythonLocation /}/}-$/{/{ hashFiles('setup.py') /}/}-$/{/{ hashFiles('requirements.txt') /}/} > > - name: Install dependencies > > run: | > > python -m pip install -e ".[docs]" --no-cache-dir > > - name: Deploy documentation > > run: mkdocs gh-deploy --force 查看`.github/workflows/documentation.yml` ## 运行 回想一下，当某些事件发生时将触发工作流。例如，测试工作流程将在向主分支推送或 PR 时启动。可以在存储库页面的*Actions*选项卡上查看工作流的运行（当前和以前） 。如果单击特定的运行，还可以查看所有步骤及其输出。还可以设置分支保护规则（GitHub仓库页面>> `Settings`）`Branches`，保证这些工作流运行全部成功后，才能合并到主分支。 > 虽然有一些方法，例如[act](https://github.com/nektos/act)，可以在本地运行和测试工作流，但其中许多方法不够稳定，无法可靠使用。 ## 服务 在所有集成测试通过后，有各种各样的 GitHub 操作可用于部署和服务 ML 应用程序。它们中的大多数将要求定义一个 Dockerfile，该文件将使用适当的工件加载和启动服务。在[系统设计课程](https://franztao.github.io/2022/10/27/Systems_design/)中阅读有关所需基础设施的更多信息。 - [AWS EC2](https://github.com/aws-actions)、[谷歌计算引擎](https://github.com/google-github-actions)、[Azure VM](https://github.com/Azure/actions)等。 - 容器编排服务，例如[AWS ECS](https://github.com/aws-actions/amazon-ecs-deploy-task-definition)或[Google Kubernetes Engine](https://github.com/google-github-actions/setup-gcloud/tree/master/example-workflows/gke) - 无服务器选项，例如[AWS Lambda](https://github.com/marketplace/actions/aws-lambda-deploy)或[Google Cloud Functions](https://github.com/google-github-actions/deploy-cloud-functions)。 > 如果想一次部署和服务多个模型，强烈建议使用专门构建的[模型服务器](https://franztao.github.io/2022/10/01/RESTful_API/#model-server)来无缝检查、更新、服务、回滚等多个版本的模型。 使用它的具体部署方法完全取决于应用程序、团队、现有基础设施等。关键组件是能够在所有集成测试通过时更新应用程序，而无需手动干预部署。 > note > > 将在[编排课程](https://franztao.github.io/2022/11/10/Orchestration/)中学习如何分离开发和服务。仍然可以利用 CI/CD 工作流程将代码推送到 Git，但是单独的工作流程可以使用经过验证的代码库来执行下游工作流程（评估、服务、再培训等）。 ## 市场 那么从市场上使用的这些操作到底是什么？例如，在上述工作中的第一步`test-code`是使用[actions/ checkout@v2](https://github.com/marketplace/actions/checkout) GitHub Action checkout repo。Action 的链接包含有关如何使用它、场景等的信息。 Marketplace 具有满足各种需求的操作，包括针对各种云提供商的持续部署、代码质量检查等。 - [Great Expectations](https://github.com/marketplace/actions/great-expectations-data)：确保 GE 检查点在发生任何可能影响数据工程管道的更改时通过。此操作还使用[Netlify](https://www.netlify.com/)创建了一个免费的 GE 仪表板，其中包含更新的数据文档。 - [持续 ML](https://github.com/iterative/cml)：训练、评估和监控您的 ML 模型并生成总结工作流程的报告。如果您不想离线训练，您可以手动/自动触发训练管道以在云基础设施 (AWS/GCP) 或[自托管](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners?learn=hosting_your_own_runners)运行器上运行。 > 不要将您的工作流程限制在 Marketplace 上可用的内容或单个命令操作上。可以做一些事情，比如包含代码覆盖率报告、部署更新的 Streamlit 仪表板并将其 URL 附加到 PR、将应用程序交付 (CD) 到 AWS Lambda / EC2 等。 更多干货，第一时间更新在以下微信公众号： ![](https://raw.githubusercontent.com/franztao/blog_picture/main/marktext/2022-12-03-12-49-27-weixin.png) 您的一点点支持，是我后续更多的创造和贡献 ![](https://upload-images.jianshu.io/upload_images/27840083-5a6a127e5338a4cd.png) 转载到请包括本文地址 更详细的转载事宜请参考[文章如何转载/引用](https://franztao.github.io/2022/12/04/%E6%96%87%E7%AB%A0%E5%A6%82%E4%BD%95%E8%BD%AC%E8%BD%BD%E5%92%8C%E5%BC%95%E7%94%A8/) 本文主体源自以下链接： ``` @article{madewithml, author = {Goku Mohandas}, title = { Made With ML }, howpublished = {\url{https://madewithml.com/}}, year = {2022} } ``` 本文由[mdnice](https://mdnice.com/?platform=6)多平台发布
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 206,602评论 6赞 481
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 88,442评论 2赞 382
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 152,878评论 0赞 344
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 55,306评论 1赞 279
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 64,330评论 5赞 373
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,071评论 1赞 285
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,382评论 3赞 400
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,006评论 0赞 259
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 43,512评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,965评论 2赞 325
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,094评论 1赞 333
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,732评论 4赞 323
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,283评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,286评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,512评论 1赞 262
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,536评论 2赞 354
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,828评论 2赞 345

推荐阅读更多精彩内容