命令行界面
MLflow 命令行界面 (CLI) 提供了一个简单的界面来访问 MLflow 的各种功能。您可以使用 CLI 来运行项目、启动跟踪 UI、创建和列出实验、下载运行产物、为 MLflow Python 函数和 scikit-learn 模型提供服务,以及在 Microsoft Azure Machine Learning 和 Amazon SageMaker 上部署模型。
每个单独的命令都有一个详细的帮助屏幕,可以通过 mlflow command_name --help 访问。
注意
建议默认设置 MLFLOW_TRACKING_URI 环境变量,因为 CLI 不会自动连接到跟踪服务器。如果不设置,CLI 将默认使用命令执行所在的本地文件系统,而不是连接到 localhost 或远程 HTTP 服务器。对于下方的大多数命令,必须将 MLFLOW_TRACKING_URI 设置为您所需的跟踪服务器的 URL。
目录
mlflow
用法
mlflow [OPTIONS] COMMAND [ARGS]...
选项
artifacts
从 MLflow 产物存储库上传、列出和下载产物。
要管理与跟踪服务器关联的运行的产物,请将 MLFLOW_TRACKING_URI 环境变量设置为所需服务器的 URL。
用法
mlflow artifacts [OPTIONS] COMMAND [ARGS]...
download
将产物文件或目录下载到本地目录。输出是本地文件系统上的文件或目录名称。
必须提供 --artifact-uri 或 --run-id。
用法
mlflow artifacts download [OPTIONS]
选项
assistant
MLflow 助手 - AI 驱动的跟踪分析。
运行 ‘mlflow assistant –configure’ 来设置助手。
用法
mlflow assistant [OPTIONS]
选项
autolog
用于 MLflow 自动记录的命令。
用法
mlflow autolog [OPTIONS] COMMAND [ARGS]...
claude
在目录中设置 Claude Code 跟踪。
此命令将 MLflow Claude 插件安装到 Claude Code 中,并将 MLflow 配置写入 .claude/settings.json。设置完成后,使用常规的 claude 命令,插件运行时将创建跟踪。
示例
# 在具有本地存储的当前目录中设置跟踪 mlflow autolog claude
# 在特定项目目录中设置跟踪 mlflow autolog claude -d ~/my-project
# 使用 Databricks 设置跟踪 mlflow autolog claude -u databricks -e 123456789
# 使用自定义跟踪 URI 设置跟踪 mlflow autolog claude -u file://./custom-mlruns
# 在当前目录中禁用跟踪 mlflow autolog claude –disable
用法
mlflow autolog claude [OPTIONS] COMMAND [ARGS]...
选项
- -u, --tracking-uri <tracking_uri>
MLflow 跟踪 URI(例如,‘databricks’ 或 ‘file://mlruns’)
crypto
用于管理 MLflow 加密密码的命令。
用法
mlflow crypto [OPTIONS] COMMAND [ARGS]...
rotate-kek
轮换用于加密和解密的 KEK 密码。
用法
mlflow crypto rotate-kek [OPTIONS]
选项
环境变量
- MLFLOW_BACKEND_STORE_URI
提供
--backend-store-uri的默认值
datasets
管理 GenAI 评估数据集。
用法
mlflow datasets [OPTIONS] COMMAND [ARGS]...
list
列出与实验关联的 GenAI 评估数据集。
用法
mlflow datasets list [OPTIONS]
选项
环境变量
- MLFLOW_EXPERIMENT_ID
提供
--experiment-id的默认值
db
用于管理 MLflow 跟踪数据库的命令。
用法
mlflow db [OPTIONS] COMMAND [ARGS]...
migrate-to-default-workspace
将工作区范围的资源移动到默认工作区。
重要:此操作在单个事务中运行,但仍然可能需要较长时间。在运行此命令之前,请务必备份您的数据库。
用法
mlflow db migrate-to-default-workspace [OPTIONS] URL
选项
参数
move-resources
将资源从一个工作区移动到另一个工作区。
通过名称或标签过滤器(互斥)有选择地在工作区之间移动工作区范围的资源。如果既未指定 –name 也未指定 –tag,则会移动源工作区中给定类型的所有资源。
–resource-type 值是数据库表名(例如 experiments, registered_models, evaluation_datasets, webhooks, jobs)。
标签过滤(–tag)仅支持 experiments 和 registered_models。当给出多个 –tag 标志时,仅包含匹配 ALL 标签的资源(AND 逻辑)。
重要:在运行此命令之前,请务必备份您的数据库。
用法
mlflow db move-resources [OPTIONS] URL
选项
参数
upgrade
将 MLflow 跟踪数据库的架构升级到最新支持的版本。
重要:架构迁移可能很慢,并且不能保证是事务性的 - 在运行迁移之前,请务必备份您的数据库。位于 https://github.com/mlflow/mlflow/blob/master/mlflow/store/db_migrations/README.md 的迁移 README 描述了大型迁移,并包含有关如何评估其性能以及如何从故障中恢复的信息。
用法
mlflow db upgrade [OPTIONS] URL
参数
demo
启动带有预填充演示数据的 MLflow,用于探索 GenAI 功能。
默认情况下,在 ./mlflow-demo/ 中创建一个持久环境,包含 SQLite 数据库和基于文件的产物,生成演示数据,并将浏览器打开到演示实验。数据在重启后保持不变;使用 –refresh 重新生成。
要使用演示数据填充现有的 MLflow 服务器,请使用 –tracking-uri
mlflow demo # 启动新的演示服务器 mlflow demo –no-browser # 在不打开浏览器的情况下启动 mlflow demo –port 5001 # 使用自定义端口 mlflow demo –tracking-uri https://:5000 # 使用现有服务器
用法
mlflow demo [OPTIONS]
选项
deployments
将 MLflow 模型部署到自定义目标。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
查看所有支持的部署目标和安装说明:https://mlflow.org.cn/docs/latest/plugins.html#community-plugins
您还可以编写自己的插件以部署到自定义目标。有关编写和分发插件的说明,请参阅 https://mlflow.org.cn/docs/latest/plugins.html#writing-your-own-mlflow-plugins。
用法
mlflow deployments [OPTIONS] COMMAND [ARGS]...
create
将 model_uri 处的模型部署到指定目标。
额外的插件特定参数也可以通过 -C key=value 传递给此命令
用法
mlflow deployments create [OPTIONS]
选项
- -t, --target <target>
必需 部署目标 URI。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
在 https://mlflow.org.cn/docs/latest/plugins.html#community-plugins 查看所有支持的部署目标和安装说明
create-endpoint
在指定目标处创建具有指定名称的端点。
额外的插件特定参数也可以通过 -C key=value 传递给此命令
用法
mlflow deployments create-endpoint [OPTIONS]
选项
- -t, --target <target>
必需 部署目标 URI。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
在 https://mlflow.org.cn/docs/latest/plugins.html#community-plugins 查看所有支持的部署目标和安装说明
delete
从指定目标删除 –name 给定名称的部署。
用法
mlflow deployments delete [OPTIONS]
选项
- -t, --target <target>
必需 部署目标 URI。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
在 https://mlflow.org.cn/docs/latest/plugins.html#community-plugins 查看所有支持的部署目标和安装说明
delete-endpoint
删除指定目标处的指定端点
用法
mlflow deployments delete-endpoint [OPTIONS]
选项
- -t, --target <target>
必需 部署目标 URI。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
在 https://mlflow.org.cn/docs/latest/plugins.html#community-plugins 查看所有支持的部署目标和安装说明
explain
为给定的输入生成已部署模型对模型预测的解释。解释输出格式因部署目标而异,可能包含用于理解/调试预测的特征重要性等详细信息。运行 mlflow deployments help 或咨询您的插件文档以了解有关解释格式的详细信息。有关此功能接受的输入数据格式的信息,请参阅以下文档:https://www.mlflow.org/docs/latest/models.html#built-in-deployment-tools
用法
mlflow deployments explain [OPTIONS]
选项
- -t, --target <target>
必需 部署目标 URI。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
在 https://mlflow.org.cn/docs/latest/plugins.html#community-plugins 查看所有支持的部署目标和安装说明
get
打印指定目标中 --name 给定名称的部署的详细描述。
用法
mlflow deployments get [OPTIONS]
选项
- -t, --target <target>
必需 部署目标 URI。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
在 https://mlflow.org.cn/docs/latest/plugins.html#community-plugins 查看所有支持的部署目标和安装说明
get-endpoint
获取指定目标中指定端点的详细信息
用法
mlflow deployments get-endpoint [OPTIONS]
选项
- -t, --target <target>
必需 部署目标 URI。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
在 https://mlflow.org.cn/docs/latest/plugins.html#community-plugins 查看所有支持的部署目标和安装说明
help
显示特定部署目标的额外帮助,例如关于目标特定配置选项和目标 URI 格式的信息。
用法
mlflow deployments help [OPTIONS]
选项
- -t, --target <target>
必需 部署目标 URI。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
在 https://mlflow.org.cn/docs/latest/plugins.html#community-plugins 查看所有支持的部署目标和安装说明
list
列出指定目标中所有模型部署的名称。这些名称可以与 delete、update 和 get 命令一起使用。
用法
mlflow deployments list [OPTIONS]
选项
- -t, --target <target>
必需 部署目标 URI。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
在 https://mlflow.org.cn/docs/latest/plugins.html#community-plugins 查看所有支持的部署目标和安装说明
list-endpoints
列出指定目标处的所有端点
用法
mlflow deployments list-endpoints [OPTIONS]
选项
- -t, --target <target>
必需 部署目标 URI。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
在 https://mlflow.org.cn/docs/latest/plugins.html#community-plugins 查看所有支持的部署目标和安装说明
predict
预测给定输入已部署模型的结果
用法
mlflow deployments predict [OPTIONS]
选项
- -t, --target <target>
必需 部署目标 URI。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
在 https://mlflow.org.cn/docs/latest/plugins.html#community-plugins 查看所有支持的部署目标和安装说明
run-local
在本地部署模型。这与 create API 的签名非常相似
用法
mlflow deployments run-local [OPTIONS]
选项
- -t, --target <target>
必需 部署目标 URI。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
在 https://mlflow.org.cn/docs/latest/plugins.html#community-plugins 查看所有支持的部署目标和安装说明
update
更新指定目标中 ID 为 deployment_id 的部署。您可以更新模型的 URI 和/或已部署模型的类型(此时也必须指定模型 URI)。
额外的插件特定参数也可以通过 -C key=value 传递给此命令。
用法
mlflow deployments update [OPTIONS]
选项
- -t, --target <target>
必需 部署目标 URI。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
在 https://mlflow.org.cn/docs/latest/plugins.html#community-plugins 查看所有支持的部署目标和安装说明
update-endpoint
更新指定目标处的指定端点。
额外的插件特定参数也可以通过 -C key=value 传递给此命令
用法
mlflow deployments update-endpoint [OPTIONS]
选项
- -t, --target <target>
必需 部署目标 URI。运行 mlflow deployments help –target-name <target-name> 以获取有关给定目标的支持 URI 格式和配置选项的更多详细信息。当前已安装对以下部署的支持:faketarget, databricks, http, https, openai, sagemaker
在 https://mlflow.org.cn/docs/latest/plugins.html#community-plugins 查看所有支持的部署目标和安装说明
experiments
管理实验。要管理与跟踪服务器关联的实验,请将 MLFLOW_TRACKING_URI 环境变量设置为所需服务器的 URL。
用法
mlflow experiments [OPTIONS] COMMAND [ARGS]...
create
创建一个实验。
与此实验相关的运行生成的所有产物都将存储在产物位置下,并组织在特定的 run_id 子目录下。
实验和元数据存储的实现取决于后端存储。FileStore 为每个实验 ID 创建一个文件夹,并将元数据存储在 meta.yaml 中。运行存储为子文件夹。
用法
mlflow experiments create [OPTIONS]
选项
- -l, --artifact-location <artifact_location>
运行存储产物结果的基本位置。产物将存储在 $artifact_location/$run_id/artifacts。有关产物位置属性的更多信息,请参阅 https://mlflow.org.cn/docs/latest/tracking.html#where-runs-are-recorded。如果未提供位置,跟踪服务器将选择默认位置。
delete
标记处于活动状态的实验以供删除。这也适用于实验的元数据、运行和关联数据,以及如果存储在默认位置的产物。使用 list 命令查看产物位置。如果找不到实验或实验已被标记为删除,则命令将引发错误。
标记为删除的实验可以使用 restore 命令恢复,除非它们已被永久删除。
删除的具体实现取决于后端存储。FileStore 将标记为删除的实验移动到用于实例化 FileStore 的主文件夹下的 .trash 文件夹中。标记为删除的实验可以通过清理 .trash 文件夹来永久删除。建议使用 cron 作业或备用工作流机制来清理 .trash 文件夹。
用法
mlflow experiments delete [OPTIONS]
选项
get
通过 ID 或名称获取实验详细信息。
显示实验信息,包括名称、产物位置、生命周期阶段、标签、创建时间和最后更新时间。
# Get experiment by ID in table format (default)
mlflow experiments get --experiment-id 1
# Get experiment by name
mlflow experiments get --experiment-name "My Experiment"
# Get experiment in JSON format
mlflow experiments get --experiment-name "My Experiment" --output json
# Using short options
mlflow experiments get -x 0
mlflow experiments get -n "Default"
用法
mlflow experiments get [OPTIONS]
选项
restore
恢复已删除的实验。这也适用于实验的元数据、运行和关联数据。如果实验已经是活动的、无法找到或已永久删除,命令将引发错误。
用法
mlflow experiments restore [OPTIONS]
选项
update
更新实验跟踪存档策略控制。
跟踪存档选项配置或请求服务器拥有的存档行为。它们不会直接从客户端执行存档工作。
用法
mlflow experiments update [OPTIONS]
选项
- --trace-archival-retention <trace_archival_retention>
设置实验级别的跟踪存档保留覆盖,持续时间为 ‘30d’ 或 ‘12h’。这仅配置服务器拥有的存档策略。
gateway
管理 MLflow 网关服务
用法
mlflow gateway [OPTIONS] COMMAND [ARGS]...
start
启动 MLflow 网关服务
用法
mlflow gateway start [OPTIONS]
选项
环境变量
- MLFLOW_GATEWAY_CONFIG
提供
--config-path的默认值
gc
从指定的后端存储中永久删除 deleted 生命周期阶段的运行。此命令删除与指定运行相关的所有产物和元数据。如果提供的产物 URL 无效,则将跳过产物删除,并继续 gc 进程。
注意
如果您运行的 MLflow 跟踪服务器启用了产物代理,您必须在运行此命令之前设置 MLFLOW_TRACKING_URI 环境变量。否则,gc 命令将无法解析产物 URI,也无法删除相关产物。
什么会被删除
此命令永久删除
运行元数据:后端存储中的参数、指标、标签和所有其他运行信息
产物:存储在运行产物位置的所有文件(模型、图表、数据文件等)
实验元数据:删除实验时,会删除实验记录及所有关联数据
作业记录:使用 –jobs 标志时,会从作业表中删除历史作业记录
注意
此命令仅考虑生命周期阶段和指定的删除标准。它不会检查固定的(pinned)运行、注册模型或标签。固定是仅 UI 的功能,对垃圾回收没有影响。运行必须处于 deleted 生命周期阶段才能被永久删除。
示例
# Delete all runs that have been in the deleted state for more than 30 days
mlflow gc --older-than 30d
# Delete specific runs by ID (they must be in deleted state)
mlflow gc --run-ids 'run1,run2,run3'
# Delete all runs in specific experiments (experiments must be in deleted state)
mlflow gc --experiment-ids 'exp1,exp2'
# Combine criteria: delete runs older than 7 days in specific experiments
mlflow gc --older-than 7d --experiment-ids 'exp1,exp2'
# Delete deleted resources across all workspaces
mlflow gc --all-workspaces --older-than 30d
# Delete all finalized jobs older than 7 days (requires --jobs flag)
mlflow gc --jobs --older-than 7d
# Delete specific jobs by ID
mlflow gc --job-ids 'job1,job2,job3'
用法
mlflow gc [OPTIONS]
选项
- --older-than <older_than>
可选。删除早于指定时间限制的运行。按 #d#h#m#s 格式指定字符串。也支持浮点值。例如:–older-than 1d2h3m4s, –older-than 1.2d3h4m5s
- --backend-store-uri <PATH>
后端存储的 URI,用于从中删除运行。可接受的 URI 为兼容 SQLAlchemy 的数据库连接字符串(例如 ‘sqlite:///path/to/file.db’)或本地文件系统 URI(例如 ‘file:///absolute/path/to/directory’)。默认情况下,数据将从 ./mlruns 目录中删除。
- --artifacts-destination <URI>
用于解析工件上传/下载/列表请求的基本工件位置(例如 ‘s3://my-bucket’)。此选项仅在跟踪服务器配置为流式传输工件且实验的工件根目录为 http 或 mlflow-artifacts URI 时适用。否则,将使用默认的工件位置。
- --experiment-ids <experiment_ids>
可选,以逗号分隔的实验 ID 列表,用于永久删除实验及其所有关联的运行。如果未指定实验 ID,则移除处于 deleted 生命周期阶段的所有实验的数据。
- --logged-model-ids <logged_model_ids>
可选,以逗号分隔的已记录模型 ID 列表,用于永久删除。如果未指定已记录模型 ID,则移除处于 deleted 生命周期阶段的所有已记录模型的数据。
- --job-ids <job_ids>
可选,以逗号分隔的作业 ID 列表,用于永久删除。可带或不带 --jobs 标志使用。如果同时指定了 --older-than,则仅删除同时满足这两个过滤条件的作业。
- --tracking-uri <tracking_uri>
用于删除“已删除”运行的跟踪 URI,例如 http://127.0.0.1:8080
环境变量
- MLFLOW_ARTIFACTS_DESTINATION
为
--artifacts-destination提供默认值
- MLFLOW_WORKSPACE
为
--workspace提供默认值
mcp
MLflow 的模型上下文协议 (MCP) 服务器。MCP 使 LLM 应用程序能够以编程方式与 MLflow 跟踪进行交互。
用法
mlflow mcp [OPTIONS] COMMAND [ARGS]...
models
在本地部署 MLflow 模型。
要部署关联到跟踪服务器上运行的模型,请将 MLFLOW_TRACKING_URI 环境变量设置为所需服务器的 URL。
用法
mlflow models [OPTIONS] COMMAND [ARGS]...
build-docker
构建一个 Docker 镜像,其默认入口点使用 python_function flavor 在 8080 端口服务 MLflow 模型。如果调用 build-docker 时指定了 --model-uri,则容器将服务该 URI 引用的模型。如果调用 build_docker 时未指定 --model-uri,则必须将 MLflow 模型目录作为卷挂载到容器内的 /opt/ml/model 目录中。
使用 --model-uri 构建 Docker 镜像
# Build a Docker image named 'my-image-name' that serves the model from run 'some-run-uuid'
# at run-relative artifact path 'my-model'
mlflow models build-docker --model-uri "runs:/some-run-uuid/my-model" --name "my-image-name"
# Serve the model
docker run -p 5001:8080 "my-image-name"
不使用 --model-uri 构建 Docker 镜像
# Build a generic Docker image named 'my-image-name'
mlflow models build-docker --name "my-image-name"
# Mount the model stored in '/local/path/to/artifacts/model' and serve it
docker run --rm -p 5001:8080 -v /local/path/to/artifacts/model:/opt/ml/model "my-image-name"
重要提示
自 MLflow 2.10.1 起,使用 --model-uri 构建的 Docker 镜像不会安装 Java以提高性能,除非模型 flavor 是 ["johnsnowlabs", "h2o", "spark"] 之一。如果您需要为其他 flavor 安装 Java(例如使用 SparkML 的自定义 Python 模型),请指定 --install-java 标志以强制安装 Java。
注意:默认情况下,容器将启动 nginx 和 uvicorn 进程。如果您不需要启动 nginx 进程(例如,如果您将容器部署到 Google Cloud Run),可以通过 DISABLE_NGINX 环境变量禁用它。
docker run -p 5001:8080 -e DISABLE_NGINX=true "my-image-name"
默认情况下,uvicorn 工作进程的数量设置为 CPU 核心数。如果您想设置自定义工作进程数量,可以设置 MLFLOW_MODELS_WORKERS 环境变量。
docker run -p 5001:8080 -e MLFLOW_MODELS_WORKERS=4 "my-image-name"
有关 ‘python_function’ flavor 的更多信息,请参阅 https://www.mlflow.org/docs/latest/python_api/mlflow.pyfunc.html。
用法
mlflow models build-docker [OPTIONS]
选项
- -m, --model-uri <URI>
[可选] 模型 URI。本地路径、‘runs:/’ URI 或远程存储 URI(例如 ‘s3://’ URI)。有关模型工件支持的远程 URI 的更多信息,请参阅 https://mlflow.org.cn/docs/latest/tracking.html#artifact-stores
- --env-manager <env_manager>
如果指定,使用指定的环境管理器为 MLmodel 创建环境。支持以下值
- local: 使用本地环境- virtualenv: 使用 venv(以及用于 Python 版本管理的 pyenv)- uv: 使用 uv- conda: 使用 conda如果未指定,默认为 virtualenv。
generate-dockerfile
生成一个包含 Dockerfile 的目录,其默认入口点使用 python_function flavor 在 8080 端口服务 MLflow 模型。生成的 Dockerfile 以及模型(如果已指定)将写入指定的输出目录。此 Dockerfile 定义的镜像与 mlflow models build-docker 生成的镜像等效。
用法
mlflow models generate-dockerfile [OPTIONS]
选项
- -m, --model-uri <URI>
[可选] 模型 URI。本地路径、‘runs:/’ URI 或远程存储 URI(例如 ‘s3://’ URI)。有关模型工件支持的远程 URI 的更多信息,请参阅 https://mlflow.org.cn/docs/latest/tracking.html#artifact-stores
- --env-manager <env_manager>
如果指定,使用指定的环境管理器为 MLmodel 创建环境。支持以下值
- local: 使用本地环境- virtualenv: 使用 venv(以及用于 Python 版本管理的 pyenv)- uv: 使用 uv- conda: 使用 conda如果未指定,默认为 None,MLflow 将根据模型的 flavor 配置自动选择环境管理器。如果指定了 model-uri:如果 flavor 配置中指定了 python 版本且不需要安装 java,则使用本地环境。否则使用 virtualenv。如果未提供 model-uri,则使用 virtualenv。
predict
使用已保存的 MLflow 模型生成 JSON 格式的预测。有关此功能接受的输入数据格式的信息,请参阅以下文档: https://www.mlflow.org/docs/latest/models.html#built-in-deployment-tools。
用法
mlflow models predict [OPTIONS]
选项
- -m, --model-uri <URI>
必需 模型 URI。本地路径、‘runs:/’ URI 或远程存储 URI(例如 ‘s3://’ URI)。有关模型产物支持的远程 URI 的更多信息,请参阅 https://mlflow.org.cn/docs/latest/tracking.html#artifact-stores
- --env-manager <env_manager>
如果指定,使用指定的环境管理器为 MLmodel 创建环境。支持以下值
- local: 使用本地环境- virtualenv: 使用 venv(以及用于 Python 版本管理的 pyenv)- uv: 使用 uv- conda: 使用 conda如果未指定,默认为 virtualenv。
- --install-mlflow
如果指定且有 conda、virtualenv 或 uv 环境需要激活,MLflow 将在环境激活后安装到该环境中。安装的 mlflow 版本将与调用此命令时所使用的版本一致。
prepare-env
执行预测或服务模型所需的任何准备工作,例如下载依赖项或初始化 conda 环境。准备工作完成后,调用 predict 或 serve 应能快速响应。
用法
mlflow models prepare-env [OPTIONS]
选项
- -m, --model-uri <URI>
必需 模型 URI。本地路径、‘runs:/’ URI 或远程存储 URI(例如 ‘s3://’ URI)。有关模型产物支持的远程 URI 的更多信息,请参阅 https://mlflow.org.cn/docs/latest/tracking.html#artifact-stores
serve
通过在指定的主机和端口启动 Web 服务器来服务使用 MLflow 保存的模型。该命令支持具有 python_function 或 crate (R Function) flavor 的模型。有关 Web 服务器接受的输入数据格式的信息,请参阅以下文档: https://www.mlflow.org/docs/latest/models.html#built-in-deployment-tools。
警告
如果在使用 MLflow 2.x 的环境中执行,使用 MLflow 1.x 构建的模型将需要调整端点请求负载。在 1.x 中,请求负载的格式为: {'columns': [str], 'data': [[...]]}。2.x 模型需要由 dataframe_split、instances、inputs 或 dataframe_records 的结构定义键定义的负载。请参阅下面的示例,了解 2.0 中调用 API 端点的更改演示。
注意
以 pandas DataFrame 结构发出的请求可以采用 split 或 records 导向的格式。有关将 pandas DataFrame 转换为 JSON 的导向格式的详细信息,请参阅 https://pandas.ac.cn/docs/reference/api/pandas.DataFrame.to_json.html。
示例
$ mlflow models serve -m runs:/my-run-id/model-path &
# records orientation input format for serializing a pandas DataFrame
$ curl http://127.0.0.1:5000/invocations -H 'Content-Type: application/json' -d '{
"dataframe_records": [{"a":1, "b":2}, {"a":3, "b":4}, {"a":5, "b":6}]
}'
# split orientation input format for serializing a pandas DataFrame
$ curl http://127.0.0.1:5000/invocations -H 'Content-Type: application/json' -d '{
"dataframe_split": {"columns": ["a", "b"],
"index": [0, 1, 2],
"data": [[1, 2], [3, 4], [5, 6]]}
}'
# inputs format for List submission of array, tensor, or DataFrame data
$ curl http://127.0.0.1:5000/invocations -H 'Content-Type: application/json' -d '{
"inputs": [[1, 2], [3, 4], [5, 6]]
}'
# instances format for submission of Tensor data
curl http://127.0.0.1:5000/invocations -H 'Content-Type: application/json' -d '{
"instances": [
{"a": "t1", "b": [1, 2, 3]},
{"a": "t2", "b": [4, 5, 6]},
{"a": "t3", "b": [7, 8, 9]}
]
}'
用法
mlflow models serve [OPTIONS]
选项
- -m, --model-uri <URI>
必需 模型 URI。本地路径、‘runs:/’ URI 或远程存储 URI(例如 ‘s3://’ URI)。有关模型产物支持的远程 URI 的更多信息,请参阅 https://mlflow.org.cn/docs/latest/tracking.html#artifact-stores
- -h, --host <HOST>
绑定服务器的网络接口(默认:127.0.0.1)。这控制哪些网络接口接受连接。使用 ‘127.0.0.1’ 进行仅限本地访问,或使用 ‘0.0.0.0’ 允许来自任何网络的连接。注意:这不是安全设置 - 它仅控制网络绑定。要限制可以连接的客户端,请使用 –allowed-hosts。
- --env-manager <env_manager>
如果指定,使用指定的环境管理器为 MLmodel 创建环境。支持以下值
- local: 使用本地环境- virtualenv: 使用 venv(以及用于 Python 版本管理的 pyenv)- uv: 使用 uv- conda: 使用 conda如果未指定,默认为 virtualenv。
- --install-mlflow
如果指定且有 conda、virtualenv 或 uv 环境需要激活,MLflow 将在环境激活后安装到该环境中。安装的 mlflow 版本将与调用此命令时所使用的版本一致。
环境变量
- MLFLOW_PORT
为
--port提供默认值
- MLFLOW_HOST
为
--host提供默认值
- MLFLOW_SCORING_SERVER_REQUEST_TIMEOUT
为
--timeout提供默认值
- MLFLOW_MODELS_WORKERS
为
--workers提供默认值
update-pip-requirements
从模型的 conda.yaml 和 requirements.txt 文件中添加或删除需求。如果使用远程跟踪服务器,请确保将 MLFLOW_TRACKING_URI 环境变量设置为所需服务器的 URL。
REQUIREMENT_STRINGS 是 pip 需求说明符的列表。请参见下文示例。
使用示例
# Add requirements using the model's "runs:/" URI
mlflow models update-pip-requirements -m runs:/<run_id>/<model_path> \
add "pandas==1.0.0" "scikit-learn" "mlflow >= 2.8, != 2.9.0"
# Remove requirements from a local model
mlflow models update-pip-requirements -m /path/to/local/model \
remove "torchvision" "pydantic"
请注意,不支持模型注册表 URI(即 models:/ 格式的 URI),因为模型注册表中的工件旨在为只读。也不支持编辑只读工件仓库中的需求。
如果添加需求,该函数将覆盖任何重叠的现有需求,否则将新需求附加到现有列表中。
如果删除需求,该函数将忽略任何版本说明符,并删除所有指定的包名称。现有文件中未找到的任何需求都将被忽略。
用法
mlflow models update-pip-requirements [OPTIONS] {add|remove}
[REQUIREMENT_STRINGS]...
选项
- -m, --model-uri <URI>
必需 模型 URI。本地路径、‘runs:/’ URI 或远程存储 URI(例如 ‘s3://’ URI)。有关模型产物支持的远程 URI 的更多信息,请参阅 https://mlflow.org.cn/docs/latest/tracking.html#artifact-stores
参数
run
从给定的 URI 运行 MLflow 项目。
对于本地运行,运行将阻塞直到完成。否则,项目将异步运行。
如果在本地运行(默认),URI 可以是 Git 仓库 URI 或本地路径。如果在 Databricks 上运行,URI 必须是 Git 仓库。
默认情况下,Git 项目在带有给定参数的新工作目录中运行,而本地项目从项目的根目录运行。
用法
mlflow run [OPTIONS] URI
选项
- -e, --entry-point <NAME>
项目中的入口点。[默认值:main]。如果未找到入口点,则尝试以指定名称作为脚本运行项目文件,使用 ‘python’ 运行 .py 文件,并使用默认 shell(由环境变量 $SHELL 指定)运行 .sh 文件。
- -P, --param-list <NAME=VALUE>
运行的参数,格式为 -P name=value。提供的不在入口点参数列表中的参数将作为命令行参数以 –name value 的形式传递给相应的入口点。
- -A, --docker-args <NAME=VALUE>
一个 docker run 参数或标志,格式为 -A name=value (例如 -A gpus=all) 或 -A name (例如 -A t)。该参数将分别作为 docker run –name value 或 docker run –name 传递。
- -b, --backend <BACKEND>
用于运行的执行后端。支持的值:‘local’、‘databricks’、kubernetes (实验性)。默认为 ‘local’。如果针对 Databricks 运行,将针对以下方式确定的 Databricks 工作区运行:如果已设置 ‘databricks://profile’ 形式的 Databricks 跟踪 URI(例如通过设置 MLFLOW_TRACKING_URI 环境变量),则针对由 <profile> 指定的工作区运行。否则,针对默认 Databricks CLI 配置文件的 workspace 运行。有关配置 Databricks CLI 配置文件的更多信息,请参阅 https://github.com/databricks/databricks-cli。
- -c, --backend-config <FILE>
JSON 文件路径(必须以 ‘.json’ 结尾)或将作为配置传递给后端的 JSON 字符串。应提供的确切内容对于每个执行后端都是不同的,并在 https://www.mlflow.org/docs/latest/projects.html 中有相关记录。
- --env-manager <env_manager>
如果指定,使用指定的环境管理器为 MLproject 创建环境。支持以下值
- local: 使用本地环境- virtualenv: 使用 venv(以及用于 Python 版本管理的 pyenv)- uv: 使用 uv- conda: 使用 conda如果未指定,将根据项目配置自动选择适当的环境管理器。例如,如果 MLproject.yaml 包含 python_env 键,则使用 virtualenv。
- --storage-dir <storage_dir>
仅在
backend为 local 时有效。MLflow 将从传递给类型为 ‘path’ 的参数的分布式 URI 下载工件到 storage_dir 的子目录。
- --build-image
仅对 Docker 项目有效。如果指定,构建一个新的 Docker 镜像,该镜像基于 MLproject 文件中的 image 字段指定的镜像,并包含项目目录中的文件。
- 默认值
False
参数
环境变量
- MLFLOW_EXPERIMENT_NAME
为
--experiment-name提供默认值
- MLFLOW_EXPERIMENT_ID
为
--experiment-id提供默认值
- MLFLOW_TMP_DIR
为
--storage-dir提供默认值
runs
管理运行。要管理关联到跟踪服务器的实验运行,请将 MLFLOW_TRACKING_URI 环境变量设置为所需服务器的 URL。
用法
mlflow runs [OPTIONS] COMMAND [ARGS]...
create
创建一个新的 MLflow 运行并立即以指定状态结束它。
此命令对于以编程方式创建用于测试、脚本编写或记录已完成实验的运行非常有用。运行将被创建并立即以指定状态(FINISHED、FAILED 或 KILLED)关闭。
用法
mlflow runs create [OPTIONS]
选项
- -t, --tags <tags>
用于对运行进行分类和过滤的键值对。可多次使用以设置多个标签。格式:key=value(例如 env=prod, model=xgboost, version=1.0)。
环境变量
- MLFLOW_EXPERIMENT_ID
为
--experiment-id提供默认值
- MLFLOW_EXPERIMENT_NAME
为
--experiment-name提供默认值
delete
标记运行以供删除。如果运行不存在或已被标记,则返回错误。您可以使用 restore_run 恢复已标记的运行,或在后端存储中永久删除运行。
用法
mlflow runs delete [OPTIONS]
选项
link-traces
将跟踪链接到运行。
此命令将一个或多个跟踪链接到现有运行。可以将跟踪链接到运行以建立跟踪和运行之间的关系。单个命令中最多可以链接 100 个跟踪。
用法
mlflow runs link-traces [OPTIONS]
选项
list
列出已配置的跟踪服务器中指定实验的所有运行。
用法
mlflow runs list [OPTIONS]
选项
环境变量
- MLFLOW_EXPERIMENT_ID
为
--experiment-id提供默认值
sagemaker
在 SageMaker 上服务模型。
要服务关联到跟踪服务器上运行的模型,请将 MLFLOW_TRACKING_URI 环境变量设置为所需服务器的 URL。
用法
mlflow sagemaker [OPTIONS] COMMAND [ARGS]...
build-and-push-container
构建新的 MLflow Sagemaker 镜像,分配名称,并推送到 ECR。
此函数构建 MLflow Docker 镜像。镜像是在本地构建的,需要 Docker 才能运行。镜像被推送到当前活动的 AWS 账户和当前活动的 AWS 区域下的 ECR。
用法
mlflow sagemaker build-and-push-container [OPTIONS]
选项
- --network <network>
设置 docker 构建期间 RUN 指令的网络模式。例如,在 SageMaker JupyterLab 中构建时,使用 ‘–network sagemaker’。
- --install-java <install_java>
如果需要,在镜像中安装 Java。默认为 None,由 MLflow 决定是否安装。需要 Java 的 flavor(如 Spark)会自动启用此功能。注意:此选项仅适用于 UBUNTU 基础镜像;Python 基础镜像不支持 Java 安装。
deploy-transform-job
将模型作为批处理转换作业部署在 Sagemaker 上。当前活动的 AWS 账户需要设置正确的权限。
默认情况下,除非指定了 --async 标志,否则此命令将阻塞,直到批处理转换作业完成(明确成功或失败)或指定的超时时间已过。
用法
mlflow sagemaker deploy-transform-job [OPTIONS]
选项
- -m, --model-uri <URI>
必需 模型 URI。本地路径、‘runs:/’ URI 或远程存储 URI(例如 ‘s3://’ URI)。有关模型产物支持的远程 URI 的更多信息,请参阅 https://mlflow.org.cn/docs/latest/tracking.html#artifact-stores
- -t, --instance-type <instance_type>
执行批处理转换作业的 SageMaker ML 实例类型。有关支持的实例类型列表,请参阅 https://aws.amazon.com/sagemaker/pricing/instance-types/。
- -v, --vpc-config <vpc_config>
包含 JSON 格式 VPC 配置的文件路径。此配置将在创建与此应用程序关联的新 SageMaker 模型时使用。有关更多信息,请参阅 https://docs.aws.amazon.com/sagemaker/latest/dg/API_VpcConfig.html
push-model
将 MLflow 模型推送到 Sagemaker 模型注册表。当前活动的 AWS 账户需要设置正确的权限。
用法
mlflow sagemaker push-model [OPTIONS]
选项
- -m, --model-uri <URI>
必需 模型 URI。本地路径、‘runs:/’ URI 或远程存储 URI(例如 ‘s3://’ URI)。有关模型产物支持的远程 URI 的更多信息,请参阅 https://mlflow.org.cn/docs/latest/tracking.html#artifact-stores
terminate-transform-job
终止指定的 Sagemaker 批处理转换作业。除非指定了 --archive,否则与批处理转换作业关联的所有 SageMaker 资源也会被删除。
默认情况下,除非指定了 --async 标志,否则此命令将阻塞,直到终止过程完成(明确成功或失败)或指定的超时时间已过。
用法
mlflow sagemaker terminate-transform-job [OPTIONS]
选项
scorers (评分器)
管理评分器,包括 LLM(大语言模型)评判器。要管理与跟踪服务器关联的评分器,请将 MLFLOW_TRACKING_URI 环境变量设置为所需服务器的 URL。
用法
mlflow scorers [OPTIONS] COMMAND [ARGS]...
list (列出)
列出实验中已注册的评分器,或列出所有内置评分器。
# List built-in scorers (table format)
mlflow scorers list --builtin
mlflow scorers list -b
# List built-in scorers (JSON format)
mlflow scorers list --builtin --output json
# List registered scorers in table format (default)
mlflow scorers list --experiment-id 123
# List registered scorers in JSON format
mlflow scorers list --experiment-id 123 --output json
# Using environment variable for experiment ID
export MLFLOW_EXPERIMENT_ID=123
mlflow scorers list
用法
mlflow scorers list [OPTIONS]
选项
环境变量
- MLFLOW_EXPERIMENT_ID
为
--experiment-id提供默认值
register-llm-judge (注册 LLM 评判器)
在指定的实验中注册一个 LLM 评判器评分器。
该命令使用自然语言指令创建一个 LLM 评判器,并将其注册到实验中,以用于评估工作流。指令必须至少包含一个模板变量({{ inputs }}、{{ outputs }}、{{ expectations }} 或 {{ trace }})来定义评判器将评估的内容。
# Register a basic quality judge
mlflow scorers register-llm-judge -n quality_judge \
-i "Evaluate if {{ outputs }} answers {{ inputs }}. Return yes or no." -x 123
# Register a judge with custom model
mlflow scorers register-llm-judge -n custom_judge \
-i "Check whether {{ outputs }} is professional and formal. Rate pass, fail, or na" \
-m "openai:/gpt-4" -x 123
# Register a judge with description
mlflow scorers register-llm-judge -n quality_judge \
-i "Evaluate if {{ outputs }} answers {{ inputs }}. Return yes or no." \
-d "Evaluates response quality and relevance" -x 123
# Using environment variable
export MLFLOW_EXPERIMENT_ID=123
mlflow scorers register-llm-judge -n my_judge \
-i "Check whether {{ outputs }} contains PII"
用法
mlflow scorers register-llm-judge [OPTIONS]
选项
- -i, --instructions <instructions>
必填 评估指令。必须至少包含一个模板变量:
{{ inputs }}、{{ outputs }}、{{ expectations }}或{{ trace }}。有关变量解释,请参阅 make_judge 文档。
- --extra-headers <extra_headers>
包含在向 LLM 提供商发送请求时的附加 HTTP 标头的 JSON 字符串。示例:‘{“X-API-Key”: “secret”}’。注意:当注册评判器时,此值不会被持久化。
环境变量
- MLFLOW_EXPERIMENT_ID
为
--experiment-id提供默认值
server (服务器)
运行带有内置安全中间件的 MLflow 跟踪服务器。
服务器默认监听 https://:5000,并且仅接受来自本地机器的连接。要使服务器接受来自其他机器的连接,您需要传递 --host 0.0.0.0 以监听所有网络接口(或特定的接口地址)。
有关 MLflow 跟踪服务器安全配置的详细文档和指南,请参阅 https://mlflow.org.cn/docs/latest/tracking/server-security.html。
用法
mlflow server [OPTIONS]
选项
- --backend-store-uri <PATH>
用于持久化实验和运行数据的 URI。可接受的 URI 是与 SQLAlchemy 兼容的数据库连接字符串(例如 ‘sqlite:///path/to/file.db’)或本地文件系统 URI(例如 ‘file:///absolute/path/to/directory’)。默认情况下,数据将记录到 ./mlruns 目录中。
- --read-replica-backend-store-uri <URI>
只读数据库副本的 URI。指定此项后,读取操作(例如 search_runs, get_experiment)将被路由到此 URI,而写入操作使用 –backend-store-uri。通过数据库读取副本实现横向扩展。如果未指定,则所有操作都使用 –backend-store-uri。注意:如果副本变得不可用,不会自动故障转移到主库。云托管数据库(Aurora、RDS)会在 DNS 级别处理此问题。对于自托管设置,请使用连接代理(PgBouncer、HAProxy)进行故障转移。
- --registry-store-uri <URI>
用于持久化已注册模型的 URI。可接受的 URI 是与 SQLAlchemy 兼容的数据库连接字符串(例如 ‘sqlite:///path/to/file.db’)。如果未指定,则使用 backend-store-uri。
- --default-artifact-root <URI>
用于存储任何新创建实验的工件的目录。对于依赖 SQL 的跟踪服务器后端,此选项是存储工件所必需的。请注意,此标志不会影响已经使用之前 MLflow 服务器实例配置创建的实验。默认情况下,如果启用了 –serve-artifacts 选项,数据将被记录到 mlflow-artifacts:/ URI 代理。否则,默认位置将是 ./mlruns。
- --serve-artifacts, --no-serve-artifacts
通过代理将工件上传、下载和列出请求路由到由 ‘–artifacts-destination’ 指定的存储位置,从而启用工件服务。这些请求的服务默认位置是本地 ‘./mlartifacts’ 目录,可以通过 ‘–artifacts-destination’ 参数覆盖。要禁用工件服务,请指定 –no-serve-artifacts。默认值:True
- --artifacts-only
如果指定此项,则配置 MLflow 服务器仅用于代理工件服务。在此模式下,MLflow 跟踪服务的功能(例如运行创建、指标记录和参数记录)将被禁用。服务器将仅公开用于上传、下载和列出工件的端点。默认值:False
- --artifacts-destination <URI>
用于解析工件上传/下载/列出请求的基本工件位置(例如 ‘s3://my-bucket’)。默认为本地 ‘./mlartifacts’ 目录。此选项仅在跟踪服务器配置为流式传输工件,且实验的工件根位置为 http 或 mlflow-artifacts URI 时有效。
- -h, --host <HOST>
绑定服务器的网络接口(默认:127.0.0.1)。这控制哪些网络接口接受连接。使用 ‘127.0.0.1’ 进行仅限本地访问,或使用 ‘0.0.0.0’ 允许来自任何网络的连接。注意:这不是安全设置 - 它仅控制网络绑定。要限制可以连接的客户端,请使用 –allowed-hosts。
- --allowed-hosts <allowed_hosts>
以逗号分隔的允许主机标头列表,以防止 DNS 重绑定攻击(默认:localhost + 私有 IP)。DNS 重绑定允许攻击者诱骗您的浏览器访问内部服务。示例:‘mlflow.company.com,10.0.0.100:5000’。支持通配符:‘mlflow.company.com,192.168.*,app-*.internal.com’。使用 ‘*’ 允许所有主机(不建议用于生产环境)。默认允许:localhost(所有端口)、私有 IP(10.*, 192.168.*, 172.16-31.*)。在将 MLflow 暴露到 localhost 之外时,请设置此项以防止主机标头攻击。
- --cors-allowed-origins <cors_allowed_origins>
以逗号分隔的允许 CORS 源列表,以防止跨站请求攻击(默认:任何端口上的 localhost 源)。CORS 攻击允许恶意网站使用您的凭据向您的 MLflow 服务器发送请求。示例:‘https://app.company.com,https://notebook.company.com’。默认允许:https://:*(任何端口)、http://127.0.0.1:*, http://[::1]:*。当您有不同域名上的 Web 应用程序需要访问 MLflow 时,请设置此项。使用 ‘*’ 允许所有源(危险 - 仅限开发使用!)。
- --disable-security-middleware
危险:禁用所有安全中间件,包括 CORS 保护和主机验证。这完全移除了安全保护,应仅用于测试。禁用后,您的 MLflow 服务器容易受到 CORS 攻击、DNS 重绑定和点击劫持。建议使用 –cors-allowed-origins 和 –allowed-hosts 配置特定的安全设置。
- --x-frame-options <x_frame_options>
用于点击劫持保护的 X-Frame-Options 标头值。选项:‘SAMEORIGIN’(默认 - 仅允许来自同一源的嵌入)、‘DENY’(防止所有嵌入)、‘NONE’(禁用标头 - 允许从任何地方嵌入)。如果您需要将 MLflow UI 嵌入到来自不同源的 iframe 中,请设置为 ‘NONE’。
- --expose-prometheus <expose_prometheus>
存储指标的目录路径。如果该目录不存在,将创建它。激活 prometheus 导出器以在 /metrics 端点公开指标。
- --dev
如果启用,将以调试日志记录和自动重载模式运行服务器。仅应在开发目的下使用。不能与 ‘–gunicorn-opts’ 或 ‘–uvicorn-opts’ 一起使用。Windows 上不支持。
- 默认值
False
- --secrets-cache-ttl <secrets_cache_ttl>
服务器端机密缓存的生存时间(秒)。控制解密后的机密在内存中的缓存时间(使用 AES-GCM-256 加密)。较低的值(10-30 秒)更安全,但会影响性能。较高的值(120-300 秒)可提高性能,但会增加暴露窗口。范围:10-300 秒。
- 默认值
60
- --secrets-cache-max-size <secrets_cache_max_size>
服务器端机密缓存的最大条目数。超过此数量时,将逐出最近最少使用的条目。范围:1-10000 条目。
- 默认值
1000
- --workspace-store-uri <URI>
用于工作区 CRUD API 和请求路由的工作区提供程序后端 URI。如果未指定,默认指向后端存储 URI。仅在使用利用外部管理工作区(例如 Kubernetes 命名空间)的工作区存储插件时需要指定此项。
环境变量
- MLFLOW_BACKEND_STORE_URI
为
--backend-store-uri提供默认值
- MLFLOW_READ_REPLICA_BACKEND_STORE_URI
为
--read-replica-backend-store-uri提供默认值
- MLFLOW_REGISTRY_STORE_URI
为
--registry-store-uri提供默认值
- MLFLOW_DEFAULT_ARTIFACT_ROOT
为
--default-artifact-root提供默认值
- MLFLOW_SERVE_ARTIFACTS
为
--serve-artifacts提供默认值
- MLFLOW_ARTIFACTS_ONLY
为
--artifacts-only提供默认值
- MLFLOW_ARTIFACTS_DESTINATION
为
--artifacts-destination提供默认值
- MLFLOW_HOST
为
--host提供默认值
- MLFLOW_PORT
为
--port提供默认值
- MLFLOW_WORKERS
为
--workers提供默认值
- MLFLOW_SERVER_ALLOWED_HOSTS
为
--allowed-hosts提供默认值
- MLFLOW_SERVER_CORS_ALLOWED_ORIGINS
为
--cors-allowed-origins提供默认值
- MLFLOW_SERVER_DISABLE_SECURITY_MIDDLEWARE
为
--disable-security-middleware提供默认值
- MLFLOW_SERVER_X_FRAME_OPTIONS
为
--x-frame-options提供默认值
- MLFLOW_STATIC_PREFIX
为
--static-prefix提供默认值
- MLFLOW_GUNICORN_OPTS
为
--gunicorn-opts提供默认值
- MLFLOW_UVICORN_OPTS
为
--uvicorn-opts提供默认值
- MLFLOW_EXPOSE_PROMETHEUS
为
--expose-prometheus提供默认值
- MLFLOW_TRACE_ARCHIVAL_CONFIG
为
--trace-archival-config提供默认值
- MLFLOW_WORKSPACE_STORE_URI
为
--workspace-store-uri提供默认值
traces (追踪)
管理追踪。要管理与跟踪服务器关联的追踪,请将 MLFLOW_TRACKING_URI 环境变量设置为所需服务器的 URL。
追踪模式:info.trace_id # 唯一追踪标识符 info.experiment_id # MLflow 实验 ID info.request_time # 请求时间戳(毫秒) info.execution_duration # 总执行时间(毫秒) info.state # 追踪状态:OK、ERROR 等 info.client_request_id # 可选的客户端提供的请求 ID info.request_preview # 截断的请求预览 info.response_preview # 截断的响应预览 info.trace_metadata.mlflow.* # MLflow 特定的元数据 info.trace_metadata.* # 自定义元数据字段 info.tags.mlflow.traceName # 追踪名称标签 info.tags.<key> # 自定义标签 info.assessments.*.assessment_id # 评估标识符 info.assessments.*.feedback.name # 反馈名称 info.assessments.*.feedback.value # 反馈分数/值 info.assessments.*.feedback.rationale # 反馈解释 info.assessments.*.expectation.name # 基准真值名称 info.assessments.*.expectation.value # 预期值 info.assessments.*.source.source_type # HUMAN(人类)、LLM_JUDGE(大模型评判器)、CODE(代码) info.assessments.*.source.source_id # 来源标识符 info.token_usage # Token 使用量(属性,无法通过字段搜索) data.spans.*.span_id # 单个跨度 (span) ID data.spans.*.name # 跨度操作名称 data.spans.*.parent_id # 父跨度关系 data.spans.*.start_time # 跨度开始时间戳 data.spans.*.end_time # 跨度结束时间戳 data.spans.*.status_code # 跨度状态代码 data.spans.*.attributes.mlflow.spanType # AGENT(代理)、TOOL(工具)、LLM 等 data.spans.*.attributes.<key> # 自定义跨度属性 data.spans.*.events.*.name # 事件名称 data.spans.*.events.*.timestamp # 事件时间戳 data.spans.*.events.*.attributes.<key> # 事件属性
更多详细信息,请参阅:https://mlflow.org.cn/docs/latest/genai/tracing/concepts/trace/#traceinfo-metadata-and-context
用法
mlflow traces [OPTIONS] COMMAND [ARGS]...
delete (删除)
删除实验中的追踪。
可以指定 –trace-ids 或时间戳标准,但不能同时指定两者。
用法
mlflow traces delete [OPTIONS]
选项
环境变量
- MLFLOW_EXPERIMENT_ID
为
--experiment-id提供默认值
delete-assessment (删除评估)
从追踪中删除评估。
用法
mlflow traces delete-assessment [OPTIONS]
选项
delete-tag (删除标签)
从追踪中删除标签。
用法
mlflow traces delete-tag [OPTIONS]
选项
evaluate (评估)
使用指定的评分器评估一个或多个追踪,并显示结果。
该命令在指定的追踪上运行 MLflow 的 genai.evaluate(),应用指定的评分器,并以表格或 JSON 格式显示评估结果。
用法
mlflow traces evaluate [OPTIONS]
选项
环境变量
- MLFLOW_EXPERIMENT_ID
为
--experiment-id提供默认值
get (获取)
所有追踪详情将以 JSON 格式打印到 stdout。
用法
mlflow traces get [OPTIONS]
选项
get-assessment (获取评估)
获取评估详情作为 JSON。
用法
mlflow traces get-assessment [OPTIONS]
选项
log-expectation (记录基准真值)
将预期(基准真值标签)记录到追踪中。
用法
mlflow traces log-expectation [OPTIONS]
选项
log-feedback (记录反馈)
将反馈(评估分数)记录到追踪中。
用法
mlflow traces log-feedback [OPTIONS]
选项
search (搜索)
在指定的实验中搜索追踪。
示例
用法
mlflow traces search [OPTIONS]
选项
- --filter-string <filter_string>
用于追踪搜索的过滤字符串。
示例:- 按运行 ID 过滤:“run_id = ‘123abc’” - 按状态过滤:“status = ‘OK’” - 按时间戳过滤:“timestamp_ms > 1700000000000” - 按元数据过滤:“metadata.`mlflow.modelId` = ‘model123’” - 按标签过滤:“tags.environment = ‘production’” - 多个条件:“run_id = ‘123’ AND status = ‘OK’”
可用字段:- run_id: 关联的 MLflow 运行 ID - status: 追踪状态(OK, ERROR 等) - timestamp_ms: 追踪时间戳(毫秒) - execution_time_ms: 追踪执行时间(毫秒) - name: 追踪名称 - metadata.<key>: 自定义元数据字段(带点的键使用反引号) - tags.<key>: 自定义标签字段
- --sql-warehouse-id <sql_warehouse_id>
已弃用。改用 MLFLOW_TRACING_SQL_WAREHOUSE_ID 环境变量。SQL 数据仓库 ID(仅在搜索存储在 Databricks Unity Catalog 中的模型追踪时需要)
- --extract-fields <extract_fields>
使用点表示法过滤并选择特定字段。示例:“info.trace_id”, “info.assessments.*”, “data.spans.*.name”。对于带点的字段名,请使用反引号:“info.tags.`mlflow.traceName`”。多个字段用逗号分隔。默认情况下,表格模式使用标准列,JSON 模式使用所有字段。
环境变量
- MLFLOW_EXPERIMENT_ID
为
--experiment-id提供默认值
set-tag (设置标签)
设置追踪的标签。
用法
mlflow traces set-tag [OPTIONS]
选项
update-assessment (更新评估)
更新现有评估。
注意:评估名称设置后不可更改。仅可更新 value、rationale(理由)和 metadata(元数据)。
用法
mlflow traces update-assessment [OPTIONS]
选项