Files
mlx/docs/build/doctrees/usage/using_streams.doctree

24 lines
5.8 KiB
Plaintext
Raw Normal View History

2024-01-17 17:15:29 -08:00
<EFBFBD><05>M<00>sphinx.addnodes<65><73>document<6E><74><EFBFBD>)<29><>}<7D>(<28> rawsource<63><65><00><>children<65>]<5D>(<28>docutils.nodes<65><73>target<65><74><EFBFBD>)<29><>}<7D>(h<05>.. _using_streams:<3A>h]<5D><>
attributes<EFBFBD>}<7D>(<28>ids<64>]<5D><>classes<65>]<5D><>names<65>]<5D><>dupnames<65>]<5D><>backrefs<66>]<5D><>refid<69><64> using-streams<6D>u<EFBFBD>tagname<6D>h
<EFBFBD>line<6E>K<01>parent<6E>h<03> _document<6E>h<03>source<63><65></Users/awnihannun/repos/mlx/docs/src/usage/using_streams.rst<73>ubh <09>section<6F><6E><EFBFBD>)<29><>}<7D>(hhh]<5D>(h <09>title<6C><65><EFBFBD>)<29><>}<7D>(h<05> Using Streams<6D>h]<5D>h <09>Text<78><74><EFBFBD><EFBFBD> Using Streams<6D><73><EFBFBD><EFBFBD><EFBFBD>}<7D>(h h+h!hh"NhNubah}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D>uhh)h h&h!hh"h#hKubh%)<29><>}<7D>(hhh]<5D>(h*)<29><>}<7D>(h<05>Specifying the :obj:`Stream`<60>h]<5D>(h0<68>Specifying the <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(h h>h!hh"NhNubh<00> pending_xref<65><66><EFBFBD>)<29><>}<7D>(h<05> :obj:`Stream`<60>h]<5D>h <09>literal<61><6C><EFBFBD>)<29><>}<7D>(hhJh]<5D>h0<68>Stream<61><6D><EFBFBD><EFBFBD><EFBFBD>}<7D>(h hNh!hh"NhNubah}<7D>(h]<5D>h]<5D>(<28>xref<65><66>py<70><79>py-obj<62>eh]<5D>h]<5D>h]<5D>uhhLh hHubah}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D><>refdoc<6F><63>usage/using_streams<6D><73> refdomain<69>hY<68>reftype<70><65>obj<62><6A> refexplicit<69><74><EFBFBD>refwarn<72><6E><EFBFBD> py:module<6C><65>mlx.core<72><65>py:class<73>N<EFBFBD> reftarget<65><74>Stream<61>uhhFh"h#hKh h>ubeh}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D>uhh)h h;h!hh"h#hK ubh <09> paragraph<70><68><EFBFBD>)<29><>}<7D>(hXAll operations (including random number generation) take an optional
keyword argument ``stream``. The ``stream`` kwarg specifies which
:obj:`Stream` the operation should run on. If the stream is unspecified then
the operation is run on the default stream of the default device:
``mx.default_stream(mx.default_device())``. The ``stream`` kwarg can also
be a :obj:`Device` (e.g. ``stream=my_device``) in which case the operation is
run on the default stream of the provided device
``mx.default_stream(my_device)``.<2E>h]<5D>(h0<68>VAll operations (including random number generation) take an optional
keyword argument <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(h hxh!hh"NhNubhM)<29><>}<7D>(h<05>
``stream``<60>h]<5D>h0<68>stream<61><6D><EFBFBD><EFBFBD><EFBFBD>}<7D>(h h<>h!hh"NhNubah}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D>uhhLh hxubh0<68>. The <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(h hxh!hh"NhNubhM)<29><>}<7D>(h<05>
``stream``<60>h]<5D>h0<68>stream<61><6D><EFBFBD><EFBFBD><EFBFBD>}<7D>(h h<>h!hh"NhNubah}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D>uhhLh hxubh0<68> kwarg specifies which
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>}<7D>(h hxh!hh"NhNubhG)<29><>}<7D>(h<05> :obj:`Stream`<60>h]<5D>hM)<29><>}<7D>(hh<>h]<5D>h0<68>Stream<61><6D><EFBFBD><EFBFBD><EFBFBD>}<7D>(h h<>h!hh"NhNubah}<7D>(h]<5D>h]<5D>(hX<68>py<70><79>py-obj<62>eh]<5D>h]<5D>h]<5D>uhhLh h<>ubah}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D><>refdoc<6F>he<68> refdomain<69>h<EFBFBD><68>reftype<70><65>obj<62><6A> refexplicit<69><74><EFBFBD>refwarn<72><6E>hkhlhmNhn<68>Stream<61>uhhFh"h#hK h hxubh0<68><30> the operation should run on. If the stream is unspecified then
the operation is run on the default stream of the default device:
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>}<7D>(h hxh!hh"NhNubhM)<29><>}<7D>(h<05>*``mx.default_stream(mx.default_device())``<60>h]<5D>h0<68>&mx.default_stream(mx.default_device())<29><><EFBFBD><EFBFBD><EFBFBD>}<7D>(h h<>h!hh"NhNubah}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D>uhhLh hxubh0<68>. The <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(h hxh!hh"NhNubhM)<29><>}<7D>(h<05>
``stream``<60>h]<5D>h0<68>stream<61><6D><EFBFBD><EFBFBD><EFBFBD>}<7D>(h h<>h!hh"NhNubah}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D>uhhLh hxubh0<68> kwarg can also
be a <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(h hxh!hh"NhNubhG)<29><>}<7D>(h<05> :obj:`Device`<60>h]<5D>hM)<29><>}<7D>(hh<>h]<5D>h0<68>Device<63><65><EFBFBD><EFBFBD><EFBFBD>}<7D>(h h<>h!hh"NhNubah}<7D>(h]<5D>h]<5D>(hX<68>py<70><79>py-obj<62>eh]<5D>h]<5D>h]<5D>uhhLh h<>ubah}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D><>refdoc<6F>he<68> refdomain<69>h<EFBFBD><68>reftype<70><65>obj<62><6A> refexplicit<69><74><EFBFBD>refwarn<72><6E>hkhlhmNhn<68>Device<63>uhhFh"h#hK h hxubh0<68> (e.g. <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(h hxh!hh"NhNubhM)<29><>}<7D>(h<05>``stream=my_device``<60>h]<5D>h0<68>stream=my_device<63><65><EFBFBD><EFBFBD><EFBFBD>}<7D>(h jh!hh"NhNubah}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D>uhhLh hxubh0<68>R) in which case the operation is
run on the default stream of the provided device
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>}<7D>(h hxh!hh"NhNubhM)<29><>}<7D>(h<05> ``mx.default_stream(my_device)``<60>h]<5D>h0<68>mx.default_stream(my_device)<29><><EFBFBD><EFBFBD><EFBFBD>}<7D>(h j"h!hh"NhNubah}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D>uhhLh hxubh0<68>.<2E><><EFBFBD><EFBFBD><EFBFBD>}<7D>(h hxh!hh"NhNubeh}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D>uhhvh"h#hK h h;h!hubeh}<7D>(h]<5D><>specifying-the-stream<61>ah]<5D>h]<5D><>specifying the stream<61>ah]<5D>h]<5D>uhh$h h&h!hh"h#hK ubeh}<7D>(h]<5D>(h<1D>id1<64>eh]<5D>h]<5D>(<28> using streams<6D><73> using_streams<6D>eh]<5D>h]<5D>uhh$h hh!hh"h#hK<04>expect_referenced_by_name<6D>}<7D>jHh s<>expect_referenced_by_id<69>}<7D>hh subeh}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D><>source<63>h#uhh<01>current_source<63>N<EFBFBD> current_line<6E>N<EFBFBD>settings<67><73>docutils.frontend<6E><64>Values<65><73><EFBFBD>)<29><>}<7D>(h)N<> 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>jr<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#<23> _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>h]<5D>h as<61>nameids<64>}<7D>(jHhjGjDj?j<u<> nametypes<65>}<7D>(jH<00>jG<00>j?<00>uh}<7D>(hh&jDh&j<h;u<> 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>j<EFBFBD>Ks<><73>R<EFBFBD><52>parse_messages<65>]<5D><>transform_messages<65>]<5D>h <09>system_message<67><65><EFBFBD>)<29><>}<7D>(hhh]<5D>hw)<29><>}<7D>(hhh]<5D>h0<68>3Hyperlink target "using-streams" is not referenced.<2E><><EFBFBD><EFBFBD><EFBFBD>}<7D>h j<>sbah}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D>uhhvh j<>ubah}<7D>(h]<5D>h]<5D>h]<5D>h]<5D>h]<5D><>level<65>K<01>type<70><65>INFO<46><4F>source<63>h#<23>line<6E>Kuhj<>uba<62> transformer<65>N<EFBFBD> include_log<6F>]<5D><>
decoration<EFBFBD>Nh!hub.