Run 类

将不可变属性添加到运行中。

标记和属性（两个 dict[str， str]）在可变性上有所不同。 属性是不可变的，因此它们将创建一条永久记录用于审核目的。 标记是可变的。 有关使用标记和属性的详细信息，请参阅 标记和查找运行。

add_properties(properties)

参数

在运行历史记录中存储的自定义运行类型的扩展性挂钩。

static add_type_provider(runtype, run_factory)

参数

将运行标记为已取消。

如果有一个关联的作业与一组cancel_uri字段，则也会终止该作业。

cancel()

创建子运行。

child_run(name=None, run_id=None, outputs=None)

参数

返回

注解

这用于隔离子部分的运行部分。 这可以为运行中有趣的可识别的“部件”完成此作，或者捕获子进程间的独立指标。

如果为子运行设置了输出目录，则子运行完成后，该目录的内容将上传到子运行记录。

删除与在运行配置中指定的目标上运行对应的文件。

clean()

返回

等待处理任务队列。

然后运行标记为已完成。 这通常用于交互式笔记本方案。

complete(_set_status=True)

参数

创建一个或多个子运行。

create_children(count=None, tag_key=None, tag_values=None)

参数

返回

注解

必须指定参数 count OR 参数 tag_key AND tag_values 。

从存储下载关联的文件。

download_file(name, output_file_path=None, _validate_checksum=False)

参数

如果未指定前缀，请从给定存储前缀（文件夹名称）或整个容器下载文件。

download_files(prefix=None, output_directory=None, output_paths=None, batch_size=100, append_prefix=True, timeout_seconds=None)

参数

将运行标记为失败。

（可选）使用传递给 error_details的消息或异常设置运行的 Error 属性。

fail(error_details=None, error_code=None, _set_status=True)

参数

等待处理任务队列。

flush(timeout_seconds=300)

参数

获取此工作区的运行 ID。

static get(workspace, run_id)

参数

返回

将运行的所有日志下载到目录。

get_all_logs(destination=None)

参数

返回

获取指定筛选器选择的当前运行的所有子级。

get_children(recursive=False, tags=None, properties=None, type=None, status=None, _rehydrate_runs=True)

参数

返回

返回当前服务上下文。

使用此方法检索用于记录指标和上传文件的当前服务上下文。 如果 allow_offline 为 True（默认值），则针对 Run 对象的作将打印为标准输出。

get_context(allow_offline=True, used_for_context_manager=False, **kwargs)

参数

返回

注解

此函数通常用于检索脚本中经过身份验证的 Run 对象，以便通过 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()

返回

注解

• 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()

返回

注解

返回的字典包含以下键值对：

• runId：此运行的 ID。

• 目标

• status：运行当前状态。 与从 get_status（） 返回的值相同。

• startTimeUtc：启动此运行的 UTC 时间，ISO8601。

• endTimeUtc：ISO8601中完成此运行（已完成或失败）的 UTC 时间。

  如果运行仍在进行中，则此键不存在。

• 属性：与运行关联的不可变键值对。 默认属性包括运行快照 ID 以及有关从中创建运行（如果有）的 git 存储库的信息。 可以使用 将其他属性添加到运行 中。

• inputDatasets：与运行关联的输入数据集。

• outputDatasets：输出与运行关联的数据集。

• 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()

返回

检索记录到运行的指标。

如果 recursive 为 True（默认值为 False），则提取给定运行子树中运行的指标。

get_metrics(name=None, recursive=False, run_type=None, populate=False)

参数

返回

注解

   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()

返回

注解

属性是系统生成的不可变信息，例如持续时间、执行日期、用户和随该方法添加的 add_properties 自定义属性。 有关详细信息，请参阅 标记和查找运行。

将作业提交到 Azure 机器学习时，如果源文件存储在本地 git 存储库中，则有关存储库的信息将存储为属性。 创建运行或调用 Experiment.submit 时会添加这些 git 属性。 有关 git 属性的详细信息，请参阅 Azure 机器学习的 Git 集成。

从运行的上下文中获取机密值。

获取提供的名称的机密值。 机密名称引用与工作区关联的 Azure Key Vault 中存储的值。 有关使用机密的示例，请参阅 在训练运行中使用机密。

get_secret(name)

参数

返回

获取给定机密名称列表的机密值。

获取所提供名称列表的已找到和未找到机密的字典。 每个机密名称引用与工作区关联的 Azure Key Vault 中存储的值。 有关使用机密的示例，请参阅 在训练运行中使用机密。

get_secrets(secrets)

参数

返回

获取最新的快照 ID。

get_snapshot_id()

返回

获取运行的最新状态。

返回的常见值包括“Running”、“Completed”和“Failed”。

get_status()

返回

注解

• NotStarted - 这是云提交之前客户端运行对象的临时状态。

• 正在启动 - 运行已开始在云中进行处理。 此时，调用方具有运行 ID。

• 预配 - 在为给定作业提交创建按需计算时返回。

• 准备 - 正在准备运行环境：

  • docker 映像生成

  • conda 环境设置

