torch.fx ¶

注意

保证此 API 的向后兼容性。

property code: str¶: 返回由此 GraphModule 基础的 Graph 生成的 Python 代码。

delete_all_unused_submodules()[source][source]¶

从 self 中删除所有未使用的子模块。

如果以下任一项为真，则认为一个 Module “已使用”： 1. 它具有已使用的子模块 2. 其 forward 通过 call_module 节点直接调用 3. 它具有一个非 Module 属性，该属性从 get_attr 节点使用。

可以调用此方法来清理一个 nn.Module，而无需手动在每个未使用的子模块上调用 delete_submodule。

注意

保证此 API 的向后兼容性。

delete_submodule(target)[source][source]¶

从 self 中删除给定的子模块。

如果 target 不是有效目标，则不会删除该模块。

参数

target (str) – 新子模块的完全限定字符串名称（有关如何指定完全限定字符串，请参见 nn.Module.get_submodule 中的示例）。

返回值

目标字符串是否引用了: 我们要删除的子模块。返回值 False 表示 target 不是对子模块的有效引用。

返回类型

注意

保证此 API 的向后兼容性。

property graph: Graph¶: 返回此 GraphModule 基础的 Graph

print_readable(print_output=True, include_stride=False, include_device=False, colored=False)[source][source]¶: 返回为当前 GraphModule 及其子 GraphModule 生成的 Python 代码

警告

此 API 尚处于实验阶段，并且不向后兼容。

recompile()[source][source]¶

从此 GraphModule 的 graph 属性重新编译它。这应该在编辑包含的 graph 之后调用，否则此 GraphModule 生成的代码将过时。

注意

保证此 API 的向后兼容性。

返回类型: PythonCode

to_folder(folder, module_name='FxModule')[source][source]¶

将模块转储到带有 module_name 的 folder 中，以便可以

使用 from <folder> import <module_name> 导入它

参数

folder (Union[str, os.PathLike])：将代码写入到的文件夹

module_name (str)：写入代码时用于 Module 的顶级名称
写入代码

警告

此 API 尚处于实验阶段，并且不向后兼容。

class torch.fx.Graph(owning_module=None, tracer_cls=None, tracer_extras=None)[source][source]¶

Graph 是 FX 中间表示中使用的主要数据结构。它由一系列 Node 组成，每个 Node 代表调用点（或其他语法结构）。 Node 的列表共同构成一个有效的 Python 函数。

例如，以下代码

import torch
import torch.fx


class MyModule(torch.nn.Module):
    def __init__(self):
        super().__init__()
        self.param = torch.nn.Parameter(torch.rand(3, 4))
        self.linear = torch.nn.Linear(4, 5)

    def forward(self, x):
        return torch.topk(
            torch.sum(self.linear(x + self.linear.weight).relu(), dim=-1), 3
        )


m = MyModule()
gm = torch.fx.symbolic_trace(m)

将产生以下 Graph

print(gm.graph)

graph(x):
    %linear_weight : [num_users=1] = self.linear.weight
    %add_1 : [num_users=1] = call_function[target=operator.add](args = (%x, %linear_weight), kwargs = {})
    %linear_1 : [num_users=1] = call_module[target=linear](args = (%add_1,), kwargs = {})
    %relu_1 : [num_users=1] = call_method[target=relu](args = (%linear_1,), kwargs = {})
    %sum_1 : [num_users=1] = call_function[target=torch.sum](args = (%relu_1,), kwargs = {dim: -1})
    %topk_1 : [num_users=1] = call_function[target=torch.topk](args = (%sum_1, 3), kwargs = {})
    return topk_1

有关 Graph 中表示的操作的语义，请参见 Node。

注意

保证此 API 的向后兼容性。

__init__(owning_module=None, tracer_cls=None, tracer_extras=None)[source][source]¶

构造一个空的 Graph。

注意

保证此 API 的向后兼容性。

call_function(the_function, args=None, kwargs=None, type_expr=None)[source][source]¶

插入一个 call_function Node 到 Graph 中。一个 call_function 节点表示对一个 Python 可调用对象（callable）的调用，由 the_function 指定。

参数

the_function (Callable[..., Any]) – 要调用的函数。可以是任何 PyTorch 运算符、Python 函数或 builtins 或 operator 命名空间的成员。
args (Optional[Tuple[Argument, ...]]) – 要传递给被调用函数的位置参数。
kwargs (Optional[Dict[str, Argument]]) – 要传递给被调用函数的关键字参数。
type_expr (Optional[Any]) – 可选的类型注解，表示此节点的输出将具有的 Python 类型。

返回值

新创建并插入的 call_function 节点。

返回类型

注意

与 Graph.create_node() 一样，此方法适用相同的插入点和类型表达式规则。

注意

保证此 API 的向后兼容性。

call_method(method_name, args=None, kwargs=None, type_expr=None)[source][source]¶

