2023-11-30 04:41:56 +08:00
|
|
|
.. _utils:
|
|
|
|
|
|
|
|
Tree Utils
|
|
|
|
==========
|
|
|
|
|
|
|
|
In MLX we consider a python tree to be an arbitrarily nested collection of
|
|
|
|
dictionaries, lists and tuples without cycles. Functions in this module that
|
|
|
|
return python trees will be using the default python ``dict``, ``list`` and
|
|
|
|
``tuple`` but they can usually process objects that inherit from any of these.
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
Dictionaries should have keys that are valid python identifiers.
|
|
|
|
|
|
|
|
.. currentmodule:: mlx.utils
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
:toctree: _autosummary
|
|
|
|
|
|
|
|
tree_flatten
|
|
|
|
tree_unflatten
|
|
|
|
tree_map
|
2024-04-26 23:24:09 +08:00
|
|
|
tree_map_with_path
|
2024-05-10 23:49:36 +08:00
|
|
|
tree_reduce
|