InputModel

class InputModel(model_id=None, name=None, project=None, tags=None, only_published=False)

加载系统中现有的模型，通过模型 ID 搜索。该模型将是只读的，可用于预初始化网络。我们可以将模型连接到任务作为输入模型，然后在远程运行时通过 UI 覆盖它。

从模型仓库加载模型，基于 model_id (uuid) 或模型名称/项目/标签组合。

参数
- model_id (Optional[str]) – 输入模型的 ClearML ID (系统 UUID)，其元数据存储在 ClearML Server（后端）。如果提供了此参数，则忽略所有其他参数
- name (Optional[str]) – 要搜索和加载的模型名称
- project (Optional[str]) – 要在其中搜索模型的项目名称
- tags (Optional[Sequence[str]]) – 用于过滤的模型标签列表
- only_published (bool) – 如果为 True，则过滤掉未发布的（草稿）模型
返回类型

None

comment

property comment: str

模型的评论。也可用于模型描述。

返回类型

str
返回

模型评论/描述。

config_dict

property config_dict: dict

配置作为字典，从设计文本中解析。这通常代表模型配置。例如，prototxt、ini 文件或要评估的 Python 代码。

返回类型

dict
返回

配置。

config_text

property config_text: str

配置作为字符串。例如，prototxt、ini 文件或要评估的 Python 代码。

返回类型

str
返回

配置。

connect

connect(task, name=None, ignore_remote_overrides=False)

将当前模型连接到 Task 对象（如果模型是预先存在的）。预先存在的模型包括

导入的模型（使用 Logger.import_model 方法创建的 InputModel 对象）。
元数据已在 ClearML 平台中的模型，这意味着 InputModel 对象是使用 InputModel 类实例化，并指定模型的 ClearML ID 作为参数。
非 ClearML 来源的模型，用于创建 InputModel 对象。例如，使用 TensorFlow 模型创建的模型。

当实验在 worker 中远程执行时，使用实验 UI/后端中指定的输入模型，除非将 ignore_remote_overrides 设置为 True。

信息

ClearML Web-App 允许您将一个输入模型切换为另一个，然后将实验排队以便在 worker 中执行。

参数
- task (object ) – Task 对象。
- ignore_remote_overrides (bool) – 如果为 True，则在远程运行时，更改 UI/后端中的模型将无效。默认值为 False，表示 UI/后端中的任何更改将在远程执行中应用。
- name (str ) – 要存储在 Task 上的模型名称（默认使用模型权重的文件名，不含文件扩展名；如果找不到，则使用 Input Model）
返回类型

None

InputModel.empty

classmethod empty(config_text=None, config_dict=None, label_enumeration=None)

创建一个空模型对象。稍后，您可以将模型分配给空模型对象。

参数
- config_text (unconstrained text string ) – 模型配置作为字符串。这通常是配置字典文件的内容。指定 config_text 或 config_dict，但不能同时指定两者。
- config_dict (dict ) – 模型配置作为字典。指定 config_text 或 config_dict，但不能同时指定两者。
- label_enumeration (dict ) – 字符串（标签）到整数（值）对的标签枚举字典。（可选）
例如
```
{
     "background": 0,
     "person": 1
}
```
返回类型

InputModel
返回

一个空模型对象。

framework

property framework: str

模型的机器学习框架（例如：PyTorch、TensorFlow、XGBoost 等）。

返回类型

str
返回

模型的框架

get_all_metadata

get_all_metadata()

如果您希望将值强制转换为其类型（如果可能），请参阅 Model.get_all_metadata_casted

返回类型

Dict[str, Dict[str, str]]
返回

将所有元数据作为 Dict[key, Dict[value, type]] 格式的字典获取。key、value 和 type 条目均为字符串。请注意，每个条目可能包含一个附加的“key”条目，重复该键

get_all_metadata_casted

get_all_metadata_casted()

返回类型

Dict[str, Dict[str, Any]]
返回

