mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-25 18:11:15 +08:00
79c859e2e0
* feat: implement `clip_grad_norm` * pre-commit * Add test for clip_grad_norm function in test_optimizers.py * small fixes * fix * lint * Update tree_reduce * Update python/mlx/utils.py Co-authored-by: Awni Hannun <awni.hannun@gmail.com> * Update python/mlx/utils.py Co-authored-by: Awni Hannun <awni.hannun@gmail.com> * Update python/mlx/utils.py Co-authored-by: Awni Hannun <awni.hannun@gmail.com> * Update python/mlx/utils.py Co-authored-by: Awni Hannun <awni.hannun@gmail.com> * Update python/mlx/utils.py Co-authored-by: Awni Hannun <awni.hannun@gmail.com> * Update python/mlx/utils.py Co-authored-by: Awni Hannun <awni.hannun@gmail.com> * Refactor clip_grad_norm function to include documentation and improve readability * format docstring * Add acknowlegements * text wrap * pre-commit * nits in docs --------- Co-authored-by: Awni Hannun <awni.hannun@gmail.com> Co-authored-by: Awni Hannun <awni@apple.com>
24 lines
579 B
ReStructuredText
24 lines
579 B
ReStructuredText
.. _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
|
|
tree_map_with_path
|
|
tree_reduce
|