Run 类
定义所有 Azure 机器学习试验运行的基类。
运行表示试验的单次试运行。 运行用于监视试用的异步执行、记录指标和存储试用的输出，以及分析结果和访问试用生成的项目。
当提交脚本以在 Azure 机器学习中的许多不同场景（包括 HyperDrive 运行、管道运行和 AutoML 运行）中训练模型时，会创建运行对象。 使用 Experiment 类进行 submit 或 start_logging 时，也会创建运行对象。
若要开始使用试验和运行，请参阅
初始化 Run 对象。
- 继承
-
azureml._run_impl.run_base._RunBaseRun
构造函数
Run(experiment, run_id, outputs=None, **kwargs)参数
- _run_dto
- <xref:azureml._restclient.models.run_dto.RunDto>
仅限内部使用。
注解
运行表示试验的单次试运行。 运行对象用于监视试用的异步执行、记录指标和存储试用的输出，以及分析结果和访问试用生成的项目。
在试验代码中使用运行将指标和项目记录到运行历史记录服务。
运行在试验之外用于监视进度以及查询和分析生成的指标和结果。
运行的功能包括：
存储和检索指标与数据
上传和下载文件
使用标记及子层次结构来轻松查找以往的运行
将存储的模型文件注册为可操作的模型
存储、修改和检索运行的属性
使用 get_context 方法从远程环境加载当前运行
有效地对文件或目录拍摄快照以实现可重复性
此类在以下情况下与 Experiment 一起使用：
通过使用 submit 执行代码来创建运行
使用 start_logging 在笔记本中以交互方式创建运行
在试验中记录指标和上传项目，例如在使用 log 时
在分析试验结果时读取指标和下载项目，例如在使用 get_metrics 时
若要提交运行，请创建一个描述如何运行试验的配置对象。 下面是可以使用的不同配置对象的示例：
azureml.train.automl.automlconfig.AutoMLConfig
azureml.train.hyperdrive.HyperDriveConfig
azureml.pipeline.core.Pipeline
azureml.pipeline.core.PublishedPipeline
azureml.pipeline.core.PipelineEndpoint
训练实验时可将以下指标添加到运行中。
Scalar
使用 log 将数值或字符串值记录到具有给定名称的运行中。 在运行中记录某个指标会导致在试验中的运行记录中存储该指标。 可在一次运行中多次记录同一指标，其结果被视为该指标的一个矢量。
示例：
run.log("accuracy", 0.95)
列表
使用 log_list 将值列表记录到具有给定名称的运行中。
示例：
run.log_list("accuracies", [0.6, 0.7, 0.87])
行
使用 log_row 创建包含多个列的指标，如
kwargs中所述。 每个命名的参数会生成一个具有指定值的列。 可调用log_row一次，记录一个任意元组，或在一个循环中调用多次，生成一个完整表格。示例：
run.log_row("Y over X", x=1, y=0.4)
表
使用 log_table 将字典对象记录到具有给定名称的运行中。
示例：
run.log_table("Y over X", {"x":[1, 2, 3], "y":[0.6, 0.7, 0.89]})
Image
将图像记录到运行记录中。 使用 log_image 在运行中记录图像文件或 matplotlib 图。 运行记录中可显示和比较这些图像。
示例：
run.log_image("ROC", path)
方法
| add_properties |
向运行添加不可变属性。 标签和属性（都是 dict[str, str]）的可变性不同。 属性是不可变的，因此它们将创建一条永久记录用于审核目的。 标记是可变的。 有关使用标记和属性的详细信息，请参阅标记和查找运行。 |
| add_type_provider |
存储在运行历史记录中的自定义运行类型的扩展性挂钩。 |
| cancel |
将运行标记为已取消。 如果存在设置了 cancel_uri 字段的关联作业，则也会终止该作业。 |
| child_run |
创建子运行。 |
| clean |
删除与运行配置中指定的目标上的当前运行对应的文件。 |
| complete |
等待任务队列得到处理。 然后，运行被标记为已完成。 这通常用于交互式笔记本方案。 |
| create_children |
创建一个或多个子运行。 |
| download_file |
从存储中下载关联的文件。 |
| download_files |
如果未指定前缀，则从给定的存储前缀（文件夹名称）或整个容器中下载文件。 |
| fail |
将运行标记为失败。 （可选）使用传递给 |
| flush |
等待任务队列得到处理。 |
| get |
获取此工作区的运行及其运行 ID。 |
| get_all_logs |
将运行的所有日志下载到目录。 |
| get_children |
获取由指定的筛选器选择的当前运行的所有子级。 |
| get_context |
返回当前服务上下文。 使用此方法检索当前服务上下文中的记录指标和上传文件。 如果 |
| get_detailed_status |
提取运行的最新状态。 如果运行的状态为“已排队”，则会显示详细信息。 |
| get_details |
获取运行的定义、状态信息、当前日志文件和其他详细信息。 |
| get_details_with_logs |
返回运行状态，包括日志文件内容。 |
| get_environment |
获取此运行使用的环境定义。 |
| get_file_names |
列出与运行关联中存储的文件。 |
| get_metrics |
检索记录到运行的指标。 如果 |
| get_properties |
从服务中提取运行的最新属性。 |
| get_secret |
从运行的上下文中获取机密值。 获取提供的名称的机密值。 机密名称引用存储在与工作区关联的 Azure Key Vault 中的值。 有关使用机密的示例，请参阅在训练运行中使用机密。 |
| get_secrets |
获取给定机密名称列表的机密值。 获取所提供名称列表的已找到和未找到机密的字典。 每个机密名称引用存储在与工作区关联的 Azure 密钥保管库中的值。 有关使用机密的示例，请参阅在训练运行中使用机密。 |
| get_snapshot_id |
获取最新的快照 ID。 |
| get_status |
提取运行的最新状态。 返回的常见值包括“正在运行”、“已完成”和“失败”。 |
| get_submitted_run |
已弃用。 使用 get_context。 获取此试验的已提交运行。 |
| get_tags |
从服务中提取运行上的最新可变标记集。 |
| list |
获取可选筛选器指定的试验中的运行列表。 |
| list_by_compute |
获取可选筛选器指定的计算中的运行列表。 |
| log |
使用给定名称在运行中记录指标值。 |
| log_accuracy_table |
将准确度表记录到项目存储。 准确度表指标是一种多用途的非标量指标，可用于生成多种类型的折线图，这些图在预测概率的空间内持续变化。 这些图的示例包括 ROC、精准率-召回率以及提升曲线。 准确度表的计算类似于 ROC 曲线的计算。 ROC 曲线将真正率和假正率存储在许多不同的概率阈值处。 准确度表将真正、假正、真负和假负的原始数量存储在许多不同的概率阈值处。 有两种方法用于选择阈值：“概率”和“百分位数”。它们的不同之处在于从预测概率空间中采样的方式。 概率阈值是 0 到 1 之间均匀间隔的阈值。 如果 NUM_POINTS 为 5，则概率阈值为 [0.0, 0.25, 0.5, 0.75, 1.0]。 百分位数阈值根据预测概率的分布进行间隔。 每个阈值对应于概率阈值处数据的百分位数。 例如，如果 NUM_POINTS 为 5，则第一个阈值将位于第 0 个百分位数处，第二个阈值位于第 25 个百分位数处，第三个阈值位于第 50 个百分位数处，以此类比。 概率表和百分位数表都是三维列表，其中第一个维度表示类标签，第二个维度表示一个阈值的样本（使用 NUM_POINTS 缩放），第三个维度始终有 4 个值：TP、FP、TN、FN，并且始终按该顺序显示。 混淆值（TP、FP、TN、FN）是使用一对多策略计算的。 请参阅以下链接了解更多详细信息：https://en.wikipedia.org/wiki/Multiclass_classification N = 验证数据集中的样本数（示例中为 200）M = 阈值数 = 从概率空间中获取的样本数（示例中为 5）C = 完整数据集中的类数（示例中为 3） 准确度表的一些不变量：
注意：M 可以是任何值并控制图表的分辨率。这独立于数据集，在计算指标时定义，并占用存储空间、计算时间和分辨率。 类标签应为字符串，混淆值应为整数，阈值应为浮点数。 |
| log_confusion_matrix |
将混淆矩阵记录到项目存储。 这会记录围绕 sklearn 混淆矩阵的包装器。 指标数据包含矩阵本身的类标签和二维列表。 有关如何计算指标的更多详细信息，请参阅以下链接：https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html |
| log_image |
在运行记录中记录图像指标。 |
| log_list |
使用给定名称将指标值的列表记录到运行中。 |
| log_predictions |
将预测记录到项目存储。 这会记录指标分数，该分数可用于将真实目标值的分布与回归任务的预测值的分布进行比较。 预测是分箱的，标准偏差是针对折线图上的误差条计算的。 |
| log_residuals |
将残差记录到项目存储。 这会记录显示回归任务残差直方图所需的数据。 残差是预测值与实际值之差。 应比计数的数量多一个边。 有关使用计数和边表示直方图的示例，请参阅 numpy 直方图文档。 https://docs.scipy.org/doc/numpy/reference/generated/numpy.histogram.html |
| log_row |
使用给定名称在运行中记录行指标。 |
| log_table |
使用给定名称在运行中记录表格指标。 |
| register_model |
注册模型以用于操作化。 |
| remove_tags |
删除此运行上可变标记的列表。 |
| restore_snapshot |
将快照还原为 ZIP 文件。 返回 ZIP 的路径。 |
| set_tags |
在运行上添加或修改一组标记。 未在字典中传递的标记保持不变。 还可以添加简单的字符串标记。 当这些标记作为键出现在标记字典中时，它们的值为“无”。 有关详细信息，请参阅标记和查找运行。 |
| start |
将运行标记为已启动。 当运行已由另一个行动者创建时，这通常用于高级方案。 |
| submit_child |
提交试验并返回活动子运行。 |
| tag |
使用一个字符串键和可选字符串值标记运行。 |
| take_snapshot |
保存输入文件或文件夹的快照。 |
| upload_file |
将文件上传到运行记录。 |
| upload_files |
将文件上传到运行记录。 |
| upload_folder |
将指定的文件夹上传到给定的前缀名称。 |
| wait_for_completion |
等待此运行完成。 返回等待后的状态对象。 |
add_properties
向运行添加不可变属性。
标签和属性（都是 dict[str, str]）的可变性不同。 属性是不可变的，因此它们将创建一条永久记录用于审核目的。 标记是可变的。 有关使用标记和属性的详细信息，请参阅标记和查找运行。
add_properties(properties)参数
add_type_provider
存储在运行历史记录中的自定义运行类型的扩展性挂钩。
static add_type_provider(runtype, run_factory)参数
- run_factory
- <xref:function>
具有签名的函数 (Experiment, RunDto) -> 列出运行时要调用的运行。
cancel
将运行标记为已取消。
如果存在设置了 cancel_uri 字段的关联作业，则也会终止该作业。
cancel()child_run
创建子运行。
child_run(name=None, run_id=None, outputs=None)参数
返回
子运行。
返回类型
注解
这用于将运行的一部分隔离到子部分中。 这可以针对运行的可识别“部分”来完成，这些“部分”有利于分离，或捕获跨子过程交互的独立指标。
如果为子运行设置了输出目录，该目录的内容将在子级完成后上传到子运行记录。
clean
complete
等待任务队列得到处理。
然后，运行被标记为已完成。 这通常用于交互式笔记本方案。
complete(_set_status=True)参数
create_children
创建一个或多个子运行。
create_children(count=None, tag_key=None, tag_values=None)参数
- tag_Values
可选值列表，这些值将映射到创建的运行列表的 Tags[tag_key] 上。
- tag_values
返回
子运行的列表。
返回类型
注解
必须指定参数 count 或参数 tag_key 和 tag_values。
download_file
从存储中下载关联的文件。
download_file(name, output_file_path=None, _validate_checksum=False)参数
download_files
如果未指定前缀，则从给定的存储前缀（文件夹名称）或整个容器中下载文件。
download_files(prefix=None, output_directory=None, output_paths=None, batch_size=100, append_prefix=True, timeout_seconds=None)参数
fail
将运行标记为失败。
（可选）使用传递给 error_details 的消息或异常设置运行的 Error 属性。
fail(error_details=None, error_code=None, _set_status=True)参数
flush
get
获取此工作区的运行及其运行 ID。
static get(workspace, run_id)参数
返回
提交的运行。
返回类型
get_all_logs
将运行的所有日志下载到目录。
get_all_logs(destination=None)参数
返回
已下载日志的名称列表。
返回类型
get_children
获取由指定的筛选器选择的当前运行的所有子级。
get_children(recursive=False, tags=None, properties=None, type=None, status=None, _rehydrate_runs=True)参数
返回
Run 对象的列表。
返回类型
get_context
返回当前服务上下文。
使用此方法检索当前服务上下文中的记录指标和上传文件。 如果 allow_offline 为 True（默认值），则针对运行对象的操作将打印到标准输出。
get_context(allow_offline=True, used_for_context_manager=False, **kwargs)参数
- cls
指示类方法。
- used_for_context_manager
返回
提交的运行。
返回类型
注解
此函数通常用于检索脚本内经过身份验证的运行对象，以通过experiment.submit() 提交执行。 此运行对象既是与 Azure 机器学习服务通信的经过身份验证的上下文，也是包含指标、文件（项目）和模型的概念容器。
run = Run.get_context() # allow_offline=True by default, so can be run locally as well
...
run.log("Accuracy", 0.98)
run.log_row("Performance", epoch=e, error=err)
get_detailed_status
提取运行的最新状态。 如果运行的状态为“已排队”，则会显示详细信息。
get_detailed_status()返回
最新状态和详细信息
返回类型
注解
状态：运行的当前状态。 与 get_status() 返回的值相同。
详细信息：当前状态的详细信息。
run = experiment.submit(config)
details = run.get_detailed_status()
# details = {
# 'status': 'Queued',
# 'details': 'Run requested 1 node(s). Run is in pending status.',
# }
get_details
获取运行的定义、状态信息、当前日志文件和其他详细信息。
get_details()返回
返回运行的详细信息
返回类型
注解
返回的字典包含以下键值对：
runId：此运行的 ID。
目标
状态：运行的当前状态。 与 get_status() 返回的值相同。
startTimeUtc：启动此运行的 UTC 时间，采用 ISO8601。
endTimeUtc：完成此运行的 UTC 时间（已完成或失败），采用 ISO8601。
如果运行仍在进行，则此键不存在。
属性：与运行关联的不可变键值对。 默认属性包括运行的快照 ID 和有关从中创建运行的 git 存储库的信息（如果有）。 可以使用 add_properties 将其他属性添加到运行中。
inputDatasets：与运行关联的输入数据集。
inputDatasets：与运行关联的输入数据集。
logFiles
submittedBy
run = experiment.start_logging()
details = run.get_details()
# details = {
# 'runId': '5c24aa28-6e4a-4572-96a0-fb522d26fe2d',
# 'target': 'sdk',
# 'status': 'Running',
# 'startTimeUtc': '2019-01-01T13:08:01.713777Z',
# 'endTimeUtc': '2019-01-01T17:15:65.986253Z',
# 'properties': {
# 'azureml.git.repository_uri': 'https://example.com/my/git/repo',
# 'azureml.git.branch': 'master',
# 'azureml.git.commit': '7dc972657c2168927a02c3bc2b161e0f370365d7',
# 'azureml.git.dirty': 'True',
# 'mlflow.source.git.repoURL': 'https://example.com/my/git/repo',
# 'mlflow.source.git.branch': 'master',
# 'mlflow.source.git.commit': '7dc972657c2168927a02c3bc2b161e0f370365d7',
# 'ContentSnapshotId': 'b4689489-ce2f-4db5-b6d7-6ad11e77079c'
# },
# 'inputDatasets': [{
# 'dataset': {'id': 'cdebf245-701d-4a68-8055-41f9cf44f298'},
# 'consumptionDetails': {
# 'type': 'RunInput',
# 'inputName': 'training-data',
# 'mechanism': 'Mount',
# 'pathOnCompute': '/mnt/datasets/train'
# }
# }],
# 'outputDatasets': [{
# 'dataset': {'id': 'd04e8a19-1caa-4b1f-b318-4cbff9af9615'},
# 'outputType': 'RunOutput',
# 'outputDetails': {
# 'outputName': 'training-result'
# }
# }],
# 'runDefinition': {},
# 'logFiles': {},
# 'submittedBy': 'Alan Turing'
# }
get_details_with_logs
get_environment
get_file_names
get_metrics
检索记录到运行的指标。
如果 recursive 为 True（默认值为 False），则提取给定运行的子树中运行的指标。
get_metrics(name=None, recursive=False, run_type=None, populate=False)参数
- run_type
- str
返回
包含用户指标的字典。
返回类型
注解
run = experiment.start_logging() # run id: 123
run.log("A", 1)
with run.child_run() as child: # run id: 456
child.log("A", 2)
metrics = run.get_metrics()
# metrics = { 'A': 1 }
metrics = run.get_metrics(recursive=True)
# metrics = { '123': { 'A': 1 }, '456': { 'A': 2 } } note key is runId
get_properties
从服务中提取运行的最新属性。
get_properties()返回
运行的属性。
返回类型
注解
属性是系统生成的不可变信息，例如使用 add_properties 方法添加的持续时间、执行日期、用户和自定义属性。 有关详细信息，请参阅标记和查找运行。
在向 Azure 机器学习提交作业时，如果源文件存储在本地 git 存储库中，则有关存储库的信息将存储为属性。 创建运行或调用 Experiment.submit 时，将添加这些 git 属性。 有关 git 属性的详细信息，请参阅 Azure 机器学习的 Git 集成。
get_secret
从运行的上下文中获取机密值。
获取提供的名称的机密值。 机密名称引用存储在与工作区关联的 Azure Key Vault 中的值。 有关使用机密的示例，请参阅在训练运行中使用机密。
get_secret(name)参数
返回
机密值。
返回类型
get_secrets
获取给定机密名称列表的机密值。
获取所提供名称列表的已找到和未找到机密的字典。 每个机密名称引用存储在与工作区关联的 Azure 密钥保管库中的值。 有关使用机密的示例，请参阅在训练运行中使用机密。
get_secrets(secrets)参数
返回
返回已找到和未找到的机密的字典。
返回类型
get_snapshot_id
get_status
提取运行的最新状态。
返回的常见值包括“正在运行”、“已完成”和“失败”。
get_status()返回
最新状态。
返回类型
注解
未启动 - 这是客户端运行对象在云提交之前所处的临时状态。
正在启动 - 运行已开始在云中处理。 调用方此时具有运行 ID。
正在预配 - 在为给定的作业提交创建按需计算时返回。
正在准备 - 正在准备运行环境：
Docker 映像生成
Conda 环境设置
已排队 - 作业已在计算目标中排队。 例如，在 BatchAI 中，作业处于已排队状态
等待所有请求的节点准备就绪时。
正在运行 - 作业已开始在计算目标中运行。
正在完成 - 用户代码已完成，并且运行处于后期处理阶段。
已请求取消 - 已请求取消作业。
已完成 - 运行已成功完成。 这包括用户代码和运行
后期处理阶段。
失败 - 运行失败。 通常，运行上的 Error 属性会提供有关原因的详细信息。
已取消 - 遵循取消请求并指示运行现已成功取消。
未响应 - 对于启用了检测信号的运行，最近未发送任何检测信号。
run = experiment.submit(config)
while run.get_status() not in ['Completed', 'Failed']: # For example purposes only, not exhaustive
print('Run {} not in terminal state'.format(run.id))
time.sleep(10)
get_submitted_run
get_tags
list
获取可选筛选器指定的试验中的运行列表。
static list(experiment, type=None, tags=None, properties=None, status=None, include_children=False, _rehydrate_runs=True)参数
返回
运行的列表。
返回类型
注解
下面的代码示例演示 list 方法的一些用法。
favorite_completed_runs = Run.list(experiment, status='Completed', tags='favorite')
all_distinct_runs = Run.list(experiment)
and_their_children = Run.list(experiment, include_children=True)
only_script_runs = Run.list(experiment, type=ScriptRun.RUN_TYPE)
list_by_compute
获取可选筛选器指定的计算中的运行列表。
static list_by_compute(compute, type=None, tags=None, properties=None, status=None)参数
返回
~_restclient.models.RunDto 的生成器
返回类型
log
使用给定名称在运行中记录指标值。
log(name, value, description='', step=None)参数
- value
要发布给服务的值。
注解
在运行中记录某个指标会导致在试验中的运行记录中存储该指标。 可在一次运行中多次记录同一指标，其结果被视为该指标的一个矢量。 如果为指标指定了步骤，必须为所有值指定该步骤。
log_accuracy_table
将准确度表记录到项目存储。
准确度表指标是一种多用途的非标量指标，可用于生成多种类型的折线图，这些图在预测概率的空间内持续变化。 这些图的示例包括 ROC、精准率-召回率以及提升曲线。
准确度表的计算类似于 ROC 曲线的计算。 ROC 曲线将真正率和假正率存储在许多不同的概率阈值处。 准确度表将真正、假正、真负和假负的原始数量存储在许多不同的概率阈值处。
有两种方法用于选择阈值：“概率”和“百分位数”。它们的不同之处在于从预测概率空间中采样的方式。
概率阈值是 0 到 1 之间均匀间隔的阈值。 如果 NUM_POINTS 为 5，则概率阈值为 [0.0, 0.25, 0.5, 0.75, 1.0]。
百分位数阈值根据预测概率的分布进行间隔。 每个阈值对应于概率阈值处数据的百分位数。 例如，如果 NUM_POINTS 为 5，则第一个阈值将位于第 0 个百分位数处，第二个阈值位于第 25 个百分位数处，第三个阈值位于第 50 个百分位数处，以此类比。
概率表和百分位数表都是三维列表，其中第一个维度表示类标签，第二个维度表示一个阈值的样本（使用 NUM_POINTS 缩放），第三个维度始终有 4 个值：TP、FP、TN、FN，并且始终按该顺序显示。
混淆值（TP、FP、TN、FN）是使用一对多策略计算的。 请参阅以下链接了解更多详细信息：https://en.wikipedia.org/wiki/Multiclass_classification
N = 验证数据集中的样本数（示例中为 200）M = 阈值数 = 从概率空间中获取的样本数（示例中为 5）C = 完整数据集中的类数（示例中为 3）
准确度表的一些不变量：
- 所有类的所有阈值的 TP + FP + TN + FN = N
- TP + FN 在任何类的所有阈值处都是相同的
- TN + FP 在任何类的所有阈值处都是相同的
- 概率表和百分位数表的形状为 [C, M, 4]
注意：M 可以是任何值并控制图表的分辨率。这独立于数据集，在计算指标时定义，并占用存储空间、计算时间和分辨率。
类标签应为字符串，混淆值应为整数，阈值应为浮点数。
log_accuracy_table(name, value, description='')参数
注解
有效 JSON 值的示例：
{
"schema_type": "accuracy_table",
"schema_version": "1.0.1",
"data": {
"probability_tables": [
[
[82, 118, 0, 0],
[75, 31, 87, 7],
[66, 9, 109, 16],
[46, 2, 116, 36],
[0, 0, 118, 82]
],
[
[60, 140, 0, 0],
[56, 20, 120, 4],
[47, 4, 136, 13],
[28, 0, 140, 32],
[0, 0, 140, 60]
],
[
[58, 142, 0, 0],
[53, 29, 113, 5],
[40, 10, 132, 18],
[24, 1, 141, 34],
[0, 0, 142, 58]
]
],
"percentile_tables": [
[
[82, 118, 0, 0],
[82, 67, 51, 0],
[75, 26, 92, 7],
[48, 3, 115, 34],
[3, 0, 118, 79]
],
[
[60, 140, 0, 0],
[60, 89, 51, 0],
[60, 41, 99, 0],
[46, 5, 135, 14],
[3, 0, 140, 57]
],
[
[58, 142, 0, 0],
[56, 93, 49, 2],
[54, 47, 95, 4],
[41, 10, 132, 17],
[3, 0, 142, 55]
]
],
"probability_thresholds": [0.0, 0.25, 0.5, 0.75, 1.0],
"percentile_thresholds": [0.0, 0.01, 0.24, 0.98, 1.0],
"class_labels": ["0", "1", "2"]
}
}
log_confusion_matrix
将混淆矩阵记录到项目存储。
这会记录围绕 sklearn 混淆矩阵的包装器。 指标数据包含矩阵本身的类标签和二维列表。 有关如何计算指标的更多详细信息，请参阅以下链接：https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html
log_confusion_matrix(name, value, description='')参数
注解
有效 JSON 值的示例：
{
"schema_type": "confusion_matrix",
"schema_version": "1.0.0",
"data": {
"class_labels": ["0", "1", "2", "3"],
"matrix": [
[3, 0, 1, 0],
[0, 1, 0, 1],
[0, 0, 1, 0],
[0, 0, 0, 1]
]
}
}
log_image
在运行记录中记录图像指标。
log_image(name, path=None, plot=None, description='')参数
- plot
- <xref:matplotlib.pyplot>
要记录为图像的绘图。
注解
使用此方法在运行中记录图像文件或 matplotlib 绘图。 运行记录中可显示和比较这些图像。
log_list
使用给定名称将指标值的列表记录到运行中。
log_list(name, value, description='')参数
log_predictions
将预测记录到项目存储。
这会记录指标分数，该分数可用于将真实目标值的分布与回归任务的预测值的分布进行比较。
预测是分箱的，标准偏差是针对折线图上的误差条计算的。
log_predictions(name, value, description='')参数
注解
有效 JSON 值的示例：
{
"schema_type": "predictions",
"schema_version": "1.0.0",
"data": {
"bin_averages": [0.25, 0.75],
"bin_errors": [0.013, 0.042],
"bin_counts": [56, 34],
"bin_edges": [0.0, 0.5, 1.0]
}
}
log_residuals
将残差记录到项目存储。
这会记录显示回归任务残差直方图所需的数据。 残差是预测值与实际值之差。
应比计数的数量多一个边。 有关使用计数和边表示直方图的示例，请参阅 numpy 直方图文档。 https://docs.scipy.org/doc/numpy/reference/generated/numpy.histogram.html
log_residuals(name, value, description='')参数
注解
有效 JSON 值的示例：
{
"schema_type": "residuals",
"schema_version": "1.0.0",
"data": {
"bin_edges": [50, 100, 200, 300, 350],
"bin_counts": [0.88, 20, 30, 50.99]
}
}
log_row
使用给定名称在运行中记录行指标。
log_row(name, description=None, **kwargs)参数
注解
使用 log_row 创建包含列的表指标，如 kwargs 中所述。 每个命名的参数会生成一个具有指定值的列。 可调用 log_row 一次，记录任意元组，或在循环中调用多次，生成完整表格。
citrus = ['orange', 'lemon', 'lime']
sizes = [ 10, 7, 3]
for index in range(len(citrus)):
run.log_row("citrus", fruit = citrus[index], size=sizes[index])
log_table
使用给定名称在运行中记录表格指标。
log_table(name, value, description='')参数
register_model
注册模型以用于操作化。
register_model(model_name, model_path=None, tags=None, properties=None, model_framework=None, model_framework_version=None, description=None, datasets=None, sample_input_dataset=None, sample_output_dataset=None, resource_configuration=None, **kwargs)参数
返回
已注册的模型。
返回类型
注解
model = best_run.register_model(model_name = 'best_model', model_path = 'outputs/model.pkl')
remove_tags
restore_snapshot
将快照还原为 ZIP 文件。 返回 ZIP 的路径。
restore_snapshot(snapshot_id=None, path=None)参数
返回
路径。
返回类型
set_tags
在运行上添加或修改一组标记。 未在字典中传递的标记保持不变。
还可以添加简单的字符串标记。 当这些标记作为键出现在标记字典中时，它们的值为“无”。 有关详细信息，请参阅标记和查找运行。
set_tags(tags)参数
start
将运行标记为已启动。
当运行已由另一个行动者创建时，这通常用于高级方案。
start()submit_child
提交试验并返回活动子运行。
submit_child(config, tags=None, **kwargs)参数
返回
运行对象。
返回类型
注解
提交是对 Azure 机器学习平台的异步调用，用于在本地或远程硬件上执行试运行。 根据配置，提交将自动准备执行环境、执行代码，以及将源代码和结果捕获到试验的运行历史记录中。
若要提交试验，首先需要创建描述试验运行方法的配置对象。 该配置取决于所需的试用类型。
如何使用 ScriptRunConfig 从本地计算机提交子试验的示例如下所示：
from azureml.core import ScriptRunConfig
# run a trial from the train.py code in your current directory
config = ScriptRunConfig(source_directory='.', script='train.py',
run_config=RunConfiguration())
run = parent_run.submit_child(config)
# get the url to view the progress of the experiment and then wait
# until the trial is complete
print(run.get_portal_url())
run.wait_for_completion()
有关如何配置运行的详细信息，请参阅 submit。
tag
使用一个字符串键和可选字符串值标记运行。
tag(key, value=None)参数
注解
运行中的标记和属性都是字符串 -> 字符串的字典。 它们之间的区别在于可变性：可以设置、更新和删除标记，但只能添加属性。 这使得属性更适用于系统/工作流相关的行为触发器，而标记通常是面向用户的并且对试验使用者有意义。
run = experiment.start_logging()
run.tag('DeploymentCandidate')
run.tag('modifiedBy', 'Master CI')
run.tag('modifiedBy', 'release pipeline') # Careful, tags are mutable
run.add_properties({'BuildId': os.environ.get('VSTS_BUILD_ID')}) # Properties are not
tags = run.get_tags()
# tags = { 'DeploymentCandidate': None, 'modifiedBy': 'release pipeline' }
take_snapshot
保存输入文件或文件夹的快照。
take_snapshot(file_or_folder_path)参数
返回
返回快照 ID。
返回类型
注解
快照旨在成为用于执行试验运行的源代码。 这些内容与运行一起存储，以便将来可以复制运行试用。
注意
调用 submit 时，会自动拍摄快照。 通常，只有交互式（笔记本）运行才需要 take_snapshot 方法。
upload_file
将文件上传到运行记录。
upload_file(name, path_or_stream, datastore_name=None)参数
返回类型
注解
run = experiment.start_logging()
run.upload_file(name='important_file', path_or_stream="path/on/disk/file.txt")
注意
在指定输出目录中自动运行捕获文件，对于大多数运行类型，该目录默认为 "./outputs"。 仅当需要上传其他文件或未指定输出目录时使用 upload_file。
upload_files
将文件上传到运行记录。
upload_files(names, paths, return_artifacts=False, timeout_seconds=None, datastore_name=None)参数
注解
upload_files 对单独文件具有与 upload_file 相同的效果，但是使用 upload_files 时，具有性能和资源利用率优势。
import os
run = experiment.start_logging()
file_name_1 = 'important_file_1'
file_name_2 = 'important_file_2'
run.upload_files(names=[file_name_1, file_name_2],
paths=['path/on/disk/file_1.txt', 'other/path/on/disk/file_2.txt'])
run.download_file(file_name_1, 'file_1.txt')
os.mkdir("path") # The path must exist
run.download_file(file_name_2, 'path/file_2.txt')
注意
在指定输出目录中自动运行捕获文件，对于大多数运行类型，该目录默认为“./outputs”。 仅当需要上传其他文件或未指定输出目录时使用 upload_file。
upload_folder
将指定的文件夹上传到给定的前缀名称。
upload_folder(name, path, datastore_name=None)参数
注解
run = experiment.start_logging()
run.upload_folder(name='important_files', path='path/on/disk')
run.download_file('important_files/existing_file.txt', 'local_file.txt')
注意
在指定输出目录中自动运行捕获文件，对于大多数运行类型，该目录默认为“./outputs”。 仅当需要上传其他文件或未指定输出目录时使用 upload_folder。
wait_for_completion
等待此运行完成。 返回等待后的状态对象。
wait_for_completion(show_output=False, wait_post_processing=False, raise_on_error=True)参数
返回
状态对象。
返回类型
属性
description
display_name
experiment
id
name
number
parent
从服务中提取此运行的父级运行。
运行可以具有可选的父级，从而生成运行的潜在树层次结构。 若要将指标记录到父级运行，请使用父级对象的 log 方法，例如 run.parent.log()。
返回
父级运行或无（如果未设置父级运行）。
返回类型
properties
status
返回运行对象的状态。
tags
type
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