将所有元数据作为 Dict[key, Dict[value, type]] 格式的字典获取。key 和 type 条目为字符串。如果可能，将值强制转换为其类型。请注意，每个条目可能包含一个附加的“key”条目，重复该键

get_local_copy

get_local_copy(extract_archive=None, raise_on_error=False, force_download=False)

检索模型文件(s)的有效链接。如果模型 URL 是文件系统链接，将直接返回。如果模型 URL 指向远程位置（http/s3/gs 等），将下载文件(s)并返回下载模型的临时位置。

参数
- extract_archive (bool ) – 如果为 True，如果可能，将提取本地副本。如果为 False，将不提取本地副本。如果为 None（默认），如果模型是包，则下载的文件将被提取。
- raise_on_error (bool ) – 如果为 True 且无法下载工件，则引发 ValueError，否则在失败时返回 None 并输出日志警告。
- force_download (bool ) – 如果为 True，即使模型工件已缓存，也将下载该工件。
返回类型

str
返回

模型的本地路径（或其下载的副本）。

get_metadata

get_metadata(key)

根据其键获取一个元数据条目值（作为字符串）。如果您希望将值强制转换为其类型（如果可能），请参阅 Model.get_metadata_casted

参数

key (str) – 您要获取的元数据条目的键
返回类型

Optional[str]
返回

元数据条目的值作为字符串表示，如果未找到该条目，则返回 None

get_metadata_casted

get_metadata_casted(key)

根据其键获取一个元数据条目，如果可能，将其强制转换为其类型

参数

key (str) – 您要获取的元数据条目的键
返回类型

Optional[str]
返回

元数据条目的值，强制转换为其类型（如果不可能，则返回字符串表示），如果未找到该条目，则返回 None

get_weights

get_weights(raise_on_error=False, force_download=False, extract_archive=False)

下载基本模型并返回本地存储的文件名。

参数
- raise_on_error (bool ) – 如果为 True 且无法下载工件，则引发 ValueError，否则在失败时返回 None 并输出日志警告。
- force_download (bool ) – 如果为 True，即使基本模型已缓存，也将下载基本模型。
- extract_archive (bool ) – 如果为 True，如果可能，将提取下载的权重文件
返回类型

str
返回

本地存储的文件。

get_weights_package

get_weights_package(return_path=False, raise_on_error=False, force_download=False, extract_archive=True)

将基本模型包下载到临时目录（提取文件），或返回本地存储的文件名列表。

参数
- return_path (bool ) – 返回模型权重或文件名列表（可选）
  - True - 将模型权重下载到临时目录，并返回临时目录路径。
  - False - 返回本地存储的文件名列表。（默认）
- raise_on_error (bool ) – 如果为 True 且无法下载工件，则引发 ValueError，否则在失败时返回 None 并输出日志警告。
- force_download (bool ) – 如果为 True，即使工件已缓存，也将下载基本工件。
- extract_archive (bool ) – 如果为 True，如果可能，将提取下载的权重文件
返回类型

Union[str, List[Path], None]
返回

模型权重，或本地存储的文件名列表。如果 raise_on_error=False，则在出错时返回 None。

id

property id: str

模型的 ID（系统 UUID）。

返回类型

str
返回

模型 ID。

InputModel.import_model

classmethod import_model(weights_url, config_text=None, config_dict=None, label_enumeration=None, name=None, project=None, tags=None, comment=None, is_package=False, create_as_published=False, framework=None)

通过指定初始权重文件的 URL，从预训练模型创建 InputModel 对象。可以选择输入配置、标签枚举、模型名称、描述模型的标签、作为模型描述的评论、指示模型是否为包、指定模型的框架，以及指示是否立即将模型状态设置为 Published。模型是只读的。

ClearML Server（后端）可能已经存储了模型的 URL。如果输入模型的 URL 未存储（表示模型是新的），则导入该模型，ClearML 存储其元数据。如果 URL 已存储，则导入过程停止，ClearML 发出警告消息，并重用该模型。

