For the complete documentation index, see llms.txt. Markdown versions of all pages are available by appending .md to any URL (e.g. /get-started.md).

Python function

flatten

flatten()

max.experimental.tree_utils.flatten(tree, *, leaf=None, shared=False)

source

Splits tree into its leaves and the structure around them.

Parameters:

• tree (Any) – The value to take apart.
• leaf (type | tuple[type, ...] | Callable[[Any], bool] | None) – Where the walk stops.
• shared (bool) – Whether a value reachable by two paths is one object or two.

Returns:

The leaves, left to right, and the TreeDef that rebuilds them.

Raises:

• TypeError – If a dict in tree has keys that are not mutually sortable.
• ValueError – If tree holds a cycle this walk cannot express.

Return type:

tuple[list[Any], TreeDef]