文档反馈

问题文档片段

问题文档片段包含公式时，显示为空格。

提交类型

issue

有点复杂...

找人问问吧。

PR

小问题，全程线上修改...

一键搞定！

请选择提交类型

问题类型

规范和低错类

- 规范和低错类：

- 错别字或拼写错误，标点符号使用错误、公式错误或显示异常。

- 链接错误、空单元格、格式错误。

- 英文中包含中文字符。

- 界面和描述不一致，但不影响操作。

- 表述不通顺，但不影响理解。

- 版本号不匹配：如软件包名称、界面版本号。

易用性

- 易用性：

- 关键步骤错误或缺失，无法指导用户完成任务。

- 缺少主要功能描述、关键词解释、必要前提条件、注意事项等。

- 描述内容存在歧义指代不明、上下文矛盾。

- 逻辑不清晰，该分类、分项、分步骤的没有给出。

正确性

- 正确性：

- 技术原理、功能、支持平台、参数类型、异常报错等描述和软件实现不一致。

- 原理图、架构图等存在错误。

- 命令、命令参数等错误。

- 代码片段错误。

- 命令无法完成对应功能。

- 界面错误，无法指导操作。

- 代码样例运行报错、运行结果不符。

风险提示

- 风险提示：

- 对重要数据或系统存在风险的操作，缺少安全提示。

内容合规

- 内容合规：

- 违反法律法规，涉及政治、领土主权等敏感词。

- 内容侵权。

请选择问题类型

问题描述

点击输入详细问题描述，以帮助我们快速定位问题。

提交

文档反馈

mindformers.wrapper.MFPipelineWithLossScaleCell

class mindformers.wrapper.MFPipelineWithLossScaleCell(network, optimizer, use_clip_grad=True, max_grad_norm=1.0, scale_sense=1.0, micro_batch_num=1, local_norm=False, **kwargs)

为MindFormers的单步训练单元扩充流水线并行的损失缩放功能。

参数：

• network (Cell) - 训练网络，已包含损失函数。

• optimizer (Optimizer) - 用于更新权重的优化器。

• use_clip_grad (bool, 可选) - 是否使用梯度裁剪功能。默认值： True 。

• max_grad_norm (float, 可选) - 最大梯度约束值。默认值： 1.0 。

• scale_sense (Union[Tensor, Cell], 可选) - 用于损失缩放的 Cell 实例或 Tensor。默认值： 1.0 。

• micro_batch_num (int, 可选) - 流水线并行的微批次数。默认值： 1 。

• local_norm (bool, 可选) - 是否计算局部范数。默认值： False 。

• kwargs (Any) - 其他参数。

输入：

• (*inputs) (Tuple(Tensor)) - 形状为 $(N,\dots )$ 的输入张量元组。

输出：

5个或7个张量的元组，包括损失值、溢出标志，当前的损失缩放值，优化器学习率，全局梯度norm，局部梯度norm和对应分组size：

• loss (Tensor) - 损失值（标量）。

• overflow (Tensor) - 是否发生溢出（布尔值）。

• loss scale (Tensor) - 损失缩放值，形状为 $()$ 或 $(1,)$。

• learning rate (Tensor) - 优化器学习率。

• global norm (Tensor) - 全局梯度norm（标量），用于callback打屏日志，仅当 use_clip_grad=True 时计算，否则为None。

• local_norm (Tensor) - 分组梯度norm, 用于callback打屏日志，仅当 local_norm=True 时返回。

• size (Tensor) - 每组norm梯度的size，用于callback打屏日志，仅当 local_norm=True 时返回。

异常：

• TypeError - 如果 scale_sense 既不是 Cell 也不是 Tensor。

• ValueError - 如果 scale_sense 的形状既不是 (1,) 也不是 ()。

• ValueError - 如果并行模式不是 [ParallelMode.SEMI_AUTO_PARALLEL, ParallelMode.AUTO_PARALLEL] 之一。