插入一个 call_method Node 到 Graph 中。一个 call_method 节点表示对 args 的第 0 个元素调用给定方法。

参数

method_name (str) – 要应用于 self 参数的方法的名称。例如，如果 args[0] 是表示 Tensor 的 Node，那么要对该 Tensor 调用 relu()，请将 relu 传递给 method_name。
args (Optional[Tuple[Argument, ...]]) – 要传递给被调用方法的位置参数。请注意，这应该包括一个 self 参数。
kwargs (Optional[Dict[str, Argument]]) – 要传递给被调用方法的关键字参数。
type_expr (Optional[Any]) – 可选的类型注解，表示此节点的输出将具有的 Python 类型。

返回值

新创建并插入的 call_method 节点。

返回类型

注意

与 Graph.create_node() 一样，此方法适用相同的插入点和类型表达式规则。

注意

保证此 API 的向后兼容性。

call_module(module_name, args=None, kwargs=None, type_expr=None)[source][source]¶

插入一个 call_module Node 到 Graph 中。一个 call_module 节点表示在 Module 层次结构中调用 Module 的 forward() 函数。

参数

module_name (str) – 要调用的 Module 在 Module 层次结构中的限定名称。例如，如果跟踪的 Module 有一个名为 foo 的子模块，该子模块有一个名为 bar 的子模块，则应将限定名称 foo.bar 作为 module_name 传递以调用该模块。
args (Optional[Tuple[Argument, ...]]) – 要传递给被调用方法的位置参数。请注意，这不应包括一个 self 参数。
kwargs (Optional[Dict[str, Argument]]) – 要传递给被调用方法的关键字参数。
type_expr (Optional[Any]) – 可选的类型注解，表示此节点的输出将具有的 Python 类型。

返回值

新创建并插入的 call_module 节点。

返回类型

注意

与 Graph.create_node() 一样，此方法适用相同的插入点和类型表达式规则。

注意

保证此 API 的向后兼容性。

create_node(op, target, args=None, kwargs=None, name=None, type_expr=None)[source][source]¶

创建一个 Node 并将其添加到 Graph 中的当前插入点。请注意，可以通过 Graph.inserting_before() 和 Graph.inserting_after() 设置当前插入点。

参数

op (str) – 此节点的 opcode。为 'call_function'、'call_method'、'get_attr'、'call_module'、'placeholder' 或 'output' 之一。这些 opcodes 的语义在 Graph docstring 中描述。
args (Optional[Tuple[Argument, ...]]) – 是此节点的参数元组。
kwargs (Optional[Dict[str, Argument]]) – 此节点的 kwargs。
name (Optional[str]) – Node 的可选字符串名称。这将影响 Python 生成的代码中分配给值的名称。
type_expr (Optional[Any]) – 可选的类型注解，表示此节点的输出将具有的 Python 类型。

返回值

新创建并插入的节点。

返回类型

注意

保证此 API 的向后兼容性。

eliminate_dead_code(is_impure_node=None)[source][source]¶

根据每个节点的用户数量以及节点是否具有任何副作用，从图中删除所有无用代码。在调用之前，必须对图进行拓扑排序。

参数

is_impure_node (可选[Callable[[Node], bool]]) – 一个函数，用于返回
None (节点是否是不纯的。如果这个值为) –
to (则默认行为是) –
Node.is_impure。 (使用) –

返回值

该 pass 是否导致图发生改变。

返回类型

示例

在消除无效代码之前，下面的 a = x + 1 中的 a 没有使用者，因此可以从图中消除，而不会产生影响。

def forward(self, x):
    a = x + 1
    return x + self.attr_1

消除无效代码后，a = x + 1 已被移除，forward 的其余部分保留。

def forward(self, x):
    return x + self.attr_1

警告

无效代码消除有一些启发式方法来避免移除具有副作用的节点 (参见 Node.is_impure)，但总的来说覆盖率非常差，因此您应该假定此方法调用是不安全的，除非您知道您的 FX 图完全由功能性操作组成，或者您提供自己的自定义函数来检测具有副作用的节点。

注意

保证此 API 的向后兼容性。

erase_node(to_erase)[source][source]¶

从 Graph 中擦除一个 Node。如果该节点在 Graph 中仍然有使用者，则抛出异常。

参数: to_erase (Node) – 要从 Graph 中擦除的 Node。

注意

保证此 API 的向后兼容性。

find_nodes(*, op, target=None, sort=True)[source][source]¶

允许快速查询节点

参数

op (str) – 操作的名称
target (Optional[Target]) – 节点的 target。对于 call_function，target 是必需的。对于其他操作，target 是可选的。
sort (bool) – 是否按照节点在图中出现的顺序返回节点。

返回值

具有请求的 op 和 target 的节点的迭代器。

警告

此 API 尚处于实验阶段，并且不向后兼容。

get_attr(qualified_name, type_expr=None)[source][source]¶

