mlx/docs/build/doctrees/python/nn/_autosummary/mlx.nn.Dropout3d.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.nn.Dropout3d<33>h]<5D>h	<09>Text<78><74><EFBFBD><EFBFBD>mlx.nn.Dropout3d<33><64><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>P/Users/awnihannun/repos/mlx/docs/src/python/nn/_autosummary/mlx.nn.Dropout3d.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>Dropout3d (class in mlx.nn)<29><>mlx.nn.Dropout3d<33>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>Dropout3d(p: float = 0.5)<29>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>h/Users/awnihannun/repos/mlx/python/mlx/nn/layers/dropout.py:docstring of mlx.nn.layers.dropout.Dropout3d<33>hNubh<00>desc_addname<6D><65><EFBFBD>)<29><>}<7D>(h<05>mlx.nn.<2E>h]<5D>h<16>mlx.nn.<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>(h<05>	Dropout3d<33>h]<5D>h<16>	Dropout3d<33><64><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+hhhEhhhhlhNubh<00>desc_parameterlist<73><74><EFBFBD>)<29><>}<7D>(h<05>p: float = 0.5<EFBFBD>h]<5D>h<00>desc_parameter<65><72><EFBFBD>)<29><>}<7D>(h<05>p: floatfloat = 0.5<EFBFBD>h]<5D>(h<00>
desc_sig_name<6D><65><EFBFBD>)<29><>}<7D>(h<05>
p<>h]<5D>h<16>
p<><70><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubah}<7D>(h!]<5D>h#]<5D><>
n<>ah%]<5D>h']<5D>h)]<5D>uh+h<>hh<>ubh<00>desc_sig_punctuation<6F><6E><EFBFBD>)<29><>}<7D>(h<05>
:<3A>h]<5D>h<16>
:<3A><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubah}<7D>(h!]<5D>h#]<5D><>
p<>ah%]<5D>h']<5D>h)]<5D>uh+h<>hh<>ubhT)<29><>}<7D>(h<05>
 <20>h]<5D>h<16>
 <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubah}<7D>(h!]<5D>h#]<5D>h`ah%]<5D>h']<5D>h)]<5D>uh+hShh<>ubh<62>)<29><>}<7D>(h<05>
floatfloat<EFBFBD>h]<5D>h<00>pending_xref<65><66><EFBFBD>)<29><>}<7D>(hhh]<5D>(h<00>pending_xref_condition<6F><6E><EFBFBD>)<29><>}<7D>(h<05>float<61>h]<5D>h<16>float<61><74><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	condition<6F><6E>resolved<65>uh+h<>hh<>ubh<62>)<29><>}<7D>(h<05>float<61>h]<5D>h<16>float<61><74><EFBFBD><EFBFBD><EFBFBD>}<7D>(hh<>hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	condition<6F><6E>
*<2A>uh+h<>hh<>ubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	refdomain<69><6E>py<70><79>reftype<70><65>class<73><73>	reftarget<65><74>float<61><74>refspecific<69><63><EFBFBD>	py:module<6C><65>mlx.nn<6E><6E>py:class<73>Nuh+h<>hh<>ubah}<7D>(h!]<5D>h#]<5D>h<EFBFBD>ah%]<5D>h']<5D>h)]<5D>uh+h<>hh<>ubhT)<29><>}<7D>(h<05>
 <20>h]<5D>h<16>
 <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h`ah%]<5D>h']<5D>h)]<5D>uh+hShh<>ubh<00>desc_sig_operator<6F><72><EFBFBD>)<29><>}<7D>(h<05>
=<3D>h]<5D>h<16>
=<3D><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj
hhhNhNubah}<7D>(h!]<5D>h#]<5D><>
o<>ah%]<5D>h']<5D>h)]<5D>uh+j
hh<>ubhT)<29><>}<7D>(h<05>
 <20>h]<5D>h<16>
 <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj-
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h`ah%]<5D>h']<5D>h)]<5D>uh+hShh<>ubh	<09>inline<6E><65><EFBFBD>)<29><>}<7D>(h<05>0.5<EFBFBD>h]<5D>h<16>0.5<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj=
hhhNhNubah}<7D>(h!]<5D>h#]<5D><>
default_value<75>ah%]<5D>h']<5D>h)]<5D><>support_smartquotes<65><73>uh+j;
hh<>ubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>hjhkuh+h<>hh<>ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>hjhkuh+h<>hhEhhhhlhNubeh}<7D>(h!]<5D>h<ah#]<5D>(<28>sig<69><67>
sig-object<63>eh%]<5D>h']<5D>h)]<5D><>module<6C><65>mlx.nn<6E>j

