日志记录器

class Logger()

Logger 类是 ClearML 控制台日志和指标统计接口，包含用于显式报告的方法。

显式报告扩展了ClearML自动捕获输入和输出的功能。显式报告方法包括标量图、线图、直方图、混淆矩阵、2D和3D散点图、文本日志、表格以及图像上传和报告。

在ClearML Web-App（UI）中，Logger输出会显示在CONSOLE、SCALARS、PLOTS和DEBUG SAMPLES标签页中。当你比较实验时，Logger输出会出现在比较结果中。

warning

不要直接构造Logger对象。

在调用任何其他Logger类方法之前，您必须通过调用Task.get_logger或Logger.current_logger来获取一个Logger对象。

warning

不要手动构造Logger！请使用Logger.get_current

Logger.current_logger

classmethod current_logger()

获取主执行任务的Logger对象，即当前正在运行的任务（如果存在）。如果没有Logger对象存在，此方法将创建一个并返回它。因此，您可以在代码的任何地方调用此方法。

logger = Logger.current_logger()

返回类型

Logger
返回

当前运行任务的Logger对象（单例）。

报告文本

**report_text(msg, level=20, print_console=True, *args, _)

对于显式报告，将文本打印到日志中。可选地，打印日志级别并打印到控制台。

例如：

logger.report_text('log some text', level=logging.DEBUG, print_console=False)

您可以在ClearML Web-App (UI)的RESULTS标签下的CONSOLE子标签中查看报告的文本。

参数
- msg (str ) – 要记录的文本。
- level (int ) – 来自 Python logging 包的日志级别。默认值为 logging.INFO。
- print_console (bool ) – 除了日志外，还打印到控制台。
  
  值为：
  - True - 打印到控制台。（默认）
  - False - 不要打印到控制台。
- args (任意 ) –
- _ (任意 ) –
返回类型

None

report_scalar

report_scalar(title, series, value, iteration)

为了明确报告，绘制一个标量系列。

例如，绘制一个标量系列：

logger = Logger.current_logger()
scalar_series = [random.randint(0,10) for i in range(10)]
for iteration in range(10):
    logger.report_scalar(
        title='scalar metrics', series='series', value=scalar_series[iteration], iteration=iteration
    )

您可以在ClearML Web-App (UI)的RESULTS标签页中的SCALARS子标签页查看标量图。

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

None

report_single_value

report_single_value(name, value)

报告单个值指标（例如，总实验准确率或mAP）您可以在ClearML Web-App (UI)的RESULTS标签页中的SCALARS子标签页查看这些指标。

参数
- name (str) – 指标的名称
- value (float) – 指标的数值
返回类型

None

报告向量

report_vector(标题, 系列, 值, 迭代=None, 标签=None, x轴标签=None, x轴=None, y轴=None, 模式=None, 额外布局=None)

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

info

此方法与 Logger.report_histogram 相同。此方法已弃用，请改用 Logger.report_histogram。

例如：

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

您可以在ClearML Web-App (UI)的RESULTS标签下的PLOTS子标签中查看向量图。

参数
- title – 图表的标题（指标）。
- series – 报告的直方图的系列名称（变体）。
- values – 系列值。一个浮点数列表，或一个包含每个直方图条形数据的N维Numpy数组。
- iteration – 报告的迭代/步骤。每个 iteration 都会创建另一个图表。
- labels – 每个条形组的标签，用于创建图例，标注每个系列。（可选）
- xlabels – 直方图中每个桶的每个条目的标签（向量），为x轴上的每个直方图条创建一组标签。（可选）
- xaxis – x轴标题。（可选）
- yaxis – y轴标题。（可选）
- mode – 多直方图模式，堆叠 / 分组 / 相对。默认为‘group’。
- extra_layout – 用于布局配置的可选字典，直接传递给plotly 查看支持的配置的完整详细信息：https://plotly.com/javascript/reference/layout/ 示例：extra_layout={'showlegend': False, 'plot_bgcolor': 'yellow'}

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)

对于显式报告，绘制一个（默认分组的）直方图。请注意，此函数不会计算直方图，它假设直方图已经在值中计算完成。

例如：

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

您可以在ClearML Web-App (UI)的RESULTS标签页中的PLOTS子标签页查看报告的直方图。

