ShapeEnv

class torch.fx.experimental.symbolic_shapes.ShapeEnv(*, should_record_events=None, tracked_fakes=None, **kwargs)

add_var_to_val(expr, val)

向符号环境添加新符号。

bind_symbols(placeholders, args)

给定符号列表（具有符号化尺寸的假张量）和具体参数（具有真实尺寸的常规张量）的配对列表，返回一个字典，将每个符号映射到其真实值。因此，例如，如果您有一个尺寸为 (s0, s1) 的占位符，则绑定 (2, 4) 将为您提供 {s0: 2, s1: 4}。这不能保证绑定 ShapeEnv 中的所有符号；如果符号未出现在任何占位符中，我们就无法绑定它，并且已经有替换的符号不会获得绑定。

这与 evaluate_guards 有点重复，但它足够不同，以至于似乎最简洁的做法是再复制一份。虽然如果便宜，我们会检查是否有欺骗行为，但这假定守护程序已经检查过了。

返回类型

dict[sympy.Symbol, int]

bound_sympy(expr, size_oblivious=False)

给定一个 sympy 表达式，计算它可能的值的 ValueRanges 边界。

返回类型

ValueRanges

check_equal(other)

比较另一个 ShapeEnv 是否等价。

cleanup()

打破引用循环。

这会销毁堆栈。如果您确实想保留它们，我们只需要一种方法来打破代码对象的引用。

create_symbol(val, source, dynamic_dim=DimDynamic.DUCK, constraint_dim=None, positive=True, do_not_specialize_zero_one=False, symbolic_context=None)

创建此 ShapeEnv 跟踪的新符号。

返回类型

Expr

create_symbolic_sizes_strides_storage_offset(ex, source, *, symbolic_context=None)

返回给定张量的符号化尺寸和步幅列表。我们尽力用尺寸来表示步幅，以避免引入新的符号变量。

返回类型

tuple[tuple[IntLikeType, …], tuple[IntLikeType, …], IntLikeType]

create_symboolnode(sym)

从 sympy 布尔表达式创建 SymBool 对象

返回类型

SymBool

create_symfloatnode(sym, *, hint, source=None)

从符号表达式创建 SymFloat 值

返回类型

FloatLikeType

create_symintnode(sym, *, hint, source=None)

从符号表达式创建 SymInt 值

如果您知道要创建的 SymInt 的当前提示值，请将其传入 hint。否则，传递 None，我们将尽最大努力猜测

返回类型

IntLikeType

create_unbacked_symbool()

创建一个没有提示值的符号布尔值

返回类型

SymBool

create_unbacked_symfloat()

创建一个没有提示值的符号浮点数

返回类型

SymFloat

create_unbacked_symint(source=None)

创建一个没有提示值的符号整数

返回类型

SymInt

create_unspecified_symbol(val, source, dynamic_dim=DimDynamic.DUCK, constraint_dim=None, symbolic_context=None)

创建一个值未指定（unspecified）的符号

与标准符号相比，我们不假定值为正数，也不对零或一值进行特殊处理。

返回类型

Expr

create_unspecified_symint_and_symbol(value, source, dynamic_dim)

创建一个包装了新的未指定符号的 SymInt

返回类型

IntLikeType

deserialize_symexpr(code)

供 compile_fx 用于反序列化 symexprs

返回类型

Union[SymInt, SymFloat, SymBool]

evaluate_expr(orig_expr, hint=None, fx_node=None, size_oblivious=False, fallback_value=None, *, forcing_spec=False)

给定一个表达式，对其进行评估，并在必要时添加 guard。当 fallback_value 不为 None 时，函数将返回 fallback_value 而不是因数据依赖错误而失败。

返回类型

基本

evaluate_guards_expression(code, args)

预计与 produce_guards_expression() 一起使用。为给定的具体参数评估由 produce_guards_expression 生成的表达式。

返回类型

布尔值

evaluate_guards_for_args(placeholders, args, *, ignore_static=True)

为图的占位符值生成 guards，并使用 args 评估 guards

返回类型

布尔值

evaluate_sym_node(sym_node, size_oblivious=False, fallback_value=None)

给定一个 SymNode，对其 sym_node.expr 进行评估，并在必要时添加 guards。

返回类型

基本

evaluate_symexpr(code)

供 compile_fx 用于评估 symexprs

返回类型

Union[int, float, bool]

format_guards(verbose=False)

如果 verbose 为 True，则格式化此 shape env 的 guard 表达式，并附带可选的 traceback 信息

返回类型

str

freeze()

冻结此 ShapeEnv 以停止累积 guards

冻结的 ShapeEnv 将忽略其上生成的任何后续 guards，仅发出警告，这可能导致准确性问题。

freeze_runtime_asserts()

冻结此 ShapeEnv 以停止添加延迟的运行时断言。