h<06>fullname<6D>h<EFBFBD>uh+hCh<1D>h/Users/awnihannun/repos/mlx/python/mlx/nn/layers/dropout.py:docstring of mlx.nn.layers.dropout.Dropout3d<33>hK
hh@hhubh<00>desc_content<6E><74><EFBFBD>)<29><>}<7D>(hhh]<5D>(h	<09>	paragraph<70><68><EFBFBD>)<29><>}<7D>(h<05>.Apply 3D channel-wise dropout during training.<2E>h]<5D>h<16>.Apply 3D channel-wise dropout during training.<2E><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjl
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+jj
h<1D>h/Users/awnihannun/repos/mlx/python/mlx/nn/layers/dropout.py:docstring of mlx.nn.layers.dropout.Dropout3d<33>hK
hjg
hhubjk
)<29><>}<7D>(hXD
Randomly zero out entire channels independently with probability :math:`p`.
This layer expects the channels to be last, i.e., the input shape should be
`NDHWC` or `DHWC` where: `N` is the batch dimension, `D` is the depth,
`H` is the input image height, `W` is the input image width, and `C` is
the number of input channels.<2E>h]<5D>(h<16>ARandomly zero out entire channels independently with probability <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj{
hhhNhNubh	<09>math<74><68><EFBFBD>)<29><>}<7D>(h<05>	:math:`p`<60>h]<5D>h<16>
p<><70><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j<>
hj{
ubh<16>N.
This layer expects the channels to be last, i.e., the input shape should be
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj{
hhhNhNubh	<09>title_reference<63><65><EFBFBD>)<29><>}<7D>(h<05>`NDHWC`<60>h]<5D>h<16>NDHWC<57><43><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j<>
hj{
ubh<16> or <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj{
hhhNhNubj<62>
)<29><>}<7D>(h<05>`DHWC`<60>h]<5D>h<16>DHWC<57><43><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j<>
hj{
ubh<16> where: <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj{
hhhNhNubj<62>
)<29><>}<7D>(h<05>`N`<60>h]<5D>h<16>
N<><4E><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j<>
hj{
ubh<16> is the batch dimension, <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj{
hhhNhNubj<62>
)<29><>}<7D>(h<05>`D`<60>h]<5D>h<16>
D<><44><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j<>
hj{
ubh<16> is the depth,
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj{
hhhNhNubj<62>
)<29><>}<7D>(h<05>`H`<60>h]<5D>h<16>
H<><48><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j<>
hj{
ubh<16> is the input image height, <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj{
hhhNhNubj<62>
)<29><>}<7D>(h<05>`W`<60>h]<5D>h<16>
W<><57><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>
hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j<>
hj{
ubh<16> is the input image width, and <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj{
hhhNhNubj<62>
)<29><>}<7D>(h<05>`C`<60>h]<5D>h<16>
C<><43><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjhhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j<>
hj{
ubh<16>! is
the number of input channels.<2E><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj{
hhhNhNubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+jj
hjz
hKhjg
hhubjk
)<29><>}<7D>(hX;
The remaining channels are scaled by :math:`\frac{1}{1-p}` to
maintain the expected value of each element. Unlike traditional dropout,
which zeros individual entries, this layer zeros entire channels. This is
often beneficial for convolutional layers processing 3D data, like in
medical imaging or video processing.<2E>h]<5D>(h<16>%The remaining channels are scaled by <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjhhhNhNubj<62>
)<29><>}<7D>(h<05>:math:`\frac{1}{1-p}`<60>h]<5D>h<16>
\frac{1}{1-p}<7D><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj%hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j<>
hjubhX

 to
maintain the expected value of each element. Unlike traditional dropout,
which zeros individual entries, this layer zeros entire channels. This is
often beneficial for convolutional layers processing 3D data, like in
medical imaging or video processing.<2E><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjhhhNhNubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+jj
hjz
hK	hjg
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>(hjIhhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+jGhjDhhlhKubh	<09>
field_body<EFBFBD><EFBFBD><EFBFBD>)<29><>}<7D>(hhh]<5D>jk
)<29><>}<7D>(h<05>Cp (floatfloat) -- Probability of zeroing a channel during training.<2E>h]<5D>(h<00>literal_strong<6E><67><EFBFBD>)<29><>}<7D>(hh<>h]<5D>h<16>
p<><70><EFBFBD><EFBFBD><EFBFBD>}<7D>(hjbhhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j`hj\ubh<16> (<28><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj\hhhNhNubh<62>)<29><>}<7D>(hhh]<5D>(h<>)<29><>}<7D>(h<05>float<61>h]<5D>h<00>literal_emphasis<69><73><EFBFBD>)<29><>}<7D>(h<05>float<61>h]<5D>h<16>float<61><74><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj|hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+jzhjvubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	condition<6F>h<EFBFBD>uh+h<>hjsubh<62>)<29><>}<7D>(h<05>float<61>h]<5D>j{)<29><>}<7D>(h<05>float<61>h]<5D>h<16>float<61><74><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj<>hhhNhNubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+jzhj<>ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	condition<6F>h<EFBFBD>uh+h<>hjsubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D><>	refdomain<69><6E>py<70><79>refexplicit<69><74><EFBFBD>reftype<70>j

<00>	reftarget<65>j<EFBFBD><00>refspecific<69><63><EFBFBD>	py:module<6C>jb
<00>py:class<73>h<EFBFBD>uh+h<>hj\ubh<16>
)<29><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj\hhhNhNubh<16> – <20><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj\hhhNhNubh<16>1Probability of zeroing a channel during training.<2E><><EFBFBD><EFBFBD><EFBFBD>}<7D>(hj\hhhNhNubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+jj
hjYubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+jWhjDubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+jBhj?ubah}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+j=hjg
hhhNhNubeh}<7D>(h!]<5D>h#]<5D>h%]<5D>h']<5D>h)]<5D>uh+je
hh@hhhhlhNubeh}<7D>(h!]<5D>h#]<5D>(j<><00>class<73>eh%]<5D>h']<5D>h)]<5D><>domain<69>j<EFBFBD><00>objtype<70>j<EFBFBD><00>desctype<70>j<EFBFBD><00>noindex<65><78>uh+h>hhhhhNhNubeh}<7D>(h!]<5D><>mlx-nn-dropout3d<33>ah#]<5D>h%]<5D><>mlx.nn.dropout3d<33>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.