Typing Support
==============

.. currentmodule:: optree

.. autosummary::

    PyTreeSpec
    PyTreeDef
    PyTreeKind
    PyTree
    PyTreeTypeVar
    CustomTreeNode
    is_namedtuple
    is_namedtuple_instance
    is_namedtuple_class
    namedtuple_fields
    is_structseq
    is_structseq_instance
    is_structseq_class
    structseq_fields

.. autoclass:: PyTreeSpec
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: PyTreeDef

.. autoclass:: PyTreeKind
    :members:

.. autoclass:: PyTree
    :members:

.. autofunction:: PyTreeTypeVar

.. autoclass:: CustomTreeNode
    :members:

.. autofunction:: is_namedtuple

.. autofunction:: is_namedtuple_instance

.. autofunction:: is_namedtuple_class

.. autofunction:: namedtuple_fields

.. autofunction:: is_structseq

.. autofunction:: is_structseq_instance

.. autofunction:: is_structseq_class

.. autofunction:: structseq_fields