在您的 Python 实验脚本中，导入模型后，您可以使用 InputModel.connect 或 Task.connect 将其连接到主执行 Task 作为输入模型。这将初始化网络。

信息

使用 ClearML Web-App（用户界面），您可以重用导入的模型并在实验中切换模型。

参数
- weights_url (str ) – 初始权重文件的有效 URL。如果 ClearML Web-App（后端）
  
  已经存储了具有相同 URL 的模型的元数据，则返回该现有模型并忽略所有其他参数。例如
  - https://domain.com/file.bin
  - s3://bucket/file.bin
  - file:///home/user/file.bin
- config_text (unconstrained text string ) – 配置作为字符串。这通常是配置字典文件的内容。指定 config_text 或 config_dict，但不能同时指定两者。
- config_dict (dict ) – 配置作为字典。指定 config_text 或 config_dict，但不能同时指定两者。
- label_enumeration (dict ) – 可选的字符串（标签）到整数（值）对的标签枚举字典。
例如
```
{
     "background": 0,
     "person": 1
}
```
- name (str ) – 新导入模型的名称。（可选）
- project (str ) – 将模型添加到其中的项目名称。（可选）
- tags (list ( str ) ) – 描述模型的标签列表。（可选）
- comment (str ) – 模型的评论/描述。（可选）
- is_package (bool ) – 导入的权重文件是否为包（可选）
  - True - 是一个包。向模型添加一个包标签。
  - False - 不是一个包。不添加包标签。（默认）
- create_as_published (bool ) – 将模型的状态设置为 Published（可选）
  - True - 将状态设置为 Published。
  - False - 不将状态设置为 Published。状态将为 Draft。（默认）
- framework (str * or * Framework object ) – 模型的框架。（可选）
返回类型

InputModel
返回

导入的模型或现有模型（见上文）。

labels

property labels: Dict[str, int]

字符串（标签）到整数（值）对的标签枚举。

返回类型

Dict[str, int]
返回

包含标签枚举的字典，其中键为标签，值为整数。

InputModel.load_model

classmethod load_model(weights_url, load_archived=False)

根据预先存在的模型文件（链接必须有效）加载已注册的模型。如果权重文件的 url 已经存在，则返回代表加载模型的 Model 对象。如果未找到具有指定 url 的已注册模型，则返回 None。

参数
- weights_url (str) – 权重文件的有效 url（字符串）。
示例
```
"https://domain.com/file.bin" or "s3://bucket/file.bin" or "file:///home/user/file.bin".
```
信息
如果存在 URL 完全相同的模型，则将使用该模型，并忽略所有其他参数。
- load_archived (bool ) – 加载归档模型
  - True - 加载已注册的模型（如果已归档）。
  - False - 忽略归档模型。
返回类型

InputModel
返回

InputModel 对象，如果未找到模型，则返回 None。

name

property name: str

模型的名称。

返回类型

str
返回

模型名称。

original_task

property original_task: str

返回创建此模型的任务 ID。

返回类型

str
返回

任务 ID (str)

project

property project: str

模型的项目 ID。

返回类型

str
返回

项目 ID (str)。

publish

publish()

将模型状态设置为 published 并公开使用。如果模型状态已为 published，则此方法无效。

返回类型

()

published

property published: bool

获取此模型的发布状态。

返回类型

bool
返回

InputModel.query_models

classmethod query_models(project_name=None, model_name=None, tags=None, only_published=False, include_archived=False, max_results=None, metadata=None)

从项目工件库返回 Model 对象。根据项目名称/模型名称/标签进行过滤。列表始终按上次更新时间降序排序返回（即最新模型在列表中排在首位）

