TellMeStepOrLossHook构造函数

产品支持情况

产品	是否支持
Atlas A3 训练系列产品/Atlas A3 推理系列产品	√
Atlas A2 训练系列产品	√
Atlas 800I A2 推理产品/A200I A2 Box 异构组件	x
Atlas 200I/500 A2 推理产品	x
Atlas 推理系列产品	x
Atlas 训练系列产品	√
Atlas 200/300/500 推理产品	x

针对Atlas A3 推理系列产品，仅支持在线推理特性。

功能说明

TellMeStepOrLossHook类的构造函数，TellMeStepOrLossHook用于告知底层软件“当前执行的步数和总的步数”或者“当前执行的loss和最终的目标loss”。

函数原型

1	def __init__(self,step=None,total_step=None,loss=None,final_loss=None)

参数说明

参数名	输入/输出	描述
step	输入	表示当前步数的Tensor的名称。
total_step	输入	训练脚本总的训练步数。
loss	输入	表示当前loss的Tensor的名称。
final_loss	输入	训练脚本最终的目标loss。

返回值

返回TellMeStepOrLossHook类对象

约束说明

Iterations_per_loop>1的场景下，会按照每增加Iterations_per_loop数量的步数，就会告知底层软件当前执行的步数或者loss，无法做到每增加1步就告知底层软件一次，可能对底层软件某些依赖此hook函数结果的功能产生影响

调用示例

from npu_bridge.npu_init import *
est = NPUEstimator(
        model_fn=model_fn,
        config=config,
        params=params)
hooks = []
max_steps = 10000
# step分割的方式，本示例当前step的tensor名称是global_step:0，总step数是10000，请根据实际step的tensor名称和总step数进行配置
my_hook = TellMeStepOrLossHook(step='global_step:0', total_step=max_steps)
# loss分割的方式，本示例当前loss的tensor名称是loss:0，目标loss是7.1，请根据实际loss的tensor名称和目标loss值进行配置
# my_hook = TellMeStepOrLossHook(loss='loss:0', final_loss=7.1)
hooks.append(my_hook)
# 开启训练
est.train(
          input_fn=imagenet_train.input_fn,
          max_steps=max_steps 
          hooks=hooks)

父主题： npu_bridge.estimator.npu.npu_hook