torch.jit.annotate¶
- torch.jit.annotate(the_type, the_value)[源代码]¶
用于在 TorchScript 编译器中给出 the_value 的类型。
此方法是一个传递函数,它返回 the_value,用于提示 TorchScript 编译器 the_value 的类型。在 TorchScript 之外运行时,它是一个空操作。
虽然 TorchScript 可以推断大多数 Python 表达式的正确类型,但有些情况下类型推断可能是错误的,包括
空容器,如 [] 和 {},TorchScript 假设它们是 Tensor 的容器
可选类型,如 Optional[T],但分配了类型为 T 的有效值,TorchScript 会假设它是类型 T 而不是 Optional[T]
请注意,annotate() 无法帮助 torch.nn.Module 子类的 __init__ 方法,因为它是在急切模式下执行的。要注释 torch.nn.Module 属性的类型,请改用
Attribute()
。示例
import torch from typing import Dict @torch.jit.script def fn(): # Telling TorchScript that this empty dictionary is a (str -> int) dictionary # instead of default dictionary type of (str -> Tensor). d = torch.jit.annotate(Dict[str, int], {}) # Without `torch.jit.annotate` above, following statement would fail because of # type mismatch. d["name"] = 20
- 参数
the_type – 应传递给 TorchScript 编译器作为 the_value 的类型提示的 Python 类型
the_value – 要提示类型的值或表达式。
- 返回值
the_value 被传递回作为返回值。