在 Graph 中插入一个 get_attr 节点。get_attr Node 表示从 Module 层次结构中获取一个属性。

参数

qualified_name (str) – 要检索的属性的完全限定名称。例如，如果跟踪的 Module 有一个名为 foo 的子模块，该子模块有一个名为 bar 的子模块，该子模块有一个名为 baz 的属性，则应将限定名称 foo.bar.baz 作为 qualified_name 传递。
type_expr (Optional[Any]) – 可选的类型注解，表示此节点的输出将具有的 Python 类型。

返回值

新创建并插入的 get_attr 节点。

返回类型

注意

此方法与 Graph.create_node 应用相同的插入点和类型表达式规则。

注意

保证此 API 的向后兼容性。

graph_copy(g, val_map, return_output_node=False)[source][source]¶

将给定图中的所有节点复制到 self 中。

参数

g (Graph) – 要从中复制节点的源图。
val_map (Dict[Node, Node]) – 一个字典，它将被填充，其中包含从 g 中的节点到 self 中的节点的映射。请注意，可以传入包含值的 val_map，以覆盖某些值的复制。

返回值

self 中的值现在等同于 g 中的输出值，如果 g 有一个 output 节点。否则为 None。

返回类型

Optional[Union[tuple[‘Argument’, …], Sequence[Argument], Mapping[str, Argument], slice, range, Node, str, int, float, bool, complex, dtype, Tensor, device, memory_format, layout, OpOverload, SymInt, SymBool, SymFloat]]

注意

保证此 API 的向后兼容性。

inserting_after(n=None)[source][source]¶

设置 create_node 和伴随方法将插入到图中的点。

在 'with' 语句中使用时，这将暂时设置插入点，然后在 with 语句退出时恢复它。

with g.inserting_after(n):
    ...  # inserting after node n
...  # insert point restored to what it was previously
g.inserting_after(n)  #  set the insert point permanently

参数

n (Optional[Node]): 要在其后插入的节点。如果为 None，则将在整个图的开头之后插入。
整个图的开头。

返回值: 一个资源管理器，它将在 __exit__ 上恢复插入点。

注意

保证此 API 的向后兼容性。

inserting_before(n=None)[source][source]¶

设置 create_node 和伴随方法将插入到图中的点。

在 'with' 语句中使用时，这将暂时设置插入点，然后在 with 语句退出时恢复它。

with g.inserting_before(n):
    ...  # inserting before node n
...  # insert point restored to what it was previously
g.inserting_before(n)  #  set the insert point permanently

参数

n (Optional[Node]): 要在其之前插入的节点。如果为 None，则将在之前插入
整个图的开头。

返回值: 一个资源管理器，它将在 __exit__ 上恢复插入点。

注意

保证此 API 的向后兼容性。

lint()[source][source]¶: 对该图运行各种检查，以确保其格式正确。具体来说：- 检查节点是否具有正确的所有权（属于此图）- 检查节点是否按拓扑顺序出现 - 如果此图拥有 GraphModule，则检查目标是否存在于该 GraphModule 中

注意

保证此 API 的向后兼容性。

node_copy(node, arg_transform=<function Graph.<lambda>>)[source][source]¶

将节点从一个图复制到另一个图。 arg_transform 需要将参数从节点所在的图转换为 self 所在的图。示例

# Copying all the nodes in `g` into `new_graph`
g: torch.fx.Graph = ...
new_graph = torch.fx.graph()
value_remap = {}
for node in g.nodes:
    value_remap[node] = new_graph.node_copy(node, lambda n: value_remap[n])

参数

node (Node) – 要复制到 self 中的节点。
arg_transform (Callable[[Node], Argument]) – 一个函数，将节点 node 的 args 和 kwargs 中的 Node 参数转换为 self 中的等效参数。在最简单的情况下，这应该从一个表中检索一个值，该表将原始图中的节点映射到 self。

返回类型

注意

保证此 API 的向后兼容性。

property nodes: _node_list¶

获取构成此图的节点列表。

请注意，此 Node 列表表示形式是一个双向链表。迭代期间的修改（例如，删除节点，添加节点）是安全的。

返回值: 节点的双向链表。请注意，可以在此列表上调用 reversed 以切换迭代顺序。

on_generate_code(make_transformer)[source][source]¶

注册一个转换器函数，在生成python代码时使用

参数

make_transformer (Callable[[Optional[TransformCodeFunc]], TransformCodeFunc])
一个返回要注册的代码转换器的函数。该函数由 on_generate_code 调用以获取代码转换器。

此函数还将其当前注册的代码转换器（如果未注册任何内容，则为 None）作为其输入给出，以防不希望覆盖它。这对于将代码转换器链接在一起很有用。

返回值
一个上下文管理器，当在 with 语句中使用时，会自动恢复先前注册的代码转换器。

示例
gm: fx.GraphModule = ...


