Function¶

class onnx_ir.Function(domain, name, overload='', *, graph, attributes)¶

IR functions.

Like a graph, a function can have nodes that are not topologically sorted. It is the responsibility of the user to maintain a topological order of the nodes.

Note that there is not a node attribute in the Function. The Function can be seen as a Sequence of nodes and should be used as such. For example, to obtain all nodes as a list, call list(function).

Parameters:
name¶

The function name.

domain¶

The domain this function is defined in.

overload¶

The overload name when the function is overloaded.

inputs¶

The input values of the function.

attributes¶

The attributes this function defines.

outputs¶

The output values of the function.

opset_imports¶

Opsets imported by the function.

doc_string¶

Documentation string.

meta¶

Metadata store for graph transform passes.

metadata_props¶

Metadata that will be serialized to the ONNX file.

all_nodes()[source]¶

Get all nodes in the graph and its subgraphs in O(#nodes + #attributes) time.

This is an alias for onnx_ir.traversal.RecursiveGraphIterator(graph). Consider using onnx_ir.traversal.RecursiveGraphIterator for more advanced traversals on nodes.

Return type:

Iterator[Node]

append(node, /)[source]¶

Append a node to the function in O(1) time.

Parameters:

node (Node)

Return type:

None

property attributes: Attributes¶
count(value) → integer -- return number of occurrences of value¶
display(*, page=False)¶

Pretty print the object.

Parameters:

page (bool) – Whether to page the output.

Return type:

None

property doc_string: str | None¶
property domain: str¶
extend(nodes, /)[source]¶

Extend the function with the given nodes in O(#new_nodes) time.

Parameters:

nodes (Iterable[Node])

Return type:

None

identifier()[source]¶

Return the unique identifier of the function.

Return type:

tuple[str, str, str]

index(value[, start[, stop]]) → integer -- return first index of value.¶

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

property inputs: MutableSequence[Value]¶
insert_after(node, new_nodes, /)[source]¶

Insert new nodes after the given node in O(#new_nodes) time.

Parameters:
Return type:

None

insert_before(node, new_nodes, /)[source]¶

Insert new nodes before the given node in O(#new_nodes) time.

Parameters:
Return type:

None

property meta: MetadataStore¶

The metadata store for intermediate analysis.

Write to the metadata_props if you would like the metadata to be serialized to the ONNX proto.

property metadata_props: dict[str, str]¶
property name: str¶
property opset_imports: dict[str, int]¶
property outputs: MutableSequence[Value]¶
property overload: str¶
remove(nodes, /, safe=False)[source]¶

Remove nodes from the graph in O(#num of nodes) time.

If any errors are raise, to ensure the graph is not left in an inconsistent state, the graph is not modified.

Parameters:

  • nodes (Node | Iterable[Node]) – The node to remove.

  • safe (bool) –

    If True, performs the following actions before removal:

    1. It checks to make sure there are no users of the node that are not to be removed before removing it. 2. It checks the node does not contribute to any graph outputs. 3. It removes references to all inputs so it is no longer a user of other nodes.

Raises:

  • ValueError – If any node to remove does not belong to this graph.

  • ValueError – (When safe=True) If the node does not belong to this graph or if there are users of the node.

  • ValueError – (When safe=True) If the node is still being used by other nodes not to be removed.

Return type:

None

sort()[source]¶

Perform a topological sort of this graph and all subgraphs in O(#nodes + #values) time.

Return type:

None

subgraphs()[source]¶

Get all subgraphs in the function in O(#nodes + #attributes) time.

Return type:

Iterator[Graph]