参数
- title – 图表的标题（指标）。
- series – 报告的直方图的系列名称（变体）。
- values – 系列值。一个浮点数列表，或一个包含每个直方图条形数据的N维Numpy数组。
- iteration – 报告的迭代/步骤。每个 iteration 都会创建另一个图表。
- labels – 每个条形组的标签，用于创建图例，标注每个系列。（可选）
- xlabels – 直方图中每个桶的每个条目的标签（向量），为x轴上的每个直方图条创建一组标签。（可选）
- xaxis – x轴标题。（可选）
- yaxis – y轴标题。（可选）
- mode – 多直方图模式，堆叠 / 分组 / 相对。默认为‘分组’。
- data_args – 可选的数据配置字典，直接传递给 plotly 查看支持的配置的完整详细信息：https://plotly.com/javascript/reference/bar/ 示例：data_args={'orientation': 'h', 'marker': {'color': 'blue'}}
- extra_layout – 用于布局配置的可选字典，直接传递给 plotly 查看支持的配置的完整详细信息：https://plotly.com/javascript/reference/bar/ 示例：extra_layout={'xaxis': {'type': 'date', 'range': ['2020-01-01', '2020-01-31']}}

报告表

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

对于显式报告，报告一个表格图。

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

table_plot - Pandas DataFrame 或作为行列表的表格（列表）
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'])

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

您可以在ClearML Web-App (UI)的RESULTS标签页中的PLOTS子标签页查看报告的表格。

参数
- title – 表格的标题（指标）。
- series – 报告表的系列名称（变体）。
- iteration – 报告的迭代/步骤。
- table_plot – 输出表格绘图对象
- csv – 本地csv文件的路径
- url – 指向csv文件位置的URL。
- extra_layout – 用于布局配置的可选字典，直接传递给 plotly 查看支持的配置的完整详细信息：https://plotly.com/javascript/reference/layout/ 例如：
```
logger.report_table(
    title='table example',
    series='pandas DataFrame',
    iteration=0,
    table_plot=df,
    extra_layout={'height': 600}
)
```
- extra_data – optional dictionary for data configuration, like column width, passed directly to plotly See full details on the supported configuration: https://plotly.com/javascript/reference/table/ For example:
```
logger.report_table(
    title='table example',
    series='pandas DataFrame',
    iteration=0,
    table_plot=df,
    extra_data={'columnwidth': [2., 1., 1., 1.]}
)
```

报告折线图

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

info

此方法与 Logger.report_scatter2d 相同，参数为 mode='lines'。此方法已弃用，请改用 Logger.report_scatter2d。

report_scatter2d

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

对于显式报告，报告一个2D散点图。

例如：

scatter2d = np.hstack((np.atleast_2d(np.arange(0, 10)).T, np.random.randint(10, size=(10, 1))))
logger.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))))
logger.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))))
logger.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']}}

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 ) – 报告的散点图的系列名称（变体）。
- list **] ** scatter (Union [ numpy.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))
logger.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_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))
logger.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']}}

报告矩阵

report_matrix(标题, 系列, 矩阵, 迭代=None, x轴=None, y轴=None, x标签=None, y标签=None, y轴反转=False, 额外布局=None)

为了明确报告，绘制一个混淆矩阵。

info

此方法与 Logger.report_confusion_matrix 相同。此方法已弃用，请改用 Logger.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']}}

报告表面

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表面图。

info

此方法绘制与Logger.report_confusion_matrix相同的数据，但将数据呈现为表面图而非混淆矩阵。

surface_matrix = np.random.randint(10, size=(10, 10))
logger.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']}}

报告图像

report_image(title, series, iteration=None, local_path=None, image=None, matrix=None, max_image_history=None, delete_after_upload=False, url=None)

对于显式报告，报告一张图片并上传其内容。

此方法将图像上传到预配置的存储桶（参见Logger.set_default_upload_destination），描述任务ID、标题、系列和迭代。

例如：

matrix = np.eye(256, 256, dtype=np.uint8)*255
matrix = np.concatenate((np.atleast_3d(matrix), np.zeros((256, 256, 2), dtype=np.uint8)), axis=2)
logger.report_image("test case", "image color red", iteration=1, image=m)

image_open = Image.open(os.path.join("&lt;image_path&gt;", "&lt;image_filename&gt;"))
logger.report_image("test case", "image PIL", iteration=1, image=image_open)

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

local_path
url
image
matrix

参数
- title – 图像的标题（指标）。
- series – 报告图像的系列名称（变体）。
- iteration – 报告的迭代/步骤。
- local_path – 图像文件的路径。
- url – 预上传图片位置的URL。
- image – 图像数据（RGB）。
- matrix – 已弃用，图像数据（RGB）。
info
矩阵参数已被弃用。请使用图像参数。
- max_image_history – 每个指标/变体组合存储的最大图像数量。对于无限数量，请使用负值。默认值在全局配置中设置 (default=``5``)。
- delete_after_upload – 上传后删除图像的本地副本。值为：
  - True - 上传后删除。
  - False - 上传后不删除。（默认）

报告媒体