# This is a code transformer we want to register. This code
# transformer prepends a pdb import and trace statement at the very
# beginning of the generated torch.fx code to allow for manual
# debugging with the PDB library.
def insert_pdb(body):
    return ["import pdb; pdb.set_trace()\n", *body]


# Registers `insert_pdb`, and overwrites the current registered
# code transformer (given by `_` to the lambda):
gm.graph.on_generate_code(lambda _: insert_pdb)

# Or alternatively, registers a code transformer which first
# runs `body` through existing registered transformer, then
# through `insert_pdb`:
gm.graph.on_generate_code(
    lambda current_trans: (
        lambda body: insert_pdb(current_trans(body) if current_trans else body)
    )
)

gm.recompile()
gm(*inputs)  # drops into pdb
此函数也可以用作上下文管理器，其优点是自动恢复先前注册的代码转换器
# ... continue from previous example

with gm.graph.on_generate_code(lambda _: insert_pdb):
    # do more stuff with `gm`...
    gm.recompile()
    gm(*inputs)  # drops into pdb

# now previous code transformer is restored (but `gm`'s code with pdb
# remains - that means you can run `gm` with pdb here too, until you
# run next `recompile()`).

警告

此 API 尚处于实验阶段，并且不向后兼容。

output(result, type_expr=None)[source][source]¶

将 output Node 插入到 Graph 中。 output 节点表示 Python 代码中的 return 语句。 result 是应返回的值。

参数

result (Argument) – 要返回的值。
type_expr (Optional[Any]) – 可选的类型注解，表示此节点的输出将具有的 Python 类型。

注意

此方法与 Graph.create_node 应用相同的插入点和类型表达式规则。

注意

保证此 API 的向后兼容性。

output_node()[source][source]¶

警告

此 API 尚处于实验阶段，并且不向后兼容。

返回类型: Node

placeholder(name, type_expr=None, default_value)[source][source]¶

将 placeholder 节点插入到 Graph 中。 placeholder 表示函数输入。

参数

name (str) – 输入值的名称。这对应于此 Graph 表示的函数的 positional 参数的名称。
type_expr (Optional[Any]) – 一个可选的类型注解，表示此节点的输出将具有的 Python 类型。在某些情况下，这对于正确的代码生成是必需的（例如，当函数随后在 TorchScript 编译中使用时）。
default_value (Any) – 此函数参数应采用的默认值。注意：为了允许 None 作为默认值，应将 inspect.Signature.empty 作为此参数传递，以指定该参数_没有_默认值。

返回类型

注意

此方法与 Graph.create_node 应用相同的插入点和类型表达式规则。

注意

保证此 API 的向后兼容性。

print_tabular()[source][source]¶: 以表格格式打印图的中间表示。请注意，此 API 需要安装 tabulate 模块。

注意

保证此 API 的向后兼容性。

process_inputs(*args)[source][source]¶: 处理 args，以便可以将它们传递给 FX 图。

警告

此 API 尚处于实验阶段，并且不向后兼容。

process_outputs(out)[source][source]¶: 警告

此 API 尚处于实验阶段，并且不向后兼容。

python_code(root_module, *, verbose=False, include_stride=False, include_device=False, colored=False)[source][source]¶

将此 Graph 转换为有效的 Python 代码。

参数: root_module (str) – 用于查找限定名称目标的根模块的名称。这通常是“self”。
返回值: src：表示对象的 Python 源代码 globals：src 中全局名称的字典 -> 它们引用的对象。
返回类型: 一个 PythonCode 对象，由两个字段组成

注意

保证此 API 的向后兼容性。

set_codegen(codegen)[source][source]¶

警告

此 API 尚处于实验阶段，并且不向后兼容。

class torch.fx.Node(graph, name, op, target, args, kwargs, return_type=None)[source][source]¶

Node 是表示 Graph 中各个操作的数据结构。在大多数情况下，Nodes 表示对各种实体（如运算符、方法和模块）的调用位置（一些例外情况包括指定函数输入和输出的节点）。每个 Node 都有一个由其 op 属性指定的函数。 op 的每个值的 Node 语义如下：

placeholder 表示函数输入。 name 属性指定此值将采用的名称。 target 类似地是参数的名称。 args 包含：1) 空；或者 2) 表示函数输入的默认参数的单个参数。 kwargs 可以忽略。占位符对应于图形打印输出中的函数参数（例如，x）。
get_attr 从模块层次结构中检索参数。 name 类似地是将获取结果分配到的名称。 target 是参数在模块层次结构中的位置的完全限定名称。 args 和 kwargs 可以忽略。
call_function 将一个自由函数应用于某些值。 name 类似地是分配给值的名称。 target 是要应用的函数。 args 和 kwargs 表示函数的参数，遵循 Python 调用约定。
call_module 将模块层次结构中的模块的 forward() 方法应用于给定的参数。 name 与之前相同。 target 是要调用的模块在模块层次结构中的完全限定名称。 args 和 kwargs 表示调用模块的参数，不包括 self 参数。
call_method 调用值上的方法。 name 相似。 target 是应用于 self 参数的方法的字符串名称。 args 和 kwargs 表示调用模块的参数，包括 self 参数。
output 在其 args[0] 属性中包含跟踪函数的输出。这对应于图形打印输出中的“return”语句。

