MLRun 项目快速入门教程
mlrunMachine Learning automation and tracking项目地址:https://gitcode.com/gh_mirrors/ml/mlrun
1. 项目目录结构及介绍
主要目录结构
MLRun 的源代码仓库包含了多个关键目录,以下是主要的目录结构:
-
docs
: 包含项目文档,由 Sphinx 和 Markdown 文件组成。 -
examples
: 提供了多个示例项目和用法说明。 -
mlrun
: 项目的核心模块,包含各种函数、类和接口。artifacts
: 用于处理模型和数据等ML资产。dbartifacts
: 与数据库中的MLRun Artifacts交互。functions
: 包含预定义的任务和工作流函数。models
: 管理机器学习模型。platforms
: 支持不同平台和计算后端(如 Kubernetes)的抽象层。tests
: 单元测试和集成测试。
-
.github
: 包含GitHub操作的相关配置文件,如工作流定义。 -
setup.py
: 项目安装脚本。
目录功能简介
setup.py
是Python项目的初始化文件,用于描述项目并进行安装。docs/source
存放文档的源码,可以使用Sphinx工具构建成HTML文档。examples/*
提供实际使用场景,有助于理解如何在你的环境中应用MLRun。
2. 项目的启动文件介绍
MLRun 并没有一个典型的“启动文件”,因为它作为一个库被导入到其他Python项目中使用。你通常会在你的项目里通过导入 mlrun
模块来启动使用,例如:
from mlrun import load_function, run
fn = load_function('my_ml_function')
result = fn.run()
上面的示例展示了如何加载一个预先定义的 MLRun 函数并执行它。
如果你想要运行 MLRun 的某个具体示例,可以查看 examples
目录下的脚本,它们通常包含了如何启动和执行ML任务的完整流程。
3. 项目的配置文件介绍
MLRun 使用环境变量或配置文件来设置参数。默认情况下,它会查找 $HOME/.mlrun/config.yaml
或者当前工作目录下的 config.yaml
文件。
配置文件结构
一个基本的配置文件可能如下所示:
url: http://localhost:8080 # 运行时服务器URL
artifact_path: ./artifacts # 存储Artifacts的路径
database: mlruns # 数据库存储的名字
mode: local # 运行模式,例如local、k8s
default_image: mlrun/mlrun # Docker镜像,用于执行函数和任务
设置配置
你可以通过以下方式之一设置这些配置:
- 编辑
config.yaml
并添加适当的值。 - 在命令行中使用环境变量,比如
export MLRUN_URL=http://localhost:8080
。 - 在代码中通过
mlrun.set_config
方法设置,如mlrun.set_config('url', 'http://localhost:8080')
。
注意:当同时存在配置文件和环境变量时,环境变量优先级更高。
通过以上内容,你应该有了对 MLRun 项目的基本了解。在实际使用中,参考项目文档和示例,将帮助你更深入地掌握其功能和用法。祝你在探索 MLRun 的过程中一切顺利!
mlrunMachine Learning automation and tracking项目地址:https://gitcode.com/gh_mirrors/ml/mlrun