参数
- project_name (Optional[str]) – 可选，根据项目名称字符串进行过滤；如果未指定，则查询所有项目中的模型
- model_name (Optional[str]) – 可选的模型名称，如模型工件库中所示
- tags (Optional[Sequence[str]]) – 根据请求的标签列表（字符串）进行过滤。要排除某个标签，可在标签前添加“-”前缀。示例：["production", "verified", "-qa"]。默认行为是使用逻辑“OR”运算符连接所有标签。要改用逻辑“AND”运算符连接所有标签，请将“__$all”作为第一个字符串，例如
```
["__$all", "best", "model", "ever"]
```
要使用 AND 连接所有标签，但排除某个标签，请在被排除标签前使用“__$not”，例如
```
["__$all", "best", "model", "ever", "__$not", "internal", "__$not", "test"]
```
“OR”和“AND”运算符应用于它们之后的所有标签，直到指定另一个运算符。NOT 运算符仅应用于紧随其后的标签。例如
```
["__$all", "a", "b", "c", "__$or", "d", "__$not", "e", "__$and", "__$or", "f", "g"]
```
此示例表示（“a” AND “b” AND “c” AND（“d” OR NOT “e”）AND（“f” OR “g”））。有关详细信息，请参阅 https://clearml.org.cn/docs/latest/docs/clearml_sdk/model_sdk#tag-filters。
- only_published (bool) – 如果为 True，则仅返回已发布的模型。
- include_archived (bool) – 如果为 True，则返回归档模型。
- max_results (Optional[int]) – 可选，返回最后 X 个模型，按上次更新时间排序（从最新到最旧）。
- metadata (Optional[Dict[str, str]]) – 根据元数据进行过滤。此参数是一个字典。请注意，不需要元数据字段的类型。
返回类型

List[Model]
返回

Model 对象列表

InputModel.remove

classmethod remove(model, delete_weights_file=True, force=False, raise_on_errors=False)

从模型仓库中移除模型。可选，从远程存储中删除模型权重文件。

参数
- model (Union[str, Model]) – 要移除的模型 ID 或 Model 对象
- delete_weights_file (bool) – 如果为 True（默认），从远程存储中删除权重文件
- force (bool) – 如果为 True，即使其他任务正在使用此模型，也移除模型。默认值为 False。
- raise_on_errors (bool) – 如果为 True，如果出现问题则引发 ValueError，默认值为 False。
返回类型

bool
返回

如果模型成功移除则返回 True，部分移除返回 False，即模型已删除但权重文件删除失败

report_confusion_matrix

report_confusion_matrix(title, series, matrix, iteration=None, xaxis=None, yaxis=None, xlabels=None, ylabels=None, yaxis_reversed=False, comment=None, extra_layout=None)

用于显式报告，绘制热力图矩阵。

例如

confusion = np.random.randint(10, size=(10, 10))
model.report_confusion_matrix("example confusion matrix", "ignored", iteration=1, matrix=confusion,
     xaxis="title X", yaxis="title Y")

参数
- title (str ) – 图表的标题（度量）。
- series (str ) – 报告的混淆矩阵的系列名称（变体）。
- matrix (numpy.ndarray ) – 热力图矩阵（示例：混淆矩阵）
- iteration (int ) – 报告的迭代/步数。
- xaxis (str ) – x 轴标题。（可选）
- yaxis (str ) – y 轴标题。（可选）
- xlabels (list ( str ) ) – 矩阵每列的标签。（可选）
- ylabels (list ( str ) ) – 矩阵每行的标签。（可选）
- yaxis_reversed (bool ) – 如果为 False，则 0,0 在左下角。如果为 True，则 0,0 在左上角
- comment (str ) – 与图表一起显示的评论，位于标题下方。
- extra_layout (dict ) – 可选的布局配置字典，直接传递给 plotly。请参阅支持配置的完整详细信息：https://plotly.com/javascript/reference/heatmap/ 示例：extra_layout={'xaxis': {'type': 'date', 'range': ['2020-01-01', '2020-01-31']}}
返回类型

None

report_histogram

report_histogram(title, series, values, iteration=None, labels=None, xlabels=None, xaxis=None, yaxis=None, mode=None, data_args=None, extra_layout=None)