注意

保证此 API 的向后兼容性。

property all_input_nodes: list['Node']¶

返回作为此节点输入的全部节点。这等效于迭代 args 和 kwargs，并且仅收集作为节点的值。

返回值: 出现在此 Node 的 args 和 kwargs 中的 Nodes 列表，按该顺序排列。

append(x)[source][source]¶

在此节点之后，在图形的节点列表中插入 x。等效于 self.next.prepend(x)

参数: x (Node) – 要放在此节点之后的节点。必须是同一图形的成员。

注意

保证此 API 的向后兼容性。

property args: tuple[Union[tuple['Argument', ...], collections.abc.Sequence['Argument'], collections.abc.Mapping[str, 'Argument'], slice, range, torch.fx.node.Node, str, int, float, bool, complex, torch.dtype, torch.Tensor, torch.device, torch.memory_format, torch.layout, torch._ops.OpOverload, torch.SymInt, torch.SymBool, torch.SymFloat, NoneType], ...]¶

这个 Node 的参数元组。参数的解释取决于节点的 opcode。有关更多信息，请参阅 Node 文档字符串。

允许对此属性进行赋值。所有使用和用户的统计信息都会在赋值时自动更新。

format_node(placeholder_names=None, maybe_return_typename=None)[source][source]¶

返回 self 的描述性字符串表示形式。

此方法可以不带参数使用，作为调试实用程序。

此函数也在 Graph 的 __str__ 方法内部使用。 placeholder_names 和 maybe_return_typename 中的字符串共同构成了此 Graph 的周围 GraphModule 中自动生成的 forward 函数的签名。否则不应使用 placeholder_names 和 maybe_return_typename。

参数

placeholder_names (Optional[list[str]]) – 一个列表，将存储表示生成的 forward 函数中占位符的格式化字符串。仅供内部使用。
maybe_return_typename (Optional[list[str]]) – 一个单元素列表，将存储表示生成的 forward 函数输出的格式化字符串。仅供内部使用。

返回值

如果 1) 我们将 format_node 用作内部辅助函数: 在 Graph 的 __str__ 方法中，并且 2) self 是一个占位符节点，则返回 None。否则，返回当前节点的描述性字符串表示形式。

返回类型

str

注意

保证此 API 的向后兼容性。

insert_arg(idx, arg)[source][source]¶

使用给定的索引将一个位置参数插入到参数列表中。

参数

idx (int) – 要在其之前插入元素的 self.args 中的元素的索引。
arg (Argument) – 要插入到 args 中的新参数值

注意

保证此 API 的向后兼容性。

is_impure()[source][source]¶

返回此操作是否为不纯的，即如果它的操作是占位符或输出，或者如果 call_function 或 call_module 是不纯的。

返回值: 该操作是否为不纯。
返回类型: bool

警告

此 API 尚处于实验阶段，并且不向后兼容。

property kwargs: dict[str, Union[tuple['Argument', ...], collections.abc.Sequence['Argument'], collections.abc.Mapping[str, 'Argument'], slice, range, torch.fx.node.Node, str, int, float, bool, complex, torch.dtype, torch.Tensor, torch.device, torch.memory_format, torch.layout, torch._ops.OpOverload, torch.SymInt, torch.SymBool, torch.SymFloat, NoneType]]¶

这个 Node 的关键字参数的字典。参数的解释取决于节点的 opcode。有关更多信息，请参阅 Node 文档字符串。

允许对此属性进行赋值。所有使用和用户的统计信息都会在赋值时自动更新。

property next: Node¶

返回 Nodes 链表中的下一个 Node。

返回值: Nodes 链表中的下一个 Node。

normalized_arguments(root, arg_types=None, kwarg_types=None, normalize_to_only_use_kwargs=False)[source][source]¶

返回 Python 目标的标准化参数。这意味着 args/kwargs 将与模块/函数的签名匹配，如果 normalize_to_only_use_kwargs 为真，则仅以位置顺序返回 kwargs。还会填充默认值。不支持仅位置参数或 varargs 参数。

支持模块调用。

可能需要 arg_types 和 kwarg_types 以消除重载的歧义。

参数

root (torch.nn.Module) – 用于解析模块目标的模块。
arg_types (Optional[Tuple[Any]]) – args 的 arg 类型元组
kwarg_types (Optional[Dict[str, Any]]) – kwargs 的 arg 类型字典
normalize_to_only_use_kwargs (bool) – 是否标准化为仅使用 kwargs。