• 已排队 - 作业在计算目标中排队。 例如，在 BatchAI 中，作业处于排队状态

  同时等待所有请求的节点准备就绪。

• 正在运行 - 作业开始在计算目标中运行。

• 完成 - 用户代码已完成，运行处于处理后阶段。

• CancelRequested - 已请求取消作业。

• 已完成 - 运行成功完成。 这包括用户代码和运行

  后处理阶段。

• 失败 - 运行失败。 通常，运行中的 Error 属性将提供原因的详细信息。

• 已取消 - 遵循取消请求，并指示运行现已成功取消。

• NotResponding - 对于启用了检测信号的运行，最近未发送检测信号。

   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_context。

获取此试验的提交运行。

get_submitted_run(**kwargs)

返回

从服务获取运行中的最新可变标记集。

get_tags()

返回

获取可选筛选器指定的试验中的运行列表。

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)

获取由可选筛选器指定的计算中的运行列表。

static list_by_compute(compute, type=None, tags=None, properties=None, status=None)

参数

返回

使用给定名称将指标值记录到运行。

log(name, value, description='', step=None)

参数

注解

将指标记录到运行会导致该指标存储在试验中的运行记录中。 可以在运行中多次记录相同的指标，结果被视为该指标的向量。 如果为指标指定了步骤，则必须为所有值指定该步骤。

将准确性表记录到项目存储。

准确性表指标是一种多用途的非标量指标，可用于生成多种类型的折线图，这些折线图因预测概率的空间而不断变化。 这些图表的示例包括 ROC、精度召回率和提升曲线。

准确性表的计算类似于 ROC 曲线的计算。 ROC 曲线以许多不同的概率阈值存储真正率和误报率。 准确性表存储许多概率阈值下的真实正数、误报、真负数和假负数。

有两种方法用于选择阈值：“probability”和“percentile”。它们与预测概率空间的采样方式不同。

概率阈值在 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 in example） C = # 类的完整数据集 （示例 3 in example）

准确性表的一些固定项：

• 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"]
       }
   }

将混淆矩阵记录到项目存储。

这会记录 sklearn 混淆矩阵周围的包装器。 指标数据包含矩阵本身的类标签和 2D 列表。 有关如何计算指标的详细信息，请参阅以下链接： 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(name, path=None, plot=None, description='')

参数

注解

使用此方法将图像文件或 matplotlib 绘图 记录到运行中。 这些图像将在运行记录中可见和可比较。

使用给定名称将指标值列表记录到运行。

log_list(name, value, description='')

参数

将预测记录到项目存储。

这会记录一个指标分数，该分数可用于将真实目标值的分布与回归任务的预测值的分布进行比较。

预测是装箱的，为折线图上的误差线计算标准偏差。

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]
       }
   }

将残差记录到项目存储。

这会记录显示回归任务的残差直方图所需的数据。 预测残差 - 实际。

应该有一个比计数数更多的边缘。 有关使用计数和边缘来表示直方图的示例，请参阅 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(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(name, value, description='')

参数

注册用于作化的模型。

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(tags)

参数

返回

将快照还原为 ZIP 文件。 返回 ZIP 的路径。

restore_snapshot(snapshot_id=None, path=None)

参数

返回

在运行时添加或修改一组标记。 未在字典中传递的标记保持不变。

还可以添加简单的字符串标记。 当这些标记作为键出现在标记字典中时，它们的值为 None。 有关详细信息，请参阅 标记和查找运行。

set_tags(tags)

参数

将运行标记为已启动。

当运行由另一个执行组件创建时，这通常用于高级方案。

start()

提交试验并返回活动子运行。

submit_child(config, tags=None, **kwargs)

参数

返回

注解

Submit 是对 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(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(file_or_folder_path)

参数

返回

注解

快照旨在用作用于执行试验运行的 源代码 。 这些内容随运行一起存储，以便将来可以复制运行试用版。

将文件上传到运行记录。

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")

将文件上传到运行记录。

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')

将指定的文件夹上传到给定的前缀名称。

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')

等待此运行完成。 返回等待后的状态对象。

wait_for_completion(show_output=False, wait_post_processing=False, raise_on_error=True)

参数

返回

返回运行说明。

运行的可选说明是一个用户指定的字符串，可用于描述运行。

返回

返回运行显示名称。

运行的可选显示名称是一个用户指定的字符串，可用于以后标识运行。

返回

获取包含运行的试验。

返回

获取运行 ID。

运行 ID 是包含试验中唯一的标识符。

返回

荒废的。 使用display_name。

运行的可选名称是一个用户指定的字符串，可用于以后标识运行。

返回

获取运行编号。

一个单调递增的数字，表示试验中的运行顺序。

返回

从服务中提取此运行的父运行。

运行可以具有可选的父级，从而导致潜在的运行树层次结构。 若要将指标记录到父运行，请使用 log 父对象的方法， run.parent.log()例如。

返回

返回此运行的不可变属性。

返回

注解

属性包括不可变的系统生成信息，例如持续时间、执行日期、用户等。

返回运行对象的状态。

返回此运行中的可变标记集。

返回

获取运行类型。

指示如何创建或配置运行。

返回