用于显式报告，绘制（默认分组）直方图。请注意，此函数不会计算直方图，它假定直方图已在 values 中计算完成

例如

vector_series = np.random.randint(10, size=10).reshape(2,5)
model.report_histogram(title='histogram example', series='histogram series',
     values=vector_series, iteration=0, labels=['A','B'], xaxis='X axis label', yaxis='Y axis label')

参数
- title (str) – 图表的标题（度量）。
- series (str) – 报告的直方图的系列名称（变体）。
- values (Sequence[Union[int, float]]) – 系列值。浮点数列表，或包含每个直方图条数据的 N 维 Numpy 数组。
- iteration (Optional[int]) – 报告的迭代/步数。每次 iteration 创建一个新的图表。
- labels (Optional[List[str]]) – 每个条形组的标签，创建标记每个系列的图例。（可选）
- xlabels (Optional[List[str]]) – 直方图中每个桶（向量）中每个条目的标签，为 x 轴上的每个直方图条创建一组标签。（可选）
- xaxis (Optional[str]) – x 轴标题。（可选）
- yaxis (Optional[str]) – y 轴标题。（可选）
- mode (Optional[str]) – 多直方图模式，stack / group / relative。默认值为 'group'。
- data_args (Optional[dict]) – 可选的数据配置字典，直接传递给 plotly。请参阅支持配置的完整详细信息：https://plotly.com/javascript/reference/bar/ 示例：data_args={'orientation': 'h', 'marker': {'color': 'blue'}}
- extra_layout (Optional[dict]) – 可选的布局配置字典，直接传递给 plotly。请参阅支持配置的完整详细信息：https://plotly.com/javascript/reference/bar/ 示例：extra_layout={'xaxis': {'type': 'date', 'range': ['2020-01-01', '2020-01-31']}}
返回类型

None

report_line_plot

report_line_plot(title, series, xaxis, yaxis, mode='lines', iteration=None, reverse_xaxis=False, comment=None, extra_layout=None)

用于显式报告，将一个或多个系列绘制为线条。

参数
- title (str ) – 图表的标题（度量）。
- series (list ) – 所有系列数据，每个列表元素代表图表中的一条线。
- iteration (int ) – 报告的迭代/步数。
- xaxis (str ) – x 轴标题。（可选）
- yaxis (str ) – y 轴标题。（可选）
- mode (str ) – 线图类型。取值为
  - lines（默认）
  - markers
  - lines+markers
- reverse_xaxis (bool ) – 反转 x 轴。取值为
  - True - x 轴从高到低（反转）。
  - False - x 轴从低到高（未反转）。（默认）
- comment (str ) – 与图表一起显示的评论，位于标题下方。
- extra_layout (dict ) – 可选的布局配置字典，直接传递给 plotly。请参阅支持配置的完整详细信息：https://plotly.com/javascript/reference/scatter/ 示例：extra_layout={'xaxis': {'type': 'date', 'range': ['2020-01-01', '2020-01-31']}}
返回类型

None

report_matrix

report_matrix(title, series, matrix, iteration=None, xaxis=None, yaxis=None, xlabels=None, ylabels=None, yaxis_reversed=False, extra_layout=None)

用于显式报告，绘制混淆矩阵。

信息

此方法与 Model.report_confusion_matrix 相同。

参数
- title (str ) – 图表的标题（度量）。
- series (str ) – 报告的混淆矩阵的系列名称（变体）。
- matrix (numpy.ndarray ) – 热力图矩阵（示例：混淆矩阵）
- iteration (int ) – 报告的迭代/步数。
- xaxis (str ) – x 轴标题。（可选）
- yaxis (str ) – y 轴标题。（可选）
- xlabels (list ( str ) ) – 矩阵每列的标签。（可选）
- ylabels (list ( str ) ) – 矩阵每行的标签。（可选）
- yaxis_reversed (bool ) – 如果为 False，则 0,0 在左下角。如果为 True，则 0,0 在左上角
- extra_layout (dict ) – 可选的布局配置字典，直接传递给 plotly。请参阅支持配置的完整详细信息：https://plotly.com/javascript/reference/heatmap/ 示例：extra_layout={'xaxis': {'type': 'date', 'range': ['2020-01-01', '2020-01-31']}}
返回类型