返回值

如果成功，则返回 NamedTuple ArgsKwargsPair 或 None。

返回类型

Optional[ArgsKwargsPair]

警告

此 API 尚处于实验阶段，并且不向后兼容。

prepend(x)[源代码][源代码]¶

将 x 插入到图中节点列表中的此节点之前。示例

Before: p -> self
        bx -> x -> ax
After:  p -> x -> self
        bx -> ax

参数: x (Node) – 要放在此节点之前的节点。必须是同一图的成员。

注意

保证此 API 的向后兼容性。

property prev: Node¶

返回节点链接列表中的上一个 Node。

返回值: 节点链接列表中的上一个 Node。

replace_all_uses_with(replace_with, delete_user_cb=<function Node.<lambda>>, *, propagate_meta=False)[源代码][源代码]¶

将图中 self 的所有用法替换为节点 replace_with。

参数

replace_with (Node) – 用于替换 self 所有用法的节点。
delete_user_cb (Callable) – 用于确定是否应删除 self 节点的给定用户的回调函数。
propagate_meta (bool) – 是否将原始节点的 .meta 字段上的所有属性复制到替换节点。为了安全起见，只有当替换节点尚未具有现有的 .meta 字段时，才能这样做。

返回值

进行此更改的节点列表。

返回类型

list[‘Node’]

注意

保证此 API 的向后兼容性。

replace_input_with(old_input, new_input)[源代码][源代码]¶

遍历 self 的输入节点，并将所有 old_input 实例替换为 new_input。

参数

old_input (Node) – 要替换的旧输入节点。
new_input (Node) – 用于替换 old_input 的新输入节点。

注意

保证此 API 的向后兼容性。

property stack_trace: Optional[str]¶

返回在跟踪期间记录的 Python 堆栈跟踪（如果有）。使用 fx.Tracer 跟踪时，此属性通常由 Tracer.create_proxy 填充。要在跟踪期间记录堆栈跟踪以进行调试，请在 Tracer 实例上设置 record_stack_traces = True。使用 dynamo 跟踪时，此属性将默认由 OutputGraph.create_proxy 填充。

stack_trace 的最内层帧将位于字符串的末尾。

update_arg(idx, arg)[源代码][源代码]¶

更新现有的位置参数以包含新值 arg。调用后，self.args[idx] == arg。

参数

idx (int) – 要更新的元素在 self.args 中的索引
arg (Argument) – 要写入 args 的新参数值

注意

保证此 API 的向后兼容性。

update_kwarg(key, arg)[源代码][源代码]¶

更新现有的关键字参数以包含新值 arg。调用后，self.kwargs[key] == arg。

参数

key (str) – 要更新的元素在 self.kwargs 中的键
arg (Argument) – 要写入 kwargs 的新参数值

注意

保证此 API 的向后兼容性。

class torch.fx.Tracer(autowrap_modules=(math,), autowrap_functions=())[源代码][源代码]¶

Tracer 是实现 torch.fx.symbolic_trace 的符号跟踪功能的类。调用 symbolic_trace(m) 等效于 Tracer().trace(m)。

可以对 Tracer 进行子类化以覆盖跟踪过程的各种行为。可以在此类的方法的文档字符串中找到可覆盖的不同行为的描述。

注意

保证此 API 的向后兼容性。

call_module(m, forward, args, kwargs)[源代码][源代码]¶

此方法指定 Tracer 在遇到对 nn.Module 实例的调用时的行为。

默认情况下，该行为是检查被调用的模块是否是叶模块，通过 is_leaf_module。如果是，则发出一个 call_module 节点，该节点在 Graph 中引用 m。否则，正常调用 Module，跟踪其 forward 函数中的操作。

可以覆盖此方法来创建嵌套的跟踪 GraphModule，或者在跨 Module 边界进行跟踪时所需的任何其他行为。

参数

m (Module) – 要为其发出调用的模块
forward (Callable) – 要调用的 Module 的 forward() 方法
args (Tuple) – 模块调用站点的 args
kwargs (Dict) – 模块调用站点的 kwargs

返回值

Module 调用的返回值。在发出 call_module 节点的情况下，这是一个 Proxy 值。否则，它是从 Module 调用返回的任何值。

返回类型

注意

保证此 API 的向后兼容性。

create_arg(a)[源代码][源代码]¶

指定在准备用作 Graph 中节点参数的值时，追踪行为的方法。

默认行为包括：

遍历集合类型（例如，tuple，list，dict），并在元素上递归调用 create_args。
给定一个 Proxy 对象，返回对底层 IR Node 的引用。
给定一个非 Proxy Tensor 对象，为各种情况发出 IR。
- 对于 Parameter，发出一个引用该 Parameter 的 get_attr 节点。
- 对于非 Parameter Tensor，将 Tensor 存储在一个特殊的属性中，该属性引用该属性。