如果您尝试安装新的运行时断言，而它已被冻结，则会引发错误。这可能表示存在降低（lowering）冲突，或者可能表示我们静态已知某事实际上为 True，但我们正在以一种不明确可消除的方式再次检查它。

get_axioms(symbols=None, compute_hint=False)

给定表达式中的符号，它返回所有运行时断言，这些断言是将这些符号与所有 guards 串联起来的。如果 symbols 为 None，则返回所有运行时断言（以及所有 guards）

返回类型

tuple[‘sympy.logic.boolalg.Boolean’, …]

get_implications(e)

给定一个表达式，它返回一个从中推导出的谓词列表

返回类型

tuple[tuple[‘sympy.logic.boolalg.Boolean’, sympy.logic.boolalg.BooleanAtom], …]

get_nontrivial_guards()

返回一个 guard 表达式列表，这些表达式不是静态已知的（即不是平凡的）

返回类型

list[‘sympy.logic.boolalg.Boolean’]

get_pruned_guards(symints)

获取 guards 列表，但经过修剪，使其仅提供引用输入中 symints 的 guards

返回类型

list[torch._guards.ShapeGuard]

guard_or_defer_runtime_assert(orig_expr, msg, fx_node=None)

添加一个 guard，使得 orig_expr 为 True（如果可以的话），或者回退到添加一个在运行时检查的断言。

参数

• orig_expr (sympy.Expr) – 断言为 True 的布尔表达式

• msg (str) – 断言失败时显示的错误消息

• fx_node (Optional, torch.fx.Node) – 对应于表达式的 self.graph 中的节点（如果适用）

返回类型

布尔值

ignore_fresh_unbacked_symbols()

指示新分配的未备份 SymInts 正在被丢弃

返回类型

Iterator[None]

is_unbacked_symint(symbol)

检查 sympy 符号是否符合未备份符号的命名约定

返回类型

布尔值

patch_source_specialization(source, check_fn)

暂时向 ShapeEnv 添加符号级别的公理。这在您想要“分叉”并拥有并行 ShapeEnv 时非常有用。例如，我们在进行多图编译时使用它，以便支持具有不同专门化级别的各种图。

此上下文管理器允许基于应用于与源关联的符号的专门化函数，暂时将约束添加到 shape 环境中。

参数

• source (Source) – 要专门化的符号的来源

• check_fn (Callable[[Symbol], Expr]) – 一个函数，它接受一个 sympy Symbol 并返回一个 sympy 表达式，该表达式表示要应用的约束/专门化

返回类型

Iterator[None]

produce_guards(*args, **kwargs)

与 produce_guards_verbose 类似，但仅返回非 verbose 的 Python guard 表达式（不生成 verbose guards）。

返回类型

list[str]

produce_guards_expression(placeholders, *, guards=None, ignore_static=True)

预计与 evaluate_guards_expression() 一起使用。为给定的占位符生成 guards，并返回一个字符串表达式，该表达式将由 evaluate_guards_expression 使用占位符的具体值进行评估。

返回类型

Optional[str]

produce_guards_verbose(placeholders, sources, source_ref=<function ShapeEnv.<lambda>>, *, guards=None, input_contexts=None, equalities_inputs=None, _simplified=False, ignore_static=True, langs=('python', 'verbose_python'))

生成一系列 guard 字符串，当在定义了所有源的张量的上下文中进行评估时，这些字符串根据列表中的 guard 是否评估为 True 来返回 True 或 False。主要由 Dynamo 使用，但这也对手动测试 guards 有帮助（请参阅 evaluate_guards_for_args）

为了方便测试，允许源是 str，在这种情况下，我们将假设它是一个 LocalSource

simplified 允许您省略 duck sizing、equality 和 0/1 guards。这对于您不关心样板 guards 的测试很有用，并且可能也有助于用户输出（但要小心；一些 equality guards 是非平凡的！如果 simplified 输出也能打印它们就更好了）。它是私有的，因为它不用于常规用途

默认情况下，以 python 和带 verbose 注释的 python（verbose）格式返回 guards。

返回类型

list[_ShapeGuardsHelper]

replace(expr)

将符号替换应用于给定表达式中的任何符号。

返回类型

_SympyT

set_unbacked_var_to_val(k, v)

仅在 propagate_real_tensors 时使用；为未备份的符号注册一个值，该值可用作最后的手段来解析提示。

simplify(expr, size_oblivious=False)

使用已知的约束和替换来简化给定的 expr

返回类型

_SympyT

size_hint(expr, *, allow_none=False)

从底层的 shape 获取给定表达式的大小提示。不引入 guard，因此仅在您可以保证代码对于任意 shape 仍然有效时使用（例如，用于优化决策）

返回类型

Optional[Basic]

suppress_guards()

上下文管理器，用于忽略其内部生成的所有 guards

返回类型

_GeneratorContextManager[None]