None

report_scalar

report_scalar(title, series, value, iteration)

用于显式报告，绘制标量系列。

参数
- title (str ) – 图表的标题（度量）。通过对每次调用此方法时使用相同的 title，可以在同一个图表上绘制多个标量系列。
- series (str ) – 报告的标量的系列名称（变体）。
- value (float ) – 每次迭代要绘制的值。
- iteration (int ) – 报告的迭代/步数（报告时间序列的 x 轴）
返回类型

None

report_scatter2d

report_scatter2d(title, series, scatter, iteration=None, xaxis=None, yaxis=None, labels=None, mode='line', comment=None, extra_layout=None)

用于显式报告，报告 2d 散点图。

例如

scatter2d = np.hstack((np.atleast_2d(np.arange(0, 10)).T, np.random.randint(10, size=(10, 1))))
model.report_scatter2d(title="example_scatter", series="series", iteration=0, scatter=scatter2d,
     xaxis="title x", yaxis="title y")

通过向此方法传递相同的 title 和 iteration 值，可以在同一个图表上绘制多个 2D 散点系列

scatter2d_1 = np.hstack((np.atleast_2d(np.arange(0, 10)).T, np.random.randint(10, size=(10, 1))))
model.report_scatter2d(title="example_scatter", series="series_1", iteration=1, scatter=scatter2d_1,
     xaxis="title x", yaxis="title y")

scatter2d_2 = np.hstack((np.atleast_2d(np.arange(0, 10)).T, np.random.randint(10, size=(10, 1))))
model.report_scatter2d("example_scatter", "series_2", iteration=1, scatter=scatter2d_2,
     xaxis="title x", yaxis="title y")

参数
- title (str ) – 图表的标题（度量）。
- series (str ) – 报告的散点图的系列名称（变体）。
- scatter (list ) – 散点数据。numpy.ndarray 或 (x,y) 对的列表
- iteration (int ) – 报告的迭代/步数。
- xaxis (str ) – x 轴标题。（可选）
- yaxis (str ) – y 轴标题。（可选）
- labels (list ( str ) ) – 分配给 scatter 参数中数据的每个点的标签。标签必须与数据的顺序相同。
- mode (str ) – 散点图的类型。取值为
  - lines
  - markers
  - lines+markers
- comment (str ) – 与图表一起显示的评论，位于标题下方。
- extra_layout (dict ) – 可选的布局配置字典，直接传递给 plotly。请参阅支持配置的完整详细信息：https://plotly.com/javascript/reference/scatter/ 示例：extra_layout={'xaxis': {'type': 'date', 'range': ['2020-01-01', '2020-01-31']}}
返回类型

None

report_scatter3d

report_scatter3d(title, series, scatter, iteration=None, xaxis=None, yaxis=None, zaxis=None, labels=None, mode='markers', fill=False, comment=None, extra_layout=None)

用于显式报告，绘制 3d 散点图（带标记）。

参数
- title (str ) – 图表的标题（度量）。
- series (str ) – 报告的散点图的系列名称（变体）。
- scatter (Union[Sequence[Tuple[float, float, float]], ndarray]) – 散点数据。(x,y,z) 对的列表，系列列表 [[(x1,y1,z1)…]], 或 numpy.ndarray
- iteration (int ) – 报告的迭代/步数。
- xaxis (str ) – x 轴标题。（可选）
- yaxis (str ) – y 轴标题。（可选）
- zaxis (str ) – z 轴标题。（可选）
- labels (list ( str ) ) – 分配给 scatter 参数中数据的每个点的标签。标签必须与数据的顺序相同。
- mode (str ) – 散点图的类型。取值为：lines、markers、lines+markers。
例如
```
scatter3d = np.random.randint(10, size=(10, 3))
model.report_scatter3d(title="example_scatter_3d", series="series_xyz", iteration=1, scatter=scatter3d,
    xaxis="title x", yaxis="title y", zaxis="title z")
```
- fill (bool ) – 填充曲线下方区域。取值为
  - True - 填充
  - False - 不填充（默认）