此方法可以被覆盖以支持更多类型。

参数: a (Any) – 要作为 Graph 中的 Argument 发出的值。
返回值: 值 a 转换为适当的 Argument
返回类型: Argument

注意

保证此 API 的向后兼容性。

create_args_for_root(root_fn, is_module, concrete_args=None)[source][source]¶: 创建与 root Module 的签名相对应的 placeholder 节点。此方法内省 root 的签名并相应地发出这些节点，也支持 *args 和 **kwargs。

警告

此 API 尚处于实验阶段，并且不向后兼容。

create_node(kind, target, args, kwargs, name=None, type_expr=None)[source]¶

根据 target、args、kwargs 和 name 插入一个 graph 节点。

此方法可以被覆盖以对节点创建中使用的值进行额外的检查、验证或修改。例如，可能希望禁止记录原地操作。

注意

保证此 API 的向后兼容性。

返回类型: Node

create_proxy(kind, target, args, kwargs, name=None, type_expr=None, proxy_factory_fn=None)[source]¶

从给定的参数创建一个 Node，然后返回包装在 Proxy 对象中的 Node。

如果 kind = ‘placeholder’，那么我们正在创建一个表示函数参数的 Node。如果我们需要编码一个默认参数，我们使用 args 元组。args 对于 placeholder 节点通常为空。

注意

保证此 API 的向后兼容性。

get_fresh_qualname(prefix)[source][source]¶

获取一个 prefix 的新名称并返回它。此函数确保它不会与图上的现有属性冲突。

注意

保证此 API 的向后兼容性。

返回类型: str

getattr(attr, attr_val, parameter_proxy_cache)[source][source]¶

指定此 Tracer 在我们对 nn.Module 实例的调用调用 getattr 时的行为的方法。

默认情况下，该行为是返回属性的代理值。它还将代理值存储在 parameter_proxy_cache 中，以便将来的调用将重用代理而不是创建一个新的代理。

可以覆盖此方法，例如，在查询参数时不返回代理。

参数

attr (str) – 被查询的属性的名称
attr_val (Any) – 属性的值
parameter_proxy_cache (Dict[str, Any]) – 一个从属性名称到代理的缓存

返回值

getattr 调用的返回值。

警告

此 API 尚处于实验阶段，并且不向后兼容。

is_leaf_module(m, module_qualified_name)[source][source]¶

指定给定 nn.Module 是否为“叶子”模块的方法。

叶子模块是出现在 IR 中的原子单元，由 call_module 调用引用。默认情况下，PyTorch 标准库命名空间 (torch.nn) 中的模块是叶子模块。所有其他模块都将被追踪，它们的组成操作将被记录，除非通过此参数另有规定。

参数

m (Module) – 被查询的模块
module_qualified_name (str) – 此模块根的路径。例如，如果你有一个模块层次结构，其中子模块 foo 包含子模块 bar，后者包含子模块 baz，则该模块将以限定名称 foo.bar.baz 出现在此处。

返回类型

注意

保证此 API 的向后兼容性。

iter(obj)[source]¶

当代理对象被迭代时调用，例如: 当在控制流中使用时。通常我们不知道该怎么做，因为我们不知道代理的值，但是自定义追踪器可以使用 create_node 将更多信息附加到 graph 节点，并且可以选择返回一个迭代器。

注意

保证此 API 的向后兼容性。

返回类型: Iterator

keys(obj)[source]¶

当代理对象调用了 keys() 方法时调用。: 这是当 ** 在代理上调用时发生的事情。如果 ** 应该在你的自定义追踪器中工作，则应该返回一个迭代器。

注意

保证此 API 的向后兼容性。

返回类型: Any

path_of_module(mod)[source][source]¶

辅助方法，用于查找 mod 在 root 的模块层次结构中的限定名称。例如，如果 root 有一个名为 foo 的子模块，该子模块有一个名为 bar 的子模块，则将 bar 传递给此函数将返回字符串“foo.bar”。

参数: mod (str) – 要检索限定名称的 Module。
返回类型: str

注意

保证此 API 的向后兼容性。

proxy(node)[source]¶

注意

保证此 API 的向后兼容性。

返回类型: 代理 (Proxy)

to_bool(obj)[source]¶

当代理对象被转换为布尔值时调用，例如: 在控制流中使用时。通常我们不知道该怎么做，因为我们不知道代理的值，但是自定义追踪器可以使用 create_node 将更多信息附加到图节点，并且可以选择返回一个值。

注意

保证此 API 的向后兼容性。

返回类型: bool

trace(root, concrete_args=None)[source][source]¶

追踪 root 并返回对应的 FX Graph 表示。 root 可以是一个 nn.Module 实例或者一个 Python 可调用对象。

请注意，在此调用之后，self.root 可能与此处传入的 root 不同。例如，当一个自由函数传递给 trace() 时，我们将创建一个 nn.Module 实例用作根，并将嵌入的常量添加到其中。

