mirror of
				https://github.com/ml-explore/mlx.git
				synced 2025-11-04 02:28:13 +08:00 
			
		
		
		
	docs
This commit is contained in:
		
				
					committed by
					
						
						CircleCI Docs
					
				
			
			
				
	
			
			
			
						parent
						
							20a3e22ff0
						
					
				
				
					commit
					6f71a74c87
				
			
							
								
								
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.array.round.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.array.round.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,6 @@
 | 
			
		||||
mlx.core.array.round
 | 
			
		||||
====================
 | 
			
		||||
 | 
			
		||||
.. currentmodule:: mlx.core
 | 
			
		||||
 | 
			
		||||
.. automethod:: array.round
 | 
			
		||||
@@ -40,6 +40,7 @@
 | 
			
		||||
      ~array.prod
 | 
			
		||||
      ~array.reciprocal
 | 
			
		||||
      ~array.reshape
 | 
			
		||||
      ~array.round
 | 
			
		||||
      ~array.rsqrt
 | 
			
		||||
      ~array.sin
 | 
			
		||||
      ~array.split
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.clip.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.clip.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,6 @@
 | 
			
		||||
mlx.core.clip
 | 
			
		||||
=============
 | 
			
		||||
 | 
			
		||||
.. currentmodule:: mlx.core
 | 
			
		||||
 | 
			
		||||
.. autofunction:: clip
 | 
			
		||||
							
								
								
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.dequantize.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.dequantize.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,6 @@
 | 
			
		||||
mlx.core.dequantize
 | 
			
		||||
===================
 | 
			
		||||
 | 
			
		||||
.. currentmodule:: mlx.core
 | 
			
		||||
 | 
			
		||||
.. autofunction:: dequantize
 | 
			
		||||
							
								
								
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.floor_divide.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.floor_divide.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,6 @@
 | 
			
		||||
mlx.core.floor\_divide
 | 
			
		||||
======================
 | 
			
		||||
 | 
			
		||||
.. currentmodule:: mlx.core
 | 
			
		||||
 | 
			
		||||
.. autofunction:: floor_divide
 | 
			
		||||
							
								
								
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.linspace.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.linspace.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,6 @@
 | 
			
		||||
mlx.core.linspace
 | 
			
		||||
=================
 | 
			
		||||
 | 
			
		||||
.. currentmodule:: mlx.core
 | 
			
		||||
 | 
			
		||||
.. autofunction:: linspace
 | 
			
		||||
							
								
								
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.quantize.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.quantize.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,6 @@
 | 
			
		||||
mlx.core.quantize
 | 
			
		||||
=================
 | 
			
		||||
 | 
			
		||||
.. currentmodule:: mlx.core
 | 
			
		||||
 | 
			
		||||
.. autofunction:: quantize
 | 
			
		||||
							
								
								
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.quantized_matmul.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.quantized_matmul.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,6 @@
 | 
			
		||||
mlx.core.quantized\_matmul
 | 
			
		||||
==========================
 | 
			
		||||
 | 
			
		||||
.. currentmodule:: mlx.core
 | 
			
		||||
 | 
			
		||||
.. autofunction:: quantized_matmul
 | 
			
		||||
							
								
								
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.round.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								docs/build/html/_sources/python/_autosummary/mlx.core.round.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,6 @@
 | 
			
		||||
mlx.core.round
 | 
			
		||||
==============
 | 
			
		||||
 | 
			
		||||
.. currentmodule:: mlx.core
 | 
			
		||||
 | 
			
		||||
.. autofunction:: round
 | 
			
		||||
@@ -41,6 +41,7 @@
 | 
			
		||||
      ~Module.trainable_parameters
 | 
			
		||||
      ~Module.unfreeze
 | 
			
		||||
      ~Module.update
 | 
			
		||||
      ~Module.update_modules
 | 
			
		||||
      ~Module.valid_child_filter
 | 
			
		||||
      ~Module.valid_parameter_filter
 | 
			
		||||
      ~Module.values
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										18
									
								
								docs/build/html/_sources/python/_autosummary/mlx.optimizers.Lion.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								docs/build/html/_sources/python/_autosummary/mlx.optimizers.Lion.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,18 @@
 | 
			
		||||
mlx.optimizers.Lion
 | 
			
		||||
===================
 | 
			
		||||
 | 
			
		||||
.. currentmodule:: mlx.optimizers
 | 
			
		||||
 | 
			
		||||
.. autoclass:: Lion
 | 
			
		||||
 | 
			
		||||
   
 | 
			
		||||
 | 
			
		||||
   
 | 
			
		||||
   .. rubric:: Methods
 | 
			
		||||
 | 
			
		||||
   .. autosummary::
 | 
			
		||||
   
 | 
			
		||||
         ~Lion.__init__
 | 
			
		||||
         ~Lion.apply_single
 | 
			
		||||
   
 | 
			
		||||
   
 | 
			
		||||
							
								
								
									
										8
									
								
								docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.smooth_l1_loss.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								docs/build/html/_sources/python/_autosummary_functions/mlx.nn.losses.smooth_l1_loss.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,8 @@
 | 
			
		||||
mlx.nn.losses.smooth\_l1\_loss
 | 
			
		||||
==============================
 | 
			
		||||
 | 
			
		||||
.. currentmodule:: mlx.nn.losses
 | 
			
		||||
 | 
			
		||||