- comment (str ) – 与图表一起显示的评论，位于标题下方。
- extra_layout (dict ) – 可选的布局配置字典，直接传递给 plotly。请参阅支持配置的完整详细信息：https://plotly.com/javascript/reference/scatter3d/ 示例：extra_layout={'xaxis': {'type': 'date', 'range': ['2020-01-01', '2020-01-31']}}
返回类型

()

report_single_value

report_single_value(name, value)

报告单值度量（例如，总实验准确率或 mAP）

参数
- name (str) – 度量名称
- value (float) – 度量值
返回类型

None

report_surface

report_surface(title, series, matrix, iteration=None, xaxis=None, yaxis=None, zaxis=None, xlabels=None, ylabels=None, camera=None, comment=None, extra_layout=None)

用于显式报告，报告 3d 曲面图。

信息

此方法绘制的数据与 Model.report_confusion_matrix 相同，但以曲面图而不是混淆矩阵的形式呈现数据。

surface_matrix = np.random.randint(10, size=(10, 10))
model.report_surface("example surface", "series", iteration=0, matrix=surface_matrix,
     xaxis="title X", yaxis="title Y", zaxis="title Z")

参数
- title (str ) – 图表的标题（度量）。
- series (str ) – 报告的曲面的系列名称（变体）。
- matrix (numpy.ndarray ) – 热力图矩阵（示例：混淆矩阵）
- iteration (int ) – 报告的迭代/步数。
- xaxis (str ) – x 轴标题。（可选）
- yaxis (str ) – y 轴标题。（可选）
- zaxis (str ) – z 轴标题。（可选）
- xlabels (list ( str ) ) – 矩阵每列的标签。（可选）
- ylabels (list ( str ) ) – 矩阵每行的标签。（可选）
- camera (list ( float ) ) – 指示摄像机位置的 X,Y,Z 坐标。默认值为 (1,1,1)。
- comment (str ) – 与图表一起显示的评论，位于标题下方。
- extra_layout (dict ) – 可选的布局配置字典，直接传递给 plotly。请参阅支持配置的完整详细信息：https://plotly.com/javascript/reference/surface/ 示例：extra_layout={'xaxis': {'type': 'date', 'range': ['2020-01-01', '2020-01-31']}}
返回类型

None

report_table

report_table(title, series, iteration=None, table_plot=None, csv=None, url=None, extra_layout=None)

用于显式报告，报告表格图。

以下参数必须且仅提供一个。

table_plot - Pandas DataFrame 或作为行列表（list）的 Table
csv - CSV 文件
url - CSV 文件的 URL

例如

df = pd.DataFrame({'num_legs': [2, 4, 8, 0],
        'num_wings': [2, 0, 0, 0],
        'num_specimen_seen': [10, 2, 1, 8]},
        index=['falcon', 'dog', 'spider', 'fish'])

model.report_table(title='table example',series='pandas DataFrame',iteration=0,table_plot=df)

参数
- title (str) – 表格的标题（度量）。
- series (str) – 报告的表格的系列名称（变体）。
- iteration (Optional[int]) – 报告的迭代/步数。
- table_plot (Union[DataFrame, Sequence[Sequence], None]) – 输出表格图对象
- csv (Optional[str]) – 本地 csv 文件的路径
- url (Optional[str]) – csv 文件位置的 URL。
- extra_layout (Optional[Dict]) – 可选的布局配置字典，直接传递给 plotly。请参阅支持配置的完整详细信息：https://plotly.com/javascript/reference/layout/ 示例：extra_layout={'height': 600}
返回类型

