如何通过编程方式设置MLflow Experiment描述？

针对MLflow中无法通过create_experiment或set_experiment直接设置实验描述的问题，除了UI操作外，有以下几种可行的编程方案：

从MLflow 1.20.0版本开始，MlflowClient提供了update_experiment方法，支持直接修改实验的描述属性。步骤如下：

1. 创建实验（或获取已有实验的ID）
2. 调用update_experiment传入实验ID和描述参数

代码示例：

import mlflow
from mlflow.tracking import MlflowClient

client = MlflowClient()

# 目标实验名称
experiment_name = "图像分类训练实验"

try:
    # 创建新实验
    experiment_id = client.create_experiment(experiment_name)
except mlflow.exceptions.MlflowException:
    # 实验已存在，获取其ID
    experiment = client.get_experiment_by_name(experiment_name)
    experiment_id = experiment.experiment_id

# 更新实验描述
client.update_experiment(
    experiment_id=experiment_id,
    description="该实验用于训练ResNet模型，包含数据预处理、模型训练、指标评估等全流程"
)

如果你的MLflow版本较低，或者需要更灵活的控制，可以直接调用MLflow的REST API来创建带描述的实验，或更新已有实验的描述。

创建带描述的实验 #

import requests

# 替换为你的MLflow服务地址
mlflow_tracking_uri = "http://localhost:5000"
experiment_name = "超参数调优实验"
description = "通过REST API创建，用于测试不同学习率和批量大小对模型精度的影响"

response = requests.post(
    f"{mlflow_tracking_uri}/api/2.0/mlflow/experiments/create",
    json={"name": experiment_name, "description": description}
)

if response.status_code == 200:
    print(f"实验创建成功，ID: {response.json()['experiment_id']}")
else:
    print(f"创建失败：{response.json()}")

更新已有实验的描述 #

import requests

mlflow_tracking_uri = "http://localhost:5000"
# 替换为目标实验的ID
target_experiment_id = "3"
new_description = "更新：新增了模型推理延迟测试环节"

response = requests.post(
    f"{mlflow_tracking_uri}/api/2.0/mlflow/experiments/update",
    json={"experiment_id": target_experiment_id, "description": new_description}
)

if response.status_code == 200:
    print("实验描述更新成功")
else:
    print(f"更新失败：{response.json()}")

如果需要与CLI工作流集成，可以在Python脚本中通过subprocess调用mlflow experiments create命令，利用其--description参数设置描述：

import subprocess

experiment_name = "CLI集成实验"
description = "通过subprocess调用CLI创建的实验，用于自动化训练流水线"

subprocess.run(
    [
        "mlflow", "experiments", "create",
        "--name", experiment_name,
        "--description", description
    ],
    check=True
)

这种方式适合bash脚本或需要与CLI工具链结合的场景，但灵活性不如前两种方案。

内容的提问来源于stack exchange，提问作者Indrajit Roy