index.rst

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.

License

Tree is licensed under the Apache 2.0 License.