report_media(title, series, iteration=None, local_path=None, stream=None, file_extension=None, max_history=None, delete_after_upload=False, url=None)

报告媒体上传其内容，包括图像、音频和视频。

媒体被上传到一个预先配置好的存储桶（参见setup_upload()），并使用一个键（文件名）来描述任务ID、标题、系列和迭代。

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

local_path
stream
url

如果你使用stream作为BytesIO流来上传，必须提供file_extension。

参数
- title (str ) – 媒体的标题（指标）。
- series (str) – 报告媒体的系列名称（变体）。
- iteration (int ) – 报告的迭代/步骤。
- local_path (str ) – 媒体文件的路径。
- stream – 要上传的BytesIO流。如果提供了，则还必须提供file_extension。
- url (str ) – 预上传媒体位置的URL。
- file_extension – 当传递 stream 时使用的文件扩展名。
- max_history (int ) – 每个指标/变体组合存储的最大媒体文件数。使用负值表示无限制。默认值在全局配置中设置（默认=5）
- delete_after_upload (bool ) – 文件上传后，删除本地副本
  - True - 删除
  - False - 不删除

report_plotly

report_plotly(title, series, figure, iteration=None)

直接报告一个Plotly图表（绘图）

Plotly 图表可以是一个 plotly.graph_objs._figure.Figure 或由 plotly.js 定义的字典

参数
- title (str ) – 图表的标题（指标）。
- series (str ) – 报告图表的系列名称（变体）。
- iteration (int ) – 报告的迭代/步骤。
- figure (dict ) – 一个 plotly 图形对象或一个 plotly 字典

报告_matplotlib_图表

report_matplotlib_figure(title, series, figure, iteration=None, report_image=False, report_interactive=True)

直接报告一个matplotlib图形/绘图

matplotlib.figure.Figure / matplotlib.pyplot

参数
- title (str ) – 图表的标题（指标）。
- series (str ) – 报告图表的系列名称（变体）。
- iteration (int ) – 报告的迭代/步骤。
- figure (MatplotlibFigure ) – 一个 matplotlib 图形对象
- report_image – 默认值为 False。如果为 True，图表将作为调试样本（png 图像）上传，并会出现在调试样本标签下（而不是图表标签下）。
- report_interactive – 如果为True（默认），它将尝试将matplotlib转换为UI中的交互式图表。如果为False，matplotlib将按原样保存，并且将是非交互式的（除了缩放功能）。

设置默认上传目标

set_default_upload_destination(uri)

设置目标存储URI（例如，S3、Google Cloud Storage、文件路径）以上传调试图像。

图片是单独上传的。每个图片的链接都会被报告。

info

目标存储的凭证在ClearML配置文件中指定，~/clearml.conf。

参数

uri (str ) – 示例: ‘s3://bucket/directory/’ 或 ‘file:///tmp/debug/’
返回类型

None
返回

如果目标方案被支持（例如，s3://、file:// 或 gs://），则为 True。如果不支持，则为 False。

获取默认上传目的地

get_default_upload_destination()

获取用于上传调试图像的目标存储URI（例如，S3、Google Cloud Storage、文件路径）（参见Logger.set_default_upload_destination）。

返回类型

str
返回

默认的上传目标URI。

例如：s3://bucket/directory/，或file:///tmp/debug/。

刷新

flush(wait=False)

将缓存的报告和控制台输出刷新到后端。

参数

wait (bool) – 等待所有未完成的上传和事件发送完成（默认 False）
返回类型

bool
返回

如果成功刷新缓存，则为True。如果失败，则为False。

get_flush_period

get_flush_period()

获取Logger的刷新周期。

返回类型

Optional[float]
返回

日志刷新周期（以秒为单位）。

set_flush_period

set_flush_period(period)

设置日志刷新周期。

已弃用 - 使用 sdk.development.worker.report_period_sec 从外部控制刷新周期。

参数

period (float ) – 日志记录器刷新的周期，以秒为单位。要设置不进行定期刷新，请指定 None 或 0。
返回类型

None

设置默认调试样本历史

设置默认调试样本历史记录(max_history)

设置报告媒体/调试样本时的默认最大调试样本历史记录。覆盖配置文件的默认设置。当报告具有相同标题/系列组合和运行迭代的调试样本时，仅存储最后X个样本（换句话说，样本会被覆盖）。在调用report_image、report_media等时，如果没有指定max_history，则使用max_history设置的默认历史记录大小。

参数

max_history (int) – 存储在不同迭代计数器报告的标题/系列的唯一集合上的样本（文件）数量。这用于确保用户不会在服务器存储端耗尽存储空间。