.. autoclass:: smooth_l1_loss
 | 
			
		||||
 | 
			
		||||
   
 | 
			
		||||
							
								
								
									
										1
									
								
								docs/build/html/_sources/python/array.rst
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								docs/build/html/_sources/python/array.rst
									
									
									
									
										vendored
									
									
								
							@@ -34,6 +34,7 @@ Array
 | 
			
		||||
    array.prod
 | 
			
		||||
    array.reciprocal
 | 
			
		||||
    array.reshape
 | 
			
		||||
    array.round
 | 
			
		||||
    array.rsqrt
 | 
			
		||||
    array.sin
 | 
			
		||||
    array.split
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										8
									
								
								docs/build/html/_sources/python/nn/_autosummary/mlx.nn.QuantizedLinear.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								docs/build/html/_sources/python/nn/_autosummary/mlx.nn.QuantizedLinear.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,8 @@
 | 
			
		||||
mlx.nn.QuantizedLinear
 | 
			
		||||
======================
 | 
			
		||||
 | 
			
		||||
.. currentmodule:: mlx.nn
 | 
			
		||||
 | 
			
		||||
.. autoclass:: QuantizedLinear
 | 
			
		||||
 | 
			
		||||
   
 | 
			
		||||
							
								
								
									
										8
									
								
								docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.smooth_l1_loss.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.smooth_l1_loss.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,8 @@
 | 
			
		||||
mlx.nn.losses.smooth\_l1\_loss
 | 
			
		||||
==============================
 | 
			
		||||
 | 
			
		||||
.. currentmodule:: mlx.nn.losses
 | 
			
		||||
 | 
			
		||||
.. autoclass:: smooth_l1_loss
 | 
			
		||||
 | 
			
		||||
   
 | 
			
		||||
							
								
								
									
										8
									
								
								docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.triplet_loss.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								docs/build/html/_sources/python/nn/_autosummary_functions/mlx.nn.losses.triplet_loss.rst
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,8 @@
 | 
			
		||||
mlx.nn.losses.triplet\_loss
 | 
			
		||||
===========================
 | 
			
		||||
 | 
			
		||||
.. currentmodule:: mlx.nn.losses
 | 
			
		||||
 | 
			
		||||
.. autoclass:: triplet_loss
 | 
			
		||||
 | 
			
		||||
   
 | 
			
		||||
@@ -26,3 +26,4 @@ Layers
 | 
			
		||||
   RoPE
 | 
			
		||||
   MultiHeadAttention
 | 
			
		||||
   Sequential
 | 
			
		||||
   QuantizedLinear
 | 
			
		||||
 
 | 
			
		||||
@@ -9,9 +9,11 @@ Loss Functions
 | 
			
		||||
   :toctree: _autosummary_functions
 | 
			
		||||
   :template: nn-module-template.rst
 | 
			
		||||
 | 
			
		||||
   cross_entropy
 | 
			
		||||
   binary_cross_entropy
 | 
			
		||||
   cross_entropy
 | 
			
		||||
   kl_div_loss
 | 
			
		||||
   l1_loss
 | 
			
		||||
   mse_loss
 | 
			
		||||
   nll_loss
 | 
			
		||||
   kl_div_loss
 | 
			
		||||
   smooth_l1_loss
 | 
			
		||||
   triplet_loss
 | 
			
		||||
							
								
								
									
										9
									
								
								docs/build/html/_sources/python/ops.rst
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										9
									
								
								docs/build/html/_sources/python/ops.rst
									
									
									
									
										vendored
									
									
								
							@@ -27,12 +27,14 @@ Operations
 | 
			
		||||
   array_equal
 | 
			
		||||
   broadcast_to
 | 
			
		||||
   ceil
 | 
			
		||||
   clip
 | 
			
		||||
   concatenate
 | 
			
		||||
   convolve
 | 
			
		||||
   conv1d
 | 
			
		||||
   conv2d
 | 
			
		||||
   cos
 | 
			
		||||
   cosh
 | 
			
		||||
   dequantize
 | 
			
		||||
   divide
 | 
			
		||||
   equal
 | 
			
		||||
   erf
 | 
			
		||||
@@ -40,14 +42,16 @@ Operations
 | 
			
		||||
   exp
 | 
			
		||||
   expand_dims
 | 
			
		||||
   eye
 | 
			
		||||
   floor
 | 
			
		||||
   flatten
 | 
			
		||||
   floor
 | 
			
		||||
   floor_divide
 | 
			
		||||
   full
 | 
			
		||||
   greater
 | 
			
		||||
   greater_equal
 | 
			
		||||
   identity
 | 
			
		||||
   less
 | 
			
		||||
   less_equal
 | 
			
		||||
   linspace
 | 
			
		||||
   load
 | 
			
		||||
   log
 | 
			
		||||
   log2
 | 
			
		||||
@@ -70,8 +74,11 @@ Operations
 | 
			
		||||
   partition
 | 
			
		||||
   pad
 | 
			
		||||
   prod
 | 
			
		||||
   quantize
 | 
			
		||||
   quantized_matmul
 | 
			
		||||
   reciprocal
 | 
			
		||||
   reshape
 | 
			
		||||
   round
 | 
			
		||||
   rsqrt
 | 
			
		||||
   save
 | 
			
		||||
   savez
 | 
			
		||||
 
 | 
			
		||||
@@ -44,3 +44,4 @@ model's parameters and the **optimizer state**.
 | 
			
		||||
   Adam
 | 
			
		||||
   AdamW
 | 
			
		||||
   Adamax
 | 
			
		||||
   Lion
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user