mlx/docs/build/doctrees/python/_autosummary/mlx.utils.tree_unflatten.doctree

<EFBFBD><05><>!<00>sphinx.addnodes<65><73>document<6E><74><EFBFBD>)<29><>}<7D>(<28>	rawsource<63><65><00><>children<65>]<5D><>docutils.nodes<65><73>section<6F><6E><EFBFBD>)<29><>}<7D>(hhh]<5D>(h	<09>title<6C><65><EFBFBD>)<29><>}<7D>(h<05>mlx.utils.tree\_unflatten<65>h]<5D>h	<09>Text<78><74><EFBFBD><EFBFBD>mlx.utils.tree_unflatten<65><6E><EFBFBD><EFBFBD><EFBFBD>}<7D>(<28>parent<6E>h<11>	_document<6E>h<03>source<63>N<EFBFBD>line<6E>Nuba<62>
attributes<EFBFBD>}<7D>(<28>ids<64>]<5D><>classes<65>]<5D><>names<65>]<5D><>dupnames<65>]<5D><>backrefs<66>]<5D>u<EFBFBD>tagname<6D>hhhhhh<1D>U/Users/awnihannun/repos/mlx/docs/src/python/_autosummary/mlx.utils.tree_unflatten.rst<73>hKubh<00>index<65><78><EFBFBD>)<29><>}<7D>(hhh]<5D>h}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>entries<65>]<5D>(<28>single<6C><65>&tree_unflatten() (in module mlx.utils)<29><>mlx.utils.tree_unflatten<65>hNt<4E>auh+h-hhhhhNhNubh<00>desc<73><63><EFBFBD>)<29><>}<7D>(hhh]<5D>(h<00>desc_signature<72><65><EFBFBD>)<29><>}<7D>(h<05>tree_unflatten(tree)<29>h]<5D>(h<00>desc_addname<6D><65><EFBFBD>)<29><>}<7D>(h<05>
mlx.utils.<2E>h]<5D>h<16>
mlx.utils.<2E><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hhKhhhNhNubah}<7D>(h!]<5D>h#]<5D>(<28>sig-prename<6D><65>
descclassname<6D>eh%]<5D>h']<5D>h)]<5D><>	xml:space<63><65>preserve<76>uh+hIhhEhhh<1D>U/Users/awnihannun/repos/mlx/python/mlx/utils.py:docstring of mlx.utils.tree_unflatten<65>hNubh<00>	desc_name<6D><65><EFBFBD>)<29><>}<7D>(h<05>tree_unflatten<65>h]<5D>h<16>tree_unflatten<65><6E><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh`hhhNhNubah}<7D>(h!]<5D>h#]<5D>(<28>sig-name<6D><65>descname<6D>eh%]<5D>h']<5D>h)]<5D>h[h\uh+h^hhEhhhh]hNubh<00>desc_parameterlist<73><74><EFBFBD>)<29><>}<7D>(h<05>tree<65>h]<5D>h<00>desc_parameter<65><72><EFBFBD>)<29><>}<7D>(h<05>tree<65>h]<5D>h<00>
desc_sig_name<6D><65><EFBFBD>)<29><>}<7D>(h<05>tree<65>h]<5D>h<16>tree<65><65><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh~hhhNhNubah}<7D>(h!]<5D>h#]<5D><>
n<>ah%]<5D>h']<5D>h)]<5D>uh+h|hhxubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>h[h\uh+hvhhrubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>h[h\uh+hphhEhhhh]hNubeh}<7D>(h!]<5D>h<ah#]<5D>(<28>sig<69><67>
sig-object<63>eh%]<5D>h']<5D>h)]<5D><>module<6C><65>	mlx.utils<6C><73>class<73>h<06>fullname<6D>hbuh+hChh]hK
hh@hhubh<00>desc_content<6E><74><EFBFBD>)<29><>}<7D>(hhh]<5D>(h	<09>	paragraph<70><68><EFBFBD>)<29><>}<7D>(h<05>4Recreate a python tree from its flat representation.<2E>h]<5D>h<16>4Recreate a python tree from its flat representation.<2E><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>h<1D>U/Users/awnihannun/repos/mlx/python/mlx/utils.py:docstring of mlx.utils.tree_unflatten<65>hK
hh<>hhubh	<09>
literal_block<63><6B><EFBFBD>)<29><>}<7D>(h<05>sfrom mlx.utils import tree_unflatten

d = tree_unflatten([("hello.world", 42)])
print(d)
# {"hello": {"world": 42}}<7D>h]<5D>h<16>sfrom mlx.utils import tree_unflatten

d = tree_unflatten([("hello.world", 42)])
print(d)
# {"hello": {"world": 42}}<7D><><EFBFBD><EFBFBD><EFBFBD>}<7D>hh<>sbah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>h[h\<5C>force<63><65><EFBFBD>language<67><65>python<6F><6E>highlight_args<67>}<7D>uh+h<>hh<>hKhh<>hhubh	<09>
field_list<EFBFBD><EFBFBD><EFBFBD>)<29><>}<7D>(hhh]<5D>(h	<09>field<6C><64><EFBFBD>)<29><>}<7D>(hhh]<5D>(h	<09>
field_name<EFBFBD><EFBFBD><EFBFBD>)<29><>}<7D>(h<05>
Parameters<EFBFBD>h]<5D>h<16>
Parameters<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hh<>hh]hKubh	<09>
field_body<EFBFBD><EFBFBD><EFBFBD>)<29><>}<7D>(hhh]<5D>h<EFBFBD>)<29><>}<7D>(h<05><>tree (ListList[TupleTuple[strstr, AnyAny]]) -- The flat representation of a python tree.
For instance as returned by tree_flatten().<2E>h]<5D>(h<00>literal_strong<6E><67><EFBFBD>)<29><>}<7D>(h<05>tree<65>h]<5D>h<16>tree<65><65><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hh<>ubh<16> (<28><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubh<00>pending_xref<65><66><EFBFBD>)<29><>}<7D>(hhh]<5D>(h<00>pending_xref_condition<6F><6E><EFBFBD>)<29><>}<7D>(h<05>List<73>h]<5D>h<00>literal_emphasis<69><73><EFBFBD>)<29><>}<7D>(h<05>List<73>h]<5D>h<16>List<73><74><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j
hj
ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	condition<6F><6E>resolved<65>uh+j
hj	
ubj

)<29><>}<7D>(h<05>List<73>h]<5D>j
)<29><>}<7D>(h<05>List<73>h]<5D>h<16>List<73><74><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj.
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j
hj*
ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	condition<6F><6E>
*<2A>uh+j
hj	
ubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	refdomain<69><6E>py<70><79>refexplicit<69><74><EFBFBD>reftype<70>h<EFBFBD><68>	reftarget<65>j0
<00>refspecific<69><63><EFBFBD>	py:module<6C>h<EFBFBD><68>py:class<73>Nuh+j
hh<>ubj
)<29><>}<7D>(h<05>
[<5B>h]<5D>h<16>
[<5B><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjR
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j
hh<>ubj
)<29><>}<7D>(hhh]<5D>(j

)<29><>}<7D>(h<05>Tuple<6C>h]<5D>j
)<29><>}<7D>(h<05>Tuple<6C>h]<5D>h<16>Tuple<6C><65><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjg
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j
hjc
ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	condition<6F>j)
uh+j
hj`
ubj

)<29><>}<7D>(h<05>Tuple<6C>h]<5D>j
)<29><>}<7D>(h<05>Tuple<6C>h]<5D>h<16>Tuple<6C><65><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j
hj|
ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	condition<6F>jC
uh+j
hj`
ubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	refdomain<69>jK
<00>refexplicit<69><74><EFBFBD>reftype<70>h<EFBFBD><68>	reftarget<65>j<EFBFBD>
jO
<00>jP
h<>jQ
Nuh+j
hh<>ubj
)<29><>}<7D>(hjT
h]<5D>h<16>
[<5B><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j
hh<>ubj
)<29><>}<7D>(hhh]<5D>(j

)<29><>}<7D>(h<05>str<74>h]<5D>j
)<29><>}<7D>(h<05>str<74>h]<5D>h<16>str<74><72><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j
hj<>
ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	condition<6F>j)
uh+j
hj<>
ubj

)<29><>}<7D>(h<05>str<74>h]<5D>j
)<29><>}<7D>(h<05>str<74>h]<5D>h<16>str<74><72><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j
hj<>
ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	condition<6F>jC
uh+j
hj<>
ubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	refdomain<69>jK
<00>refexplicit<69><74><EFBFBD>reftype<70>h<EFBFBD><68>	reftarget<65>j<EFBFBD>
jO
<00>jP
h<>jQ
Nuh+j
hh<>ubj
)<29><>}<7D>(h<05>, <20>h]<5D>h<16>, <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j
hh<>ubj
)<29><>}<7D>(hhh]<5D>(j

)<29><>}<7D>(h<05>Any<6E>h]<5D>j
)<29><>}<7D>(h<05>Any<6E>h]<5D>h<16>Any<6E><79><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjhhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j
hj<>
ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	condition<6F>j)
uh+j
hj<>
ubj

)<29><>}<7D>(h<05>Any<6E>h]<5D>j
)<29><>}<7D>(h<05>Any<6E>h]<5D>h<16>Any<6E><79><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjhhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j
hjubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	condition<6F>jC
uh+j
hj<>
ubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	refdomain<69>jK
<00>refexplicit<69><74><EFBFBD>reftype<70>h<EFBFBD><68>	reftarget<65>jjO
<00>jP
h<>jQ
Nuh+j
hh<>ubj
)<29><>}<7D>(h<05>
]<5D>h]<5D>h<16>
]<5D><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj8hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j
hh<>ubj
)<29><>}<7D>(hj:h]<5D>h<16>
]<5D><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjFhhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j
hh<>ubh<16>
)<29><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubh<16> – <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubh<16>FThe flat representation of a python tree.
For instance as returned by <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubj
)<29><>}<7D>(h<05>:meth:`tree_flatten`<60>h]<5D>h	<09>literal<61><6C><EFBFBD>)<29><>}<7D>(hjah]<5D>h<16>tree_flatten()<29><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjehhhNhNubah}<7D>(h!]<5D>h#]<5D>(<28>xref<65><66>py<70><79>py-meth<74>eh%]<5D>h']<5D>h)]<5D>uh+jchj_ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>refdoc<6F><63>,python/_autosummary/mlx.utils.tree_unflatten<65><6E>	refdomain<69>jp<00>reftype<70><65>meth<74><68>refexplicit<69><74><EFBFBD>refwarn<72><6E>jP
h<>jQ
N<>	reftarget<65><74>tree_flatten<65>uh+j
hh<>hKhh<>hhubh<16>
.<2E><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hh<>ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hh<>ubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hh<>ubh<62>)<29><>}<7D>(hhh]<5D>(h<>)<29><>}<7D>(h<05>Returns<6E>h]<5D>h<16>Returns<6E><73><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hj<>hh]hKubh<62>)<29><>}<7D>(hhh]<5D>h<EFBFBD>)<29><>}<7D>(h<05>A python tree.<2E>h]<5D>h<16>A python tree.<2E><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hj<>ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hj<>ubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hh<>ubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hh<>hhhNhNubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hh@hhhh]hNubeh}<7D>(h!]<5D>h#]<5D>(jK
<00>function<6F>eh%]<5D>h']<5D>h)]<5D><>domain<69>jK
<00>objtype<70>j<EFBFBD><00>desctype<70>j<EFBFBD><00>noindex<65><78>uh+h>hhhhhNhNubeh}<7D>(h!]<5D><>mlx-utils-tree-unflatten<65>ah#]<5D>h%]<5D><>mlx.utils.tree_unflatten<65>ah']<5D>h)]<5D>uh+h
hhhhhh,hKubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>source<63>h,uh+h
<01>current_source<63>N<EFBFBD>current_line<6E>N<EFBFBD>settings<67><73>docutils.frontend<6E><64>Values<65><73><EFBFBD>)<29><>}<7D>(hN<>	generator<6F>N<EFBFBD>	datestamp<6D>N<EFBFBD>source_link<6E>N<EFBFBD>
source_url<EFBFBD>N<EFBFBD>
toc_backlinks<6B><73>entry<72><79>footnote_backlinks<6B>K
<01>
sectnum_xform<72>K
<01>strip_comments<74>N<EFBFBD>strip_elements_with_classes<65>N<EFBFBD>
strip_classes<65>N<EFBFBD>report_level<65>K<02>
halt_level<EFBFBD>K<05>exit_status_level<65>K<05>debug<75>N<EFBFBD>warning_stream<61>N<EFBFBD>	traceback<63><6B><EFBFBD>input_encoding<6E><67>	utf-8-sig<69><67>input_encoding_error_handler<65><72>strict<63><74>output_encoding<6E><67>utf-8<><38>output_encoding_error_handler<65>j
<00>error_encoding<6E><67>utf-8<><38>error_encoding_error_handler<65><72>backslashreplace<63><65>
language_code<64><65>en<65><6E>record_dependencies<65>N<EFBFBD>config<69>N<EFBFBD>	id_prefix<69>h<06>auto_id_prefix<69><78>id<69><64>
dump_settings<67>N<EFBFBD>dump_internals<6C>N<EFBFBD>dump_transforms<6D>N<EFBFBD>dump_pseudo_xml<6D>N<EFBFBD>expose_internals<6C>N<EFBFBD>strict_visitor<6F>N<EFBFBD>_disable_config<69>N<EFBFBD>_source<63>h,<2C>_destination<6F>N<EFBFBD>
_config_files<65>]<5D><>file_insertion_enabled<65><64><EFBFBD>raw_enabled<65>K
<01>line_length_limit<69>M'<27>pep_references<65>N<EFBFBD>pep_base_url<72><6C>https://peps.python.org/<2F><>pep_file_url_template<74><65>pep-%04d<34><64>rfc_references<65>N<EFBFBD>rfc_base_url<72><6C>&https://datatracker.ietf.org/doc/html/<2F><>	tab_width<74>K<08>trim_footnote_reference_space<63><65><EFBFBD>syntax_highlight<68><74>long<6E><67>smart_quotes<65><73><EFBFBD>smartquotes_locales<65>]<5D><>character_level_inline_markup<75><70><EFBFBD>doctitle_xform<72><6D><EFBFBD>
docinfo_xform<72>K
<01>sectsubtitle_xform<72><6D><EFBFBD>
image_loading<6E><67>link<6E><6B>embed_stylesheet<65><74><EFBFBD>cloak_email_addresses<65><73><EFBFBD>section_self_link<6E><6B><EFBFBD>env<6E>Nub<75>reporter<65>N<EFBFBD>indirect_targets<74>]<5D><>substitution_defs<66>}<7D><>substitution_names<65>}<7D><>refnames<65>}<7D><>refids<64>}<7D><>nameids<64>}<7D>j<EFBFBD>j<>s<>	nametypes<65>}<7D>j<EFBFBD><00>sh!}<7D>(j<>hh<hEu<45>
footnote_refs<66>}<7D><>
citation_refs<66>}<7D><>
autofootnotes<65>]<5D><>autofootnote_refs<66>]<5D><>symbol_footnotes<65>]<5D><>symbol_footnote_refs<66>]<5D><>	footnotes<65>]<5D><>	citations<6E>]<5D><>autofootnote_start<72>K
<01>symbol_footnote_start<72>K<00>
id_counter<EFBFBD><EFBFBD>collections<6E><73>Counter<65><72><EFBFBD>}<7D><><EFBFBD>R<EFBFBD><52>parse_messages<65>]<5D><>transform_messages<65>]<5D><>transformer<65>N<EFBFBD>include_log<6F>]<5D><>
decoration<EFBFBD>Nhhub.