例如，以下代码示例将存储最后5张图像，尽管我们报告了100个样本。
```
logger.set_default_debug_sample_history(5)
for i in range(100):
    logger.report_image(title='image', series='sample', iteration=i, ...)
```
返回类型

None
返回

获取默认调试样本历史

get_default_debug_sample_history()

返回报告媒体/调试样本时的默认最大调试样本历史记录。如果未特别设置值，则函数返回配置文件的默认值。

返回类型

int
返回

默认的样本（文件）数量，用于存储在一组独特的标题/系列上报告的不同迭代计数器。这是为了确保用户不会在服务器存储端爆炸存储。

报告图片并上传

report_image_and_upload(title, series, iteration=None, path=None, matrix=None, max_image_history=None, delete_after_upload=False)

已弃用： 自版本0.13.0起已弃用：请使用Logger.report_image代替

捕获日志

capture_logging()

返回捕获上下文中所有日志（通过日志记录）的上下文

返回类型

ForwardRef
返回

一个上下文管理器

Logger.tensorboard_auto_group_scalars

classmethod tensorboard_auto_group_scalars(group_scalars=False)

将没有标题的TensorBoard标量分组在一起，或者使用相同的标签分配标题/系列。

参数

group_scalars (bool) – 将没有标题的TensorBoard标量分组

值为：
- True - 没有特定标题的标量会被分组在“标量”图中，保持与ClearML自动行为的向后兼容性。
- False - 没有标题的TensorBoard标量会获得与标签相同的标题/系列。（默认）
返回类型

None

Logger.tensorboard_single_series_per_graph

classmethod tensorboard_single_series_per_graph(single_series=False)

已弃用，现在从UI控制！将TensorBoard标量系列分组在一起或分开绘制。

参数

single_series (bool) – 将 TensorBoard 标量系列分组在一起

值为：
- True - 为每个TensorBoard标量系列生成单独的图表。
- False - 将TensorBoard标量系列在同一图表中分组。（默认）
返回类型

None

Logger.matplotlib_force_report_non_interactive

classmethod matplotlib_force_report_non_interactive(force)

如果为True，所有matplotlib图表将始终转换为非交互式静态图表（图像），显示在Plots部分下。如果为False（默认值），matplotlib图表将转换为交互式web UI plotly图表，如果图表转换失败，则默认为非交互式图表。

参数

force (bool) – 如果为True，所有matplotlib图形将自动转换为非交互式图表。
返回类型

None

Logger.set_reporting_nan_value

classmethod set_reporting_nan_value(value, warn_period=1000)

当遇到NaN值时，它会被报告为一个浮点值（默认为0），并且用户会收到警告。此函数用于更改NaN转换的值以及警告周期。

参数
- value (float) – NaN 被转换成的值
- warn_period (int) – 遇到NaN并转换的次数，直到下一次警告
返回类型

None

Logger.set_reporting_inf_value

classmethod set_reporting_inf_value(value, warn_period=1000)

当遇到inf值时，它会被报告为一个浮点值（默认为0），并且用户会收到警告。此函数用于更改inf转换的值以及警告周期。

参数
- value (float) – 值 inf 被转换为
- warn_period (int) – 遇到并转换 inf 的次数，直到下一次警告
返回类型

None

class Logger()​

Logger.current_logger​

报告文本​

report_scalar​

report_single_value​

报告向量​

report_histogram​

报告表​

报告折线图​

report_scatter2d​

report_scatter3d​

报告混淆矩阵​

报告矩阵​

报告表面​

报告图像​

报告媒体​

report_plotly​

报告_matplotlib_图表​

设置默认上传目标​

获取默认上传目的地​

刷新​

get_flush_period​

set_flush_period​

设置默认调试样本历史​

获取默认调试样本历史​

报告图片并上传​

捕获日志​

Logger.tensorboard_auto_group_scalars​

Logger.tensorboard_single_series_per_graph​

Logger.matplotlib_force_report_non_interactive​

Logger.set_reporting_nan_value​

Logger.set_reporting_inf_value​

class Logger()

Logger.current_logger

报告文本

report_scalar

report_single_value

报告向量

report_histogram

报告表

报告折线图

report_scatter2d

report_scatter3d

报告混淆矩阵

报告矩阵

报告表面

报告图像

报告媒体

report_plotly

报告_matplotlib_图表

设置默认上传目标

获取默认上传目的地

刷新

get_flush_period

set_flush_period

设置默认调试样本历史

获取默认调试样本历史

报告图片并上传

捕获日志

Logger.tensorboard_auto_group_scalars

Logger.tensorboard_single_series_per_graph

Logger.matplotlib_force_report_non_interactive

Logger.set_reporting_nan_value

Logger.set_reporting_inf_value