None

report_vector

report_vector(title, series, values, iteration=None, labels=None, xlabels=None, xaxis=None, yaxis=None, mode=None, extra_layout=None)

用于显式报告，将向量绘制为（默认堆叠）直方图。

例如

vector_series = np.random.randint(10, size=10).reshape(2,5)
model.report_vector(title='vector example', series='vector series', values=vector_series, iteration=0,
     labels=['A','B'], xaxis='X axis label', yaxis='Y axis label')

参数
- title (str) – 图表的标题（度量）。
- series (str) – 报告的直方图的系列名称（变体）。
- values (Sequence[Union[int, float]]) – 系列值。浮点数列表，或包含每个直方图条数据的 N 维 Numpy 数组。
- iteration (Optional[int]) – 报告的迭代/步数。每次 iteration 创建一个新的图表。
- labels (Optional[List[str]]) – 每个条形组的标签，创建标记每个系列的图例。（可选）
- xlabels (Optional[List[str]]) – 直方图中每个桶（向量）中每个条目的标签，为 x 轴上的每个直方图条创建一组标签。（可选）
- xaxis (Optional[str]) – x 轴标题。（可选）
- yaxis (Optional[str]) – y 轴标题。（可选）
- mode (Optional[str]) – 多直方图模式，stack / group / relative。默认值为 'group'。
- extra_layout (Optional[dict]) – 可选的布局配置字典，直接传递给 plotly。请参阅支持配置的完整详细信息：https://plotly.com/javascript/reference/layout/ 示例：extra_layout={'showlegend': False, 'plot_bgcolor': 'yellow'}
返回类型

None

set_all_metadata

set_all_metadata(metadata, replace=True)

根据给定参数设置元数据。允许替换所有条目或更新当前条目。

参数
- metadata (Dict[str, Dict[str, str]]) – 格式为 Dict[key, Dict[value, type]] 的字典，表示要设置的元数据
- replace (bool) – 如果为 True，则用 metadata 参数中的条目替换所有元数据。如果为 False，则保留旧元数据并使用 metadata 参数中的条目更新它（添加或更改）
返回类型

bool
返回

如果元数据设置成功则返回 True，否则返回 False

set_metadata

set_metadata(key, value, v_type=None)

设置一个元数据条目。所有参数必须是字符串或可转换为字符串

参数
- key (str) – 元数据条目的键
- value (str) – 元数据条目的值
- v_type (Optional[str]) – 元数据条目的类型
返回类型

bool
返回

如果元数据设置成功则返回 True，否则返回 False

system_tags

property system_tags: List[str]

描述模型的系统标签列表。

返回类型

List[str]
返回

标签列表。

task

property task: str

返回连接到此模型的任务 ID。如果没有连接任务，则返回最初创建此模型的任务的 ID。

返回类型

str
返回

任务 ID (str)

unarchive

unarchive()

取消归档模型。如果模型未归档，则此操作无效

返回类型

()

url

property url: str

返回模型文件（或归档文件）的 url

返回类型

str
返回

模型文件 URL。

class InputModel(model_id=None, name=None, project=None, tags=None, only_published=False)​

archive​

comment​

config_dict​

config_text​

connect​

InputModel.empty​

framework​

get_all_metadata​

get_all_metadata_casted​

get_local_copy​

get_metadata​

get_metadata_casted​

get_weights​

get_weights_package​

id​

InputModel.import_model​

labels​

InputModel.load_model​

name​

original_task​

project​

publish​

published​

InputModel.query_models​

InputModel.remove​

report_confusion_matrix​

report_histogram​

report_line_plot​

report_matrix​

report_scalar​

report_scatter2d​

report_scatter3d​

report_single_value​

report_surface​

report_table​

report_vector​

set_all_metadata​

set_metadata​

system_tags​

tags​

task​

unarchive​

url​