报告

概述

使用Aim报告来组织运行、嵌入可视化、描述您的发现并与协作者分享更新。

下图展示了一个从训练过程中记录到aimstack的指标生成的报告示例。

报告页面

在单个报告页面中，您可以找到两种模式：view（查看）和edit（编辑）。

在edit模式下创建报告，并在view模式下查看最终结果。上面的示例处于view模式。 您可以使用 ```aim部分从Aim存储中检索数据并进行可视化。下面显示的示例是edit模式的概览。

有关数据获取和可视化的对象及方法的详细信息将在后续章节中介绍。

数据获取方法

要从Aim存储中检索数据，可以使用repo对象的以下方法。

**注意：** 默认情况下，repo对象在报告上下文中可用。

方法	描述
fetch_metrics	仓库指标
fetch_images	仓库镜像
fetch_audios	仓库音频
fetch_figures	仓库图表
fetch_texts	仓库文本

所有方法都接受一个查询参数，默认值为True（获取所有可用序列）。

此示例的结果：

```aim
metrics = repo.fetch_metrics('metric.name == "loss"')
linechart = LineChart(metrics)
```

可视化对象与方法

以下类和方法用于可视化从Aim存储中获取的所有数据类型。 每个类和方法都附带了小示例，展示基本用法。

• LineChart

签名: LineChart(data, x, y)

参数:

名称	类型	默认值	默认值
data	List[dict]	必填	要绘制的数据
x	str	steps	x轴值对应的属性路径（对于已获取的指标，可选值为epochs, timestamps）
y	str	values	y轴数值属性的路径

示例：

```aim
metrics = repo.fetch_metrics()
linechart = LineChart(metrics, x='timestamps')
```

• ImagesList

签名: ImagesList(data)

参数:

名称	类型	默认值	默认值
data	List[dict]	必填	要绘制的数据

示例：

```aim
images = repo.fetch_images()
ImagesList(images)
```

• AudiosList

签名: AudiosList(data)

参数:

名称	类型	默认值	默认值
data	List[dict]	必填	要绘制的数据

示例：

```aim
audios = repo.fetch_audios()
AudiosList(audios)
```

• FiguresList

签名: FiguresList(data)

参数:

名称	类型	默认值	默认值
data	List[dict]	必填	要绘制的数据

示例：

```aim
figures = repo.fetch_figures()
FiguresList(figures)
```

• TextsList

签名: TextsList(data)

参数:

```aim
texts = repo.fetch_texts()
TextsList(texts)
```

所有上述对象都拥有可用的group方法：

def group(prop: str, value: Union[str, list]):
    ...

prop- 用于分组的属性名称。可用选项包括：color, stroke_style, row, column (前两个选项仅适用于LineChart)

value- 用于分组的一个或多个序列字段值。可用字段与资源管理器页面分组选项中显示的字段相同。

group 方法可以多次连续应用。

示例：

```aim
metrics = repo.fetch_metrics()
linechart = LineChart(metrics)
linechart.group('color', 'run.hash')
linechart.group('row', ['metric.name', 'metric.context.subset'])
```

搜索报告

搜索栏可用，方便您快速找到所需的报告。

删除报告

删除按钮位于报告卡右上角的选项按钮中。点击后将弹出一个模态框，您可以在其中确认或取消删除操作。