# luxonis_model_summary

Python API: `luxonis_train.callbacks.luxonis_model_summary`

以富表格或纯文本形式打印模型的层摘要。

## 类

### LuxonisModelSummary

打印模型层摘要的回调。

此回调扩展了 Lightning `RichModelSummary`，并在拟合开始时打印摘要。当 `rich` 为 `on` 时，它会将富表格打印到控制台，并将一份不带终端样式的副本写入日志文件。当 `rich` 为 `off` 时，它会记录一个纯
`tabulate`
表格和总计。这些记录会到达控制台和日志文件。[LuxonisLightningModule.configure_callbacks](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/lightning/luxonis_lightning.md)
添加此回调时，`max_depth=2`，并且 `rich` 等于配置的 `rich_logging`。

#### 方法

##### init

```python
def __init__(rich: bool = True, **kwargs):
```

初始化回调。

参数

 * `rich` (`bool`): 打印富表格。`False` 则打印纯文本表格。
 * `**kwargs`: Lightning `RichModelSummary` 的关键字参数。`max_depth` 设置表格中嵌套模块的最深层级，`0` 则关闭摘要。Lightning 将所有其他关键字传递给
   [LuxonisModelSummary.summarize](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/callbacks/luxonis_model_summary.md)。

##### summarize

```python
def summarize(*args, **kwargs):
```

以富表格或纯文本形式打印层摘要。

Lightning `ModelSummary.on_fit_start` 钩子在拟合开始时调用此方法，仅在全局 rank 0 上。当 `max_depth` 为 `0` 时，它会跳过调用。

当 `rich` 为 `on` 时，此方法会将富表格和总计网格打印到全局 `rich` 控制台。它还会将两者（不带终端样式）仅写入日志文件。当 `rich` 为 `off` 时，此方法会以 `fancy_grid` 格式记录一个 `tabulate`
表格，并使用 `logger.info` 为每个总计记录一行。这些行会到达控制台和日志文件。

`summary_data` 的每一列都按顺序成为表格列。此方法按位置设置标题：索引列、`Name`、`Type`、`Params` 和 `Mode`。当 `summary_data` 包含 `In sizes` 和 `Out sizes` 列时，富表格会在
`Mode` 之后添加这两个标题。Lightning 会在 `Mode` 之后放置一个 `FLOPs` 列。因此，这两个标题会覆盖 `FLOPs` 和 `In sizes` 数据。在富表格中，最后一个标题之后的数据列没有标题。`tabulate`
将五个标题放在最后五列上方。如果列数超过五列，则纯表格的标题不会覆盖其数据。

总计包括：

 * 可训练、不可训练和总参数计数；
 * 参数的估计大小（以 MB 为单位，不带小数部分）；
 * 训练模式和评估模式下的模块数量。

计数和大小使用短格式，例如 `1.2 M`。

参数

 * `*args`: Lightning 钩子的位置参数，按顺序排列：`summary_data`，列为 `(header, values)`
   对；`total_parameters`；`trainable_parameters`；`model_size`，以 MB 为单位；以及 `total_training_modes`，一个包含 `"train"` 和 `"eval"` 键的字典。
 * `**kwargs`: Lightning 钩子的关键字参数。富表格读取 `header_style`，如果未给出，则为 `"bold magenta"`。此方法忽略所有其他关键字，例如 `total_flops`。
