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

paths

paths()

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

source

Returns tree’s leaves keyed by their dotted path.

The result is what update() consumes.

Parameters:

• tree (Any) – The value to read.
• leaf (type | tuple[type, ...] | Callable[[Any], bool] | None) – Where the walk stops.
• shared (bool) – Whether an aliased value is one leaf or one per path.

Returns:

One entry per leaf, in leaf order.

Raises:

ValueError – If two leaves share a path, so it names neither.

Return type:

dict[str, Any]