docs/build/doctrees/python/_autosummary/mlx.optimizers.OptimizerState.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.optimizers.OptimizerState<74>h]<5D>h	<09>Text<78><74><EFBFBD><EFBFBD>mlx.optimizers.OptimizerState<74><65><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>hhhhhh<1D>Z/Users/awnihannun/repos/mlx/docs/src/python/_autosummary/mlx.optimizers.OptimizerState.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>(OptimizerState (class in mlx.optimizers)<29><>mlx.optimizers.OptimizerState<74>hNt<4E>auh+h-hhhhhNhNubh<00>desc<73><63><EFBFBD>)<29><>}<7D>(hhh]<5D>(h<00>desc_signature<72><65><EFBFBD>)<29><>}<7D>(h<05>OptimizerState<74>h]<5D>(h<00>desc_annotation<6F><6E><EFBFBD>)<29><>}<7D>(h<05>2[<#text: 'class'>, <desc_sig_space: <#text: ' '>>]<5D>h]<5D>(h<16>class<73><73><EFBFBD><EFBFBD><EFBFBD>}<7D>(hhKhhhNhNubh<00>desc_sig_space<63><65><EFBFBD>)<29><>}<7D>(h<05> <20>h]<5D>h<16> <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hhUhhhNhNubah}<7D>(h!]<5D>h#]<5D><>w<>ah%]<5D>h']<5D>h)]<5D>uh+hShhKubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	xml:space<63><65>preserve<76>uh+hIhhEhhh<1D>_/Users/awnihannun/repos/mlx/python/mlx/optimizers.py:docstring of mlx.optimizers.OptimizerState<74>hNubh<00>desc_addname<6D><65><EFBFBD>)<29><>}<7D>(h<05>mlx.optimizers.<2E>h]<5D>h<16>mlx.optimizers.<2E><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hhohhhNhNubah}<7D>(h!]<5D>h#]<5D>(<28>sig-prename<6D><65>
descclassname<6D>eh%]<5D>h']<5D>h)]<5D>hjhkuh+hmhhEhhhhlhNubh<00>	desc_name<6D><65><EFBFBD>)<29><>}<7D>(hhGh]<5D>h<16>OptimizerState<74><65><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubah}<7D>(h!]<5D>h#]<5D>(<28>sig-name<6D><65>descname<6D>eh%]<5D>h']<5D>h)]<5D>hjhkuh+hhhEhhhhlhNubeh}<7D>(h!]<5D>h<ah#]<5D>(<28>sig<69><67>
sig-object<63>eh%]<5D>h']<5D>h)]<5D><>module<6C><65>mlx.optimizers<72><73>class<73>h<06>fullname<6D>hGuh+hChhlhKhh@hhubh<00>desc_content<6E><74><EFBFBD>)<29><>}<7D>(hhh]<5D>(h	<09>	paragraph<70><68><EFBFBD>)<29><>}<7D>(h<05><>The optimizer state implements a recursively defined
:class:`collections.defaultdict`, namely a missing key in an optimizer
state is an :class:`OptimizerState`.<2E>h]<5D>(h<16>5The optimizer state implements a recursively defined
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubh<00>pending_xref<65><66><EFBFBD>)<29><>}<7D>(h<05> :class:`collections.defaultdict`<60>h]<5D>h	<09>literal<61><6C><EFBFBD>)<29><>}<7D>(hh<>h]<5D>h<16>collections.defaultdict<63><74><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubah}<7D>(h!]<5D>h#]<5D>(<28>xref<65><66>py<70><79>py-class<73>eh%]<5D>h']<5D>h)]<5D>uh+h<>hh<>ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>refdoc<6F><63>1python/_autosummary/mlx.optimizers.OptimizerState<74><65>	refdomain<69>h<EFBFBD><68>reftype<70><65>class<73><73>refexplicit<69><74><EFBFBD>refwarn<72><6E><EFBFBD>	py:module<6C>h<EFBFBD><68>py:class<73>hG<68>	reftarget<65><74>collections.defaultdict<63>uh+h<>h<1D>_/Users/awnihannun/repos/mlx/python/mlx/optimizers.py:docstring of mlx.optimizers.OptimizerState<74>hKhh<>ubh<16>3, namely a missing key in an optimizer
state is an <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubh<62>)<29><>}<7D>(h<05>:class:`OptimizerState`<60>h]<5D>h<EFBFBD>)<29><>}<7D>(hh<>h]<5D>h<16>OptimizerState<74><65><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubah}<7D>(h!]<5D>h#]<5D>(h<><68>py<70><79>py-class<73>eh%]<5D>h']<5D>h)]<5D>uh+h<>hh<>ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>refdoc<6F>hʌ	refdomain<69>h<EFBFBD><68>reftype<70><65>class<73><73>refexplicit<69><74><EFBFBD>refwarn<72><6E>h<EFBFBD>h<EFBFBD>h<EFBFBD>hGhҌOptimizerState<74>uh+h<>hh<>hKhh<>ubh<16>.<2E><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hh<>hKhh<>hhubh	<09>note<74><65><EFBFBD>)<29><>}<7D>(h<05><>:meth:`OptimizerState.get` in contrast to a normal dictionary also sets
the key to the ``default`` value if the ``key`` was not present in the
dictionary.<2E>h]<5D>h<EFBFBD>)<29><>}<7D>(h<05><>:meth:`OptimizerState.get` in contrast to a normal dictionary also sets
the key to the ``default`` value if the ``key`` was not present in the
dictionary.<2E>h]<5D>(h<>)<29><>}<7D>(h<05>:meth:`OptimizerState.get`<60>h]<5D>h<EFBFBD>)<29><>}<7D>(hjh]<5D>h<16>OptimizerState.get()<29><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjhhhNhNubah}<7D>(h!]<5D>h#]<5D>(h<><68>py<70><79>py-meth<74>eh%]<5D>h']<5D>h)]<5D>uh+h<>hj
ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>refdoc<6F>hʌ	refdomain<69>j<00>reftype<70><65>meth<74><68>refexplicit<69><74><EFBFBD>refwarn<72><6E>h<EFBFBD>h<EFBFBD>h<EFBFBD>hGhҌOptimizerState.get<65>uh+h<>hh<>hKhj	ubh<16>= in contrast to a normal dictionary also sets
the key to the <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj	hhhNhNubh<62>)<29><>}<7D>(h<05>``default``<60>h]<5D>h<16>default<6C><74><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj1hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hj	ubh<16> value if the <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj	hhhNhNubh<62>)<29><>}<7D>(h<05>``key``<60>h]<5D>h<16>key<65><79><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjChhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hj	ubh<16># was not present in the
dictionary.<2E><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj	hhhNhNubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hh<>hKhjubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+jhh<>hhhh<>hNubh	<09>rubric<69><63><EFBFBD>)<29><>}<7D>(h<05>Methods<64>h]<5D>h<16>Methods<64><73><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjchhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+jahh<>hhhh,hKubh<00>tabular_col_spec<65><63><EFBFBD>)<29><>}<7D>(hhh]<5D>h}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>spec<65><63>\X{1}{2}\X{1}{2}<7D>uh+jqhh<>hhh<1D>k/Users/awnihannun/repos/mlx/docs/src/python/_autosummary/mlx.optimizers.OptimizerState.rst:15:<autosummary><3E>hNub<75>sphinx.ext.autosummary<72><79>autosummary_table<6C><65><EFBFBD>)<29><>}<7D>(h<05>X


get(key, default)

If key doesn't exist set its value to default and then return it.<2E>h]<5D>h	<09>table<6C><65><EFBFBD>)<29><>}<7D>(hhh]<5D>h	<09>tgroup<75><70><EFBFBD>)<29><>}<7D>(hhh]<5D>(h	<09>colspec<65><63><EFBFBD>)<29><>}<7D>(hhh]<5D>h}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>colwidth<74>K
uh+j<>hj<>ubj<62>)<29><>}<7D>(hhh]<5D>h}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>colwidth<74>KZuh+j<>hj<>ubh	<09>tbody<64><79><EFBFBD>)<29><>}<7D>(hhh]<5D>h	<09>row<6F><77><EFBFBD>)<29><>}<7D>(hhh]<5D>(h	<09>entry<72><79><EFBFBD>)<29><>}<7D>(hhh]<5D>h<EFBFBD>)<29><>}<7D>(h<05>D:py:obj:`get <mlx.optimizers.OptimizerState.get>`\ \(key\, default\)<29>h]<5D>(h<>)<29><>}<7D>(h<05>1:py:obj:`get <mlx.optimizers.OptimizerState.get>`<60>h]<5D>h<EFBFBD>)<29><>}<7D>(hj<>h]<5D>h<16>get<65><74><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>hhhNhNubah}<7D>(h!]<5D>h#]<5D>(h<><68>py<70><79>py-obj<62>eh%]<5D>h']<5D>h)]<5D>uh+h<>hj<>ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>refdoc<6F>hʌ	refdomain<69>j<EFBFBD><00>reftype<70><65>obj<62><6A>refexplicit<69><74><EFBFBD>refwarn<72><6E>h<EFBFBD>h<EFBFBD>h<EFBFBD>hGhҌ!mlx.optimizers.OptimizerState.get<65>uh+h<>h<1D>k/Users/awnihannun/repos/mlx/docs/src/python/_autosummary/mlx.optimizers.OptimizerState.rst:15:<autosummary><3E>hKhj<>ubh<16>(key, default)<29><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>hhhNhNubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hj<>hKhj<>ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j<>hj<>ubj<62>)<29><>}<7D>(hhh]<5D>h<EFBFBD>)<29><>}<7D>(h<05>IIf ``key`` doesn't exist set its value to ``default`` and then return it.<2E>h]<5D>(h<16>If <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>hhhNhNubh<62>)<29><>}<7D>(h<05>``key``<60>h]<5D>h<16>key<65><79><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hj<>ubh<16>  doesn't exist set its value to <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>hhhNhNubh<62>)<29><>}<7D>(h<05>``default``<60>h]<5D>h<16>default<6C><74><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjhhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hj<>ubh<16> and then return it.<2E><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>hhhNhNubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hj~hKhj<>ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j<>hj<>ubeh}<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>uh+j<>hj<>ubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>cols<6C>Kuh+j<>hj<>ubah}<7D>(h!]<5D>h#]<5D><>autosummary longtable<6C>ah%]<5D>h']<5D>h)]<5D>uh+j<>hj<>ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>hjhkuh+j<>hh<>hhhj~hNubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+h<>hh@hhhhlhNubeh}<7D>(h!]<5D>h#]<5D>(<28>py<70><79>class<73>eh%]<5D>h']<5D>h)]<5D><>domain<69>jN<00>objtype<70>jO<00>desctype<70>jO<00>noindex<65><78>uh+h>hhhhhNhNubeh}<7D>(h!]<5D><>mlx-optimizers-optimizerstate<74>ah#]<5D>h%]<5D><>mlx.optimizers.optimizerstate<74>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>j<EFBFBD><00>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<EFBFBD><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\jYs<>	nametypes<65>}<7D>j\<00>sh!}<7D>(jYhh<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.