参数

root (Union[Module, Callable]) – 要追踪的 Module 或函数。保证此参数的向后兼容性。
concrete_args (Optional[Dict[str, any]]) – 不应被视为代理的具体的参数。此参数是实验性的，其向后兼容性不保证。

返回值

表示传入的 root 语义的 Graph。

返回类型

Graph（图）

注意

保证此 API 的向后兼容性。

class torch.fx.Proxy(node, tracer=None)[source][source]¶

Proxy 对象是 Node 包装器，在符号追踪期间流经程序，并将它们接触到的所有操作（torch 函数调用、方法调用、运算符）记录到增长的 FX 图中。

如果您正在进行图转换，您可以将您自己的 Proxy 方法包装在一个原始的 Node 周围，以便您可以使用重载的运算符向 Graph 添加其他内容。

Proxy 对象无法迭代。换句话说，如果 Proxy 在循环中使用或用作 *args/ **kwargs 函数参数，则符号追踪器将抛出错误。

有两种主要方法可以解决这个问题：1. 将无法追踪的逻辑分解为顶层函数，并在其上使用 fx.wrap。 2. 如果控制流是静态的（即，循环行程计数基于某些超参数），则可以将代码保留在其原始位置并重构为类似的内容

for i in range(self.some_hyperparameter):
    indexed_item = proxied_value[i]

有关 Proxy 内部结构的更详细说明，请查看 torch/fx/README.md 中的“Proxy”部分

注意

保证此 API 的向后兼容性。

class torch.fx.Interpreter(module, garbage_collect_values=True, graph=None)[source][source]¶

Interpreter逐个节点地执行FX图。这种模式对于许多事情都很有用，包括编写代码转换以及分析pass。

可以覆盖 Interpreter 类中的方法以自定义执行行为。调用层次结构中的可覆盖方法映射

run()
    +-- run_node
        +-- placeholder()
        +-- get_attr()
        +-- call_function()
        +-- call_method()
        +-- call_module()
        +-- output()

示例

假设我们想将所有 torch.neg 实例与 torch.sigmoid 互换，反之亦然（包括它们的 Tensor 方法等效项）。我们可以像这样子类化 Interpreter

class NegSigmSwapInterpreter(Interpreter):
    def call_function(self, target: Target, args: Tuple, kwargs: Dict) -> Any:
        if target == torch.sigmoid:
            return torch.neg(*args, **kwargs)
        return super().call_function(target, args, kwargs)

    def call_method(self, target: Target, args: Tuple, kwargs: Dict) -> Any:
        if target == "neg":
            call_self, *args_tail = args
            return call_self.sigmoid(*args_tail, **kwargs)
        return super().call_method(target, args, kwargs)


def fn(x):
    return torch.sigmoid(x).neg()


gm = torch.fx.symbolic_trace(fn)
input = torch.randn(3, 4)
result = NegSigmSwapInterpreter(gm).run(input)
torch.testing.assert_close(result, torch.neg(input).sigmoid())

参数

module (torch.nn.Module) – 要执行的模块
garbage_collect_values (bool) – 是否在模块执行中最后一次使用值后删除它们。这确保了执行期间的最佳内存使用。可以禁用此功能，例如，通过查看 Interpreter.env 属性来检查执行中的所有中间值。
graph (Optional[Graph]) – 如果传递，解释器将执行此图而不是 module.graph，并使用提供的 module 参数来满足任何状态请求。

注意

保证此 API 的向后兼容性。

boxed_run(args_list)[source][source]¶: 通过解释运行 module 并返回结果。这使用“boxed”调用约定，您在其中传递一个参数列表，该列表将被解释器清除。这确保了及时释放输入张量。

注意

保证此 API 的向后兼容性。

call_function(target, args, kwargs)[source][source]¶

执行一个 call_function 节点并返回结果。

参数

target (Target) – 此节点的调用目标。有关语义的详细信息，请参见 Node
args (Tuple) – 此调用的位置参数的元组
kwargs (Dict) – 此调用的关键字参数的字典

返回类型

返回: Any: 函数调用返回的值

注意

保证此 API 的向后兼容性。

call_method(target, args, kwargs)[source][source]¶

执行一个 call_method 节点并返回结果。

参数

target (Target) – 此节点的调用目标。有关语义的详细信息，请参见 Node
args (Tuple) – 此调用的位置参数的元组
kwargs (Dict) – 此调用的关键字参数的字典

返回类型

返回: Any: 方法调用返回的值

注意

保证此 API 的向后兼容性。

call_module(target, args, kwargs)[source][source]¶

执行一个 call_module 节点并返回结果。

参数

target (Target) – 此节点的调用目标。有关语义的详细信息，请参见 Node
args (Tuple) – 此调用的位置参数的元组
kwargs (Dict) – 此调用的关键字参数的字典

返回类型