Simplified PyTree Utilities
===========================

.. currentmodule:: optree.pytree

.. automodule:: optree.pytree
    :no-members:

Re-export PyTree Utilities as a Sub-module
------------------------------------------

.. autosummary::

    reexport

.. autofunction:: reexport

Tree Operations
---------------

Check section :ref:`Tree Manipulation Functions` and :ref:`Tree Reduce Functions` for more
detailed documentation.

.. autosummary::

    dict_insertion_ordered
    flatten
    flatten_with_path
    flatten_with_accessor
    unflatten
    iter
    leaves
    structure
    paths
    accessors
    is_leaf
    map
    map_
    map_with_path
    map_with_path_
    map_with_accessor
    map_with_accessor_
    replace_nones
    partition
    transpose
    transpose_map
    transpose_map_with_path
    transpose_map_with_accessor
    broadcast_prefix
    broadcast_common
    broadcast_map
    broadcast_map_with_path
    broadcast_map_with_accessor
    reduce
    sum
    max
    min
    all
    any
    flatten_one_level

Node Registration
-----------------

Check section :ref:`PyTree Node Registration` for more detailed documentation.

.. autosummary::

    register_node
    register_node_class
    unregister_node