1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
|
##################
Tree Documentation
##################
.. toctree::
:maxdepth: 2
:hidden:
api
changes
recipes
``tree`` is a library for working with nested data structures. In a way,
``tree`` generalizes the builtin :func:`map` function which only supports
flat sequences, and allows to apply a function to each "leaf" preserving
the overall structure.
Here's a quick example::
>>> tree.map_structure(lambda v: v**2, [[1], [[[2, 3]]], [4]])
[[1], [[[4, 9]]], [16]]
.. note::
``tree`` has originally been part of TensorFlow and is available
as ``tf.nest``.
Installation
============
Install ``tree`` by running::
$ pip install dm-tree
Support
=======
If you are having issues, please let us know by filing an issue on our
`issue tracker <https://github.com/deepmind/tree/issues>`_.
License
=======
Tree is licensed under the Apache 2.0 License.
|