-
+ 
-
+
+
diff --git a/docs/build/html/install.html b/docs/build/html/install.html
index 0c6c4ee16..fd15a81c4 100644
--- a/docs/build/html/install.html
+++ b/docs/build/html/install.html
@@ -8,7 +8,7 @@
-
-
+
+
diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv
index 9d125e2fa..7c7cf5103 100644
Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ
diff --git a/docs/build/html/python/_autosummary/mlx.core.Device.html b/docs/build/html/python/_autosummary/mlx.core.Device.html
index b4e33ed4f..28138d1cb 100644
--- a/docs/build/html/python/_autosummary/mlx.core.Device.html
+++ b/docs/build/html/python/_autosummary/mlx.core.Device.html
@@ -8,7 +8,7 @@
- 
-
+
+
@@ -939,7 +939,7 @@ document.write(`
A device to run operations on.
- -__init__(self, type: mlx.core.DeviceType, index: int = 0) None# +__init__(self, type: mlx.core.DeviceType, index: int = 0) None#
Methods
diff --git a/docs/build/html/python/_autosummary/mlx.core.Dtype.html b/docs/build/html/python/_autosummary/mlx.core.Dtype.html index 2254bedf2..e49350b4c 100644 --- a/docs/build/html/python/_autosummary/mlx.core.Dtype.html +++ b/docs/build/html/python/_autosummary/mlx.core.Dtype.html @@ -8,7 +8,7 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.DtypeCategory.html b/docs/build/html/python/_autosummary/mlx.core.DtypeCategory.html
index 114e0c5f0..82fcd9ed4 100644
--- a/docs/build/html/python/_autosummary/mlx.core.DtypeCategory.html
+++ b/docs/build/html/python/_autosummary/mlx.core.DtypeCategory.html
@@ -8,7 +8,7 @@
-
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.abs.html b/docs/build/html/python/_autosummary/mlx.core.abs.html
index b3ebe12f6..5901b1235 100644
--- a/docs/build/html/python/_autosummary/mlx.core.abs.html
+++ b/docs/build/html/python/_autosummary/mlx.core.abs.html
@@ -8,7 +8,7 @@
-
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.abs#
- -abs(a: array, /, *, stream: None | Stream | Device = None) array# +abs(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise absolute value.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.add.html b/docs/build/html/python/_autosummary/mlx.core.add.html index 04da49534..976fedb50 100644 --- a/docs/build/html/python/_autosummary/mlx.core.add.html +++ b/docs/build/html/python/_autosummary/mlx.core.add.html @@ -8,7 +8,7 @@ -
- -add(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +add(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise addition.
Add two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.addmm.html b/docs/build/html/python/_autosummary/mlx.core.addmm.html index 812551b2a..b4c54a122 100644 --- a/docs/build/html/python/_autosummary/mlx.core.addmm.html +++ b/docs/build/html/python/_autosummary/mlx.core.addmm.html @@ -8,7 +8,7 @@ -mlx.core.addmm — MLX 0.29.2 documentation +mlx.core.addmm — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.addmm#
- -addmm(c: array, a: array, b: array, /, alpha: float = 1.0, beta: float = 1.0, *, stream: None | Stream | Device = None) array# +addmm(c: array, a: array, b: array, /, alpha: float = 1.0, beta: float = 1.0, *, stream: None | Stream | Device = None) array#
Matrix multiplication with addition and optional scaling.
Perform the (possibly batched) matrix multiplication of two arrays and add to the result with optional scaling factors.
@@ -942,9 +942,9 @@ with optional scaling factors.c (array) – Input array or scalar.
a (array) – Input array or scalar.
b (array) – Input array or scalar.
alpha (float, optional) – Scaling factor for the +
alpha (float, optional) – Scaling factor for the matrix product of
aandb(default:1)beta (float, optional) – Scaling factor for
c(default:1)beta (float, optional) – Scaling factor for
c(default:1)- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.all.html b/docs/build/html/python/_autosummary/mlx.core.all.html index 38bbffde7..b6738e211 100644 --- a/docs/build/html/python/_autosummary/mlx.core.all.html +++ b/docs/build/html/python/_autosummary/mlx.core.all.html @@ -8,7 +8,7 @@ -
- -all(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array# +all(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array#
An and reduction over the given axes.
- Parameters:
a (array) – Input array.
-axis (int or list(int), optional) – Optional axis or axes to reduce over. If unspecified this defaults to reducing over the entire array.
-keepdims (bool, optional) – Keep reduced axes as +
keepdims (bool, optional) – Keep reduced axes as singleton dimensions, defaults to False.
diff --git a/docs/build/html/python/_autosummary/mlx.core.allclose.html b/docs/build/html/python/_autosummary/mlx.core.allclose.html
index 04ac068a3..a379d50c8 100644
--- a/docs/build/html/python/_autosummary/mlx.core.allclose.html
+++ b/docs/build/html/python/_autosummary/mlx.core.allclose.html
@@ -8,7 +8,7 @@
- - -allclose(a: array, b: array, /, rtol: float = 1e-05, atol: float = 1e-08, *, equal_nan: bool = False, stream: None | Stream | Device = None) array# +allclose(a: array, b: array, /, rtol: float = 1e-05, atol: float = 1e-08, *, equal_nan: bool = False, stream: None | Stream | Device = None) array#
Approximate comparison of two arrays.
Infinite values are considered equal if they have the same sign, NaN values are not equal unless
equal_nanisTrue.The arrays are considered equal if:
@@ -946,9 +946,9 @@ broadcasting.a (array) – Input array.
b (array) – Input array.
-rtol (float) – Relative tolerance.
-atol (float) – Absolute tolerance.
-equal_nan (bool) – If
True, NaNs are considered equal. +rtol (float) – Relative tolerance.
+atol (float) – Absolute tolerance.
+equal_nan (bool) – If
True, NaNs are considered equal. Defaults toFalse.
mlx.core.any — MLX 0.29.2 documentation +mlx.core.any — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,16 +932,16 @@ document.write(`
mlx.core.any#
- -any(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array# +any(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array#
An or reduction over the given axes.
- Parameters:
a (array) – Input array.
-axis (int or list(int), optional) – Optional axis or axes to reduce over. If unspecified this defaults to reducing over the entire array.
-keepdims (bool, optional) – Keep reduced axes as +
keepdims (bool, optional) – Keep reduced axes as singleton dimensions, defaults to False.
diff --git a/docs/build/html/python/_autosummary/mlx.core.arange.html b/docs/build/html/python/_autosummary/mlx.core.arange.html
index f636ae4bf..bb8b339e3 100644
--- a/docs/build/html/python/_autosummary/mlx.core.arange.html
+++ b/docs/build/html/python/_autosummary/mlx.core.arange.html
@@ -8,7 +8,7 @@
- - -arange(start: int | float, stop: int | float, step: None | int | float, dtype: Dtype | None = None, *, stream: None | Stream | Device = None) array# +arange(start: int | float, stop: int | float, step: None | int | float, dtype: Dtype | None = None, *, stream: None | Stream | Device = None) array#
- -arange(stop: int | float, step: None | int | float = None, dtype: Dtype | None = None, *, stream: None | Stream | Device = None) array +arange(stop: int | float, step: None | int | float = None, dtype: Dtype | None = None, *, stream: None | Stream | Device = None) array
Overloaded function.
diff --git a/docs/build/html/python/_autosummary/mlx.core.arccos.html b/docs/build/html/python/_autosummary/mlx.core.arccos.html index 8049eadd1..746d68478 100644 --- a/docs/build/html/python/_autosummary/mlx.core.arccos.html +++ b/docs/build/html/python/_autosummary/mlx.core.arccos.html @@ -8,7 +8,7 @@ -arange(start : Union[int, float], stop : Union[int, float], step : Union[None, int, float], dtype: Optional[Dtype] = None, *, stream: Union[None, Stream, Device] = None) -> arraymlx.core.arccos — MLX 0.29.2 documentation +mlx.core.arccos — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.arccos#
- -arccos(a: array, /, *, stream: None | Stream | Device = None) array# +arccos(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise inverse cosine.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.arccosh.html b/docs/build/html/python/_autosummary/mlx.core.arccosh.html index 3ef3d0c93..d39f3cae2 100644 --- a/docs/build/html/python/_autosummary/mlx.core.arccosh.html +++ b/docs/build/html/python/_autosummary/mlx.core.arccosh.html @@ -8,7 +8,7 @@ -
- -arccosh(a: array, /, *, stream: None | Stream | Device = None) array# +arccosh(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise inverse hyperbolic cosine.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.arcsin.html b/docs/build/html/python/_autosummary/mlx.core.arcsin.html index 835635a57..4be3ce315 100644 --- a/docs/build/html/python/_autosummary/mlx.core.arcsin.html +++ b/docs/build/html/python/_autosummary/mlx.core.arcsin.html @@ -8,7 +8,7 @@ -
- -arcsin(a: array, /, *, stream: None | Stream | Device = None) array# +arcsin(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise inverse sine.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.arcsinh.html b/docs/build/html/python/_autosummary/mlx.core.arcsinh.html index dd8f2f3ff..2976eb7dd 100644 --- a/docs/build/html/python/_autosummary/mlx.core.arcsinh.html +++ b/docs/build/html/python/_autosummary/mlx.core.arcsinh.html @@ -8,7 +8,7 @@ -
- -arcsinh(a: array, /, *, stream: None | Stream | Device = None) array# +arcsinh(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise inverse hyperbolic sine.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.arctan.html b/docs/build/html/python/_autosummary/mlx.core.arctan.html index ade61a5a5..32a01bccd 100644 --- a/docs/build/html/python/_autosummary/mlx.core.arctan.html +++ b/docs/build/html/python/_autosummary/mlx.core.arctan.html @@ -8,7 +8,7 @@ -
- -arctan(a: array, /, *, stream: None | Stream | Device = None) array# +arctan(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise inverse tangent.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.arctan2.html b/docs/build/html/python/_autosummary/mlx.core.arctan2.html index db2b9fed9..de9fba2fa 100644 --- a/docs/build/html/python/_autosummary/mlx.core.arctan2.html +++ b/docs/build/html/python/_autosummary/mlx.core.arctan2.html @@ -8,7 +8,7 @@ -
- -arctan2(a: array, b: array, /, *, stream: None | Stream | Device = None) array# +arctan2(a: array, b: array, /, *, stream: None | Stream | Device = None) array#
Element-wise inverse tangent of the ratio of two arrays.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.arctanh.html b/docs/build/html/python/_autosummary/mlx.core.arctanh.html index f9e392dd7..c1345d440 100644 --- a/docs/build/html/python/_autosummary/mlx.core.arctanh.html +++ b/docs/build/html/python/_autosummary/mlx.core.arctanh.html @@ -8,7 +8,7 @@ -
- -arctanh(a: array, /, *, stream: None | Stream | Device = None) array# +arctanh(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise inverse hyperbolic tangent.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.argmax.html b/docs/build/html/python/_autosummary/mlx.core.argmax.html index 76ba54bf8..cd871f1e8 100644 --- a/docs/build/html/python/_autosummary/mlx.core.argmax.html +++ b/docs/build/html/python/_autosummary/mlx.core.argmax.html @@ -8,7 +8,7 @@ -
- -argmax(a: array, /, axis: None | int = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array# +argmax(a: array, /, axis: None | int = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array#
Indices of the maximum values along the axis.
- Parameters:
a (array) – Input array.
-axis (int, optional) – Optional axis to reduce over. If unspecified +
axis (int, optional) – Optional axis to reduce over. If unspecified this defaults to reducing over the entire array.
-keepdims (bool, optional) – Keep reduced axes as +
keepdims (bool, optional) – Keep reduced axes as singleton dimensions, defaults to False.
diff --git a/docs/build/html/python/_autosummary/mlx.core.argmin.html b/docs/build/html/python/_autosummary/mlx.core.argmin.html
index c59bcd55f..167b99391 100644
--- a/docs/build/html/python/_autosummary/mlx.core.argmin.html
+++ b/docs/build/html/python/_autosummary/mlx.core.argmin.html
@@ -8,7 +8,7 @@
- - -argmin(a: array, /, axis: None | int = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array# +argmin(a: array, /, axis: None | int = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array#
Indices of the minimum values along the axis.
- Parameters:
a (array) – Input array.
-axis (int, optional) – Optional axis to reduce over. If unspecified +
axis (int, optional) – Optional axis to reduce over. If unspecified this defaults to reducing over the entire array.
-keepdims (bool, optional) – Keep reduced axes as +
keepdims (bool, optional) – Keep reduced axes as singleton dimensions, defaults to False.
diff --git a/docs/build/html/python/_autosummary/mlx.core.argpartition.html b/docs/build/html/python/_autosummary/mlx.core.argpartition.html
index 160c76cbd..742a1b886 100644
--- a/docs/build/html/python/_autosummary/mlx.core.argpartition.html
+++ b/docs/build/html/python/_autosummary/mlx.core.argpartition.html
@@ -8,7 +8,7 @@
- - -argpartition(a: array, /, kth: int, axis: None | int = -1, *, stream: None | Stream | Device = None) array# +argpartition(a: array, /, kth: int, axis: None | int = -1, *, stream: None | Stream | Device = None) array#
Returns the indices that partition the array.
The ordering of the elements within a partition in given by the indices is undefined.
@@ -940,12 +940,12 @@ is undefined.- Parameters:
a (array) – Input array.
-kth (int) – Element index at the
kthposition in the output will +kth (int) – Element index at the
kthposition in the output will give the sorted position. All indices before thekthposition will be of elements less or equal to the element at thekthindex and all indices after will be of elements greater or equal to the element at thekthindex.
-axis (int or None, optional) – Optional axis to partition over. +
axis (int or None, optional) – Optional axis to partition over. If
None, this partitions over the flattened array. If unspecified, it defaults to-1.
mlx.core.argsort — MLX 0.29.2 documentation +mlx.core.argsort — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.argsort#
- -argsort(a: array, /, axis: None | int = -1, *, stream: None | Stream | Device = None) array# +argsort(a: array, /, axis: None | int = -1, *, stream: None | Stream | Device = None) array#
Returns the indices that sort the array.
- Parameters:
a (array) – Input array.
-axis (int or None, optional) – Optional axis to sort over. +
axis (int or None, optional) – Optional axis to sort over. If
None, this sorts over the flattened array. If unspecified, it defaults to -1 (sorting over the last axis).
mlx.core.array.T — MLX 0.29.2 documentation +mlx.core.array.T — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.array.abs.html b/docs/build/html/python/_autosummary/mlx.core.array.abs.html
index e10dc953a..2d64735fa 100644
--- a/docs/build/html/python/_autosummary/mlx.core.array.abs.html
+++ b/docs/build/html/python/_autosummary/mlx.core.array.abs.html
@@ -8,7 +8,7 @@
- mlx.core.array.abs — MLX 0.29.2 documentation +mlx.core.array.abs — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.abs#
- -array.abs(self, *, stream: Optional[Union[Stream, Device]] = None) array# +array.abs(self, *, stream: Optional[Union[Stream, Device]] = None) array#
See
abs().
mlx.core.array.all — MLX 0.29.2 documentation +mlx.core.array.all — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.all#
- -array.all(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array# +array.all(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array#
See
all().
mlx.core.array.any — MLX 0.29.2 documentation +mlx.core.array.any — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.any#
- -array.any(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array# +array.any(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array#
See
any().
mlx.core.array.argmax — MLX 0.29.2 documentation +mlx.core.array.argmax — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.argmax#
- -array.argmax(self, axis: Optional[int] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array# +array.argmax(self, axis: Optional[int] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array#
See
argmax().
mlx.core.array.argmin — MLX 0.29.2 documentation +mlx.core.array.argmin — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.argmin#
- -array.argmin(self, axis: Optional[int] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array# +array.argmin(self, axis: Optional[int] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array#
See
argmin().
mlx.core.array.astype — MLX 0.29.2 documentation +mlx.core.array.astype — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.astype#
- -array.astype(self, dtype: Dtype, stream: Optional[Union[Stream, Device]] = None) array# +array.astype(self, dtype: Dtype, stream: Optional[Union[Stream, Device]] = None) array#
Cast the array to a specified type.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.array.at.html b/docs/build/html/python/_autosummary/mlx.core.array.at.html index a3180fe0c..29dc2d5a6 100644 --- a/docs/build/html/python/_autosummary/mlx.core.array.at.html +++ b/docs/build/html/python/_autosummary/mlx.core.array.at.html @@ -8,7 +8,7 @@ -
- -array.conj(self, *, stream: Optional[Union[Stream, Device]] = None) array# +array.conj(self, *, stream: Optional[Union[Stream, Device]] = None) array#
See
conj().- -array.cos(self, *, stream: Optional[Union[Stream, Device]] = None) array# +array.cos(self, *, stream: Optional[Union[Stream, Device]] = None) array#
See
cos().- -array.cummax(self, axis: Optional[int] = None, *, reverse: bool = False, inclusive: bool = True, stream: Optional[Union[Stream, Device]] = None) array# +array.cummax(self, axis: Optional[int] = None, *, reverse: bool = False, inclusive: bool = True, stream: Optional[Union[Stream, Device]] = None) array#
See
cummax().- -array.cummin(self, axis: Optional[int] = None, *, reverse: bool = False, inclusive: bool = True, stream: Optional[Union[Stream, Device]] = None) array# +array.cummin(self, axis: Optional[int] = None, *, reverse: bool = False, inclusive: bool = True, stream: Optional[Union[Stream, Device]] = None) array#
See
cummin().- -array.cumprod(self, axis: Optional[int] = None, *, reverse: bool = False, inclusive: bool = True, stream: Optional[Union[Stream, Device]] = None) array# +array.cumprod(self, axis: Optional[int] = None, *, reverse: bool = False, inclusive: bool = True, stream: Optional[Union[Stream, Device]] = None) array#
See
cumprod().- -array.cumsum(self, axis: Optional[int] = None, *, reverse: bool = False, inclusive: bool = True, stream: Optional[Union[Stream, Device]] = None) array# +array.cumsum(self, axis: Optional[int] = None, *, reverse: bool = False, inclusive: bool = True, stream: Optional[Union[Stream, Device]] = None) array#
See
cumsum().- -array.diag(self, k: int = 0, *, stream: Optional[Union[Stream, Device]] = None) array# +array.diag(self, k: int = 0, *, stream: Optional[Union[Stream, Device]] = None) array#
Extract a diagonal or construct a diagonal matrix.
- -array.diagonal(self, offset: int = 0, axis1: int = 0, axis2: int = 1, stream: Optional[Union[Stream, Device]] = None) array# +array.diagonal(self, offset: int = 0, axis1: int = 0, axis2: int = 1, stream: Optional[Union[Stream, Device]] = None) array#
See
diagonal().- -array.exp(self, *, stream: Optional[Union[Stream, Device]] = None) array# +array.exp(self, *, stream: Optional[Union[Stream, Device]] = None) array#
See
exp().- -array.flatten(self, start_axis: int = 0, end_axis: int = -1, *, stream: Optional[Union[Stream, Device]] = None) array# +array.flatten(self, start_axis: int = 0, end_axis: int = -1, *, stream: Optional[Union[Stream, Device]] = None) array#
See
flatten().An N-dimensional array object.
- -__init__(self: array, val: scalar | list | tuple | ndarray | array, dtype: Dtype | None = None)# +__init__(self: array, val: scalar | list | tuple | ndarray | array, dtype: Dtype | None = None)#
Methods
@@ -1036,7 +1036,7 @@ document.write(`See
reciprocal().reshape(self, *shape[, stream])Equivalent to
reshape()but the shape can be passed either as atupleor as separate arguments.Equivalent to
reshape()but the shape can be passed either as atupleor as separate arguments.round(self[, decimals, stream])See
round().See
swapaxes().tolist(self)Convert the array to a Python
list.Convert the array to a Python
list.transpose(self, *axes[, stream])Equivalent to
transpose()but the axes can be passed either as a tuple or as separate arguments.mlx.core.array.imag — MLX 0.29.2 documentation +mlx.core.array.imag — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.array.item.html b/docs/build/html/python/_autosummary/mlx.core.array.item.html
index 1b4704a9a..82c8900fa 100644
--- a/docs/build/html/python/_autosummary/mlx.core.array.item.html
+++ b/docs/build/html/python/_autosummary/mlx.core.array.item.html
@@ -8,7 +8,7 @@
- mlx.core.array.item — MLX 0.29.2 documentation +mlx.core.array.item — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.array.itemsize.html b/docs/build/html/python/_autosummary/mlx.core.array.itemsize.html
index 040af0b2d..37f63bba4 100644
--- a/docs/build/html/python/_autosummary/mlx.core.array.itemsize.html
+++ b/docs/build/html/python/_autosummary/mlx.core.array.itemsize.html
@@ -8,7 +8,7 @@
- mlx.core.array.itemsize — MLX 0.29.2 documentation +mlx.core.array.itemsize — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.array.log.html b/docs/build/html/python/_autosummary/mlx.core.array.log.html
index f6c55d0a3..f0d63a6d9 100644
--- a/docs/build/html/python/_autosummary/mlx.core.array.log.html
+++ b/docs/build/html/python/_autosummary/mlx.core.array.log.html
@@ -8,7 +8,7 @@
- mlx.core.array.log — MLX 0.29.2 documentation +mlx.core.array.log — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.log#
- -array.log(self, *, stream: Optional[Union[Stream, Device]] = None) array# +array.log(self, *, stream: Optional[Union[Stream, Device]] = None) array#
See
log().
mlx.core.array.log10 — MLX 0.29.2 documentation +mlx.core.array.log10 — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.log10#
- -array.log10(self, *, stream: Optional[Union[Stream, Device]] = None) array# +array.log10(self, *, stream: Optional[Union[Stream, Device]] = None) array#
See
log10().
mlx.core.array.log1p — MLX 0.29.2 documentation +mlx.core.array.log1p — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.log1p#
- -array.log1p(self, *, stream: Optional[Union[Stream, Device]] = None) array# +array.log1p(self, *, stream: Optional[Union[Stream, Device]] = None) array#
See
log1p().
mlx.core.array.log2 — MLX 0.29.2 documentation +mlx.core.array.log2 — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.log2#
- -array.log2(self, *, stream: Optional[Union[Stream, Device]] = None) array# +array.log2(self, *, stream: Optional[Union[Stream, Device]] = None) array#
See
log2().
mlx.core.array.logcumsumexp — MLX 0.29.2 documentation +mlx.core.array.logcumsumexp — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.logcumsumexp#
- -array.logcumsumexp(self, axis: Optional[int] = None, *, reverse: bool = False, inclusive: bool = True, stream: Optional[Union[Stream, Device]] = None) array# +array.logcumsumexp(self, axis: Optional[int] = None, *, reverse: bool = False, inclusive: bool = True, stream: Optional[Union[Stream, Device]] = None) array#
See
logcumsumexp().
mlx.core.array.logsumexp — MLX 0.29.2 documentation +mlx.core.array.logsumexp — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.logsumexp#
- -array.logsumexp(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array# +array.logsumexp(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array#
See
logsumexp().
mlx.core.array.max — MLX 0.29.2 documentation +mlx.core.array.max — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.max#
- -array.max(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array# +array.max(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array#
See
max().
mlx.core.array.mean — MLX 0.29.2 documentation +mlx.core.array.mean — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.mean#
- -array.mean(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array# +array.mean(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array#
See
mean().
mlx.core.array.min — MLX 0.29.2 documentation +mlx.core.array.min — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.min#
- -array.min(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array# +array.min(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array#
See
min().
mlx.core.array.moveaxis — MLX 0.29.2 documentation +mlx.core.array.moveaxis — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.moveaxis#
- -array.moveaxis(self, source: int, destination: int, *, stream: Optional[Union[Stream, Device]] = None) array# +array.moveaxis(self, source: int, destination: int, *, stream: Optional[Union[Stream, Device]] = None) array#
See
moveaxis().
mlx.core.array.nbytes — MLX 0.29.2 documentation +mlx.core.array.nbytes — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.array.ndim.html b/docs/build/html/python/_autosummary/mlx.core.array.ndim.html
index 29be2140d..f0e219be0 100644
--- a/docs/build/html/python/_autosummary/mlx.core.array.ndim.html
+++ b/docs/build/html/python/_autosummary/mlx.core.array.ndim.html
@@ -8,7 +8,7 @@
- mlx.core.array.ndim — MLX 0.29.2 documentation +mlx.core.array.ndim — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.array.prod.html b/docs/build/html/python/_autosummary/mlx.core.array.prod.html
index a9fede5ee..b1c01ccb7 100644
--- a/docs/build/html/python/_autosummary/mlx.core.array.prod.html
+++ b/docs/build/html/python/_autosummary/mlx.core.array.prod.html
@@ -8,7 +8,7 @@
- mlx.core.array.prod — MLX 0.29.2 documentation +mlx.core.array.prod — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.prod#
- -array.prod(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array# +array.prod(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array#
See
prod().
mlx.core.array.real — MLX 0.29.2 documentation +mlx.core.array.real — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.array.reciprocal.html b/docs/build/html/python/_autosummary/mlx.core.array.reciprocal.html
index a8b36f3c0..8b01d005e 100644
--- a/docs/build/html/python/_autosummary/mlx.core.array.reciprocal.html
+++ b/docs/build/html/python/_autosummary/mlx.core.array.reciprocal.html
@@ -8,7 +8,7 @@
- mlx.core.array.reciprocal — MLX 0.29.2 documentation +mlx.core.array.reciprocal — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.reciprocal#
- -array.reciprocal(self, *, stream: Optional[Union[Stream, Device]] = None) array# +array.reciprocal(self, *, stream: Optional[Union[Stream, Device]] = None) array#
See
reciprocal().
mlx.core.array.reshape — MLX 0.29.2 documentation +mlx.core.array.reshape — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,9 +932,9 @@ document.write(`
mlx.core.array.reshape#
- -array.reshape(self, *shape, stream: Optional[Union[Stream, Device]] = None) array# +array.reshape(self, *shape, stream: Optional[Union[Stream, Device]] = None) array#
Equivalent to
+reshape()but the shape can be passed either as a -tupleor as separate arguments.tupleor as separate arguments.See
reshape()for full documentation.
mlx.core.array.round — MLX 0.29.2 documentation +mlx.core.array.round — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.round#
- -array.round(self, decimals: int = 0, *, stream: Optional[Union[Stream, Device]] = None) array# +array.round(self, decimals: int = 0, *, stream: Optional[Union[Stream, Device]] = None) array#
See
round().
mlx.core.array.rsqrt — MLX 0.29.2 documentation +mlx.core.array.rsqrt — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.rsqrt#
- -array.rsqrt(self, *, stream: Optional[Union[Stream, Device]] = None) array# +array.rsqrt(self, *, stream: Optional[Union[Stream, Device]] = None) array#
See
rsqrt().
mlx.core.array.shape — MLX 0.29.2 documentation +mlx.core.array.shape — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -939,7 +939,7 @@ document.write(`
A tuple containing the sizes of each dimension.
- Return type:
-- +
diff --git a/docs/build/html/python/_autosummary/mlx.core.array.sin.html b/docs/build/html/python/_autosummary/mlx.core.array.sin.html index 56b8bff7c..f7119258b 100644 --- a/docs/build/html/python/_autosummary/mlx.core.array.sin.html +++ b/docs/build/html/python/_autosummary/mlx.core.array.sin.html @@ -8,7 +8,7 @@ -mlx.core.array.sin — MLX 0.29.2 documentation +mlx.core.array.sin — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.sin#
- -array.sin(self, *, stream: Optional[Union[Stream, Device]] = None) array# +array.sin(self, *, stream: Optional[Union[Stream, Device]] = None) array#
See
sin().
mlx.core.array.size — MLX 0.29.2 documentation +mlx.core.array.size — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.array.split.html b/docs/build/html/python/_autosummary/mlx.core.array.split.html
index 53503db03..cfd94592d 100644
--- a/docs/build/html/python/_autosummary/mlx.core.array.split.html
+++ b/docs/build/html/python/_autosummary/mlx.core.array.split.html
@@ -8,7 +8,7 @@
- mlx.core.array.split — MLX 0.29.2 documentation +mlx.core.array.split — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.split#
- -array.split(self, indices_or_sections: Union[int, tuple[int, ...]], axis: int = 0, *, stream: Optional[Union[Stream, Device]] = None) list[array]# +array.split(self, indices_or_sections: Union[int, tuple[int, ...]], axis: int = 0, *, stream: Optional[Union[Stream, Device]] = None) list[array]#
See
split().
mlx.core.array.sqrt — MLX 0.29.2 documentation +mlx.core.array.sqrt — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.sqrt#
- -array.sqrt(self, *, stream: Optional[Union[Stream, Device]] = None) array# +array.sqrt(self, *, stream: Optional[Union[Stream, Device]] = None) array#
See
sqrt().
mlx.core.array.square — MLX 0.29.2 documentation +mlx.core.array.square — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.square#
- -array.square(self, *, stream: Optional[Union[Stream, Device]] = None) array# +array.square(self, *, stream: Optional[Union[Stream, Device]] = None) array#
See
square().
mlx.core.array.squeeze — MLX 0.29.2 documentation +mlx.core.array.squeeze — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.squeeze#
- -array.squeeze(self, axis: Optional[Union[int, Sequence[int]]] = None, *, stream: Optional[Union[Stream, Device]] = None) array# +array.squeeze(self, axis: Optional[Union[int, Sequence[int]]] = None, *, stream: Optional[Union[Stream, Device]] = None) array#
See
squeeze().
mlx.core.array.std — MLX 0.29.2 documentation +mlx.core.array.std — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.std#
- -array.std(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, ddof: int = 0, *, stream: Optional[Union[Stream, Device]] = None) array# +array.std(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, ddof: int = 0, *, stream: Optional[Union[Stream, Device]] = None) array#
See
std().
mlx.core.array.sum — MLX 0.29.2 documentation +mlx.core.array.sum — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.sum#
- -array.sum(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array# +array.sum(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, *, stream: Optional[Union[Stream, Device]] = None) array#
See
sum().
mlx.core.array.swapaxes — MLX 0.29.2 documentation +mlx.core.array.swapaxes — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.swapaxes#
- -array.swapaxes(self, axis1: int, axis2: int, *, stream: Optional[Union[Stream, Device]] = None) array# +array.swapaxes(self, axis1: int, axis2: int, *, stream: Optional[Union[Stream, Device]] = None) array#
See
swapaxes().
mlx.core.array.tolist — MLX 0.29.2 documentation +mlx.core.array.tolist — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -933,7 +933,7 @@ document.write(`
- array.tolist(self) list_or_scalar# -
Convert the array to a Python
+list.Convert the array to a Python
list.
mlx.core.array.transpose — MLX 0.29.2 documentation +mlx.core.array.transpose — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.transpose#
- -array.transpose(self, *axes, stream: Optional[Union[Stream, Device]] = None) array# +array.transpose(self, *axes, stream: Optional[Union[Stream, Device]] = None) array#
Equivalent to
transpose()but the axes can be passed either as a tuple or as separate arguments.See
diff --git a/docs/build/html/python/_autosummary/mlx.core.array.var.html b/docs/build/html/python/_autosummary/mlx.core.array.var.html index bc4198fa8..75840509b 100644 --- a/docs/build/html/python/_autosummary/mlx.core.array.var.html +++ b/docs/build/html/python/_autosummary/mlx.core.array.var.html @@ -8,7 +8,7 @@ -transpose()for full documentation.mlx.core.array.var — MLX 0.29.2 documentation +mlx.core.array.var — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.var#
- -array.var(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, ddof: int = 0, *, stream: Optional[Union[Stream, Device]] = None) array# +array.var(self, axis: Optional[Union[int, Sequence[int]]] = None, keepdims: bool = False, ddof: int = 0, *, stream: Optional[Union[Stream, Device]] = None) array#
See
var().
mlx.core.array.view — MLX 0.29.2 documentation +mlx.core.array.view — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.view#
- -array.view(self, dtype: Dtype, *, stream: Optional[Union[Stream, Device]] = None) array# +array.view(self, dtype: Dtype, *, stream: Optional[Union[Stream, Device]] = None) array#
See
view().
mlx.core.array_equal — MLX 0.29.2 documentation +mlx.core.array_equal — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array_equal#
- -array_equal(a: scalar | array, b: scalar | array, equal_nan: bool = False, stream: None | Stream | Device = None) array# +array_equal(a: scalar | array, b: scalar | array, equal_nan: bool = False, stream: None | Stream | Device = None) array#
Array equality check.
Compare two arrays for equality. Returns
Trueif and only if the arrays have the same shape and their values are equal. The arrays need not have @@ -942,7 +942,7 @@ the same type to be considered equal.mlx.core.as_strided — MLX 0.29.2 documentation +mlx.core.as_strided — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.as_strided#
- -as_strided(a: array, /, shape: Sequence[int] | None = None, strides: Sequence[int] | None = None, offset: int = 0, *, stream: None | Stream | Device = None) array# +as_strided(a: array, /, shape: Sequence[int] | None = None, strides: Sequence[int] | None = None, offset: int = 0, *, stream: None | Stream | Device = None) array#
Create a view into the array with the given shape and strides.
The resulting array will always be as if the provided array was row contiguous regardless of the provided arrays storage order and current @@ -948,12 +948,12 @@ result into crashes.
- Parameters:
a (array) – Input array
-shape (list(int), optional) – The shape of the resulting array. If +
shape (list(int), optional) – The shape of the resulting array. If None it defaults to
a.shape().
-strides (list(int), optional) – The strides of the resulting array. If +
strides (list(int), optional) – The strides of the resulting array. If None it defaults to the reverse exclusive cumulative product of
a.shape().
-offset (int) – Skip that many elements from the beginning of the input +
offset (int) – Skip that many elements from the beginning of the input array.
diff --git a/docs/build/html/python/_autosummary/mlx.core.async_eval.html b/docs/build/html/python/_autosummary/mlx.core.async_eval.html
index bc64ac004..477a97243 100644
--- a/docs/build/html/python/_autosummary/mlx.core.async_eval.html
+++ b/docs/build/html/python/_autosummary/mlx.core.async_eval.html
@@ -8,7 +8,7 @@
- - Parameters:
*args (arrays or trees of arrays) – Each argument can be a single array or a tree of arrays. If a tree is given the nodes can be a Python -
list,tupleordict. Leaves which are not +list,tupleordict. Leaves which are not arrays are ignored.
mlx.core.async_eval — MLX 0.29.2 documentation +mlx.core.async_eval — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -942,7 +942,7 @@ document.write(`
mlx.core.atleast_1d — MLX 0.29.2 documentation +mlx.core.atleast_1d — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.atleast_1d#
- -atleast_1d(*arys: array, stream: None | Stream | Device = None) array | list[array]# +atleast_1d(*arys: array, stream: None | Stream | Device = None) array | list[array]#
Convert all arrays to have at least one dimension.
mlx.core.atleast_2d — MLX 0.29.2 documentation +mlx.core.atleast_2d — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.atleast_2d#
- -atleast_2d(*arys: array, stream: None | Stream | Device = None) array | list[array]# +atleast_2d(*arys: array, stream: None | Stream | Device = None) array | list[array]#
Convert all arrays to have at least two dimensions.
mlx.core.atleast_3d — MLX 0.29.2 documentation +mlx.core.atleast_3d — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.atleast_3d#
- -atleast_3d(*arys: array, stream: None | Stream | Device = None) array | list[array]# +atleast_3d(*arys: array, stream: None | Stream | Device = None) array | list[array]#
Convert all arrays to have at least three dimensions.
mlx.core.bitwise_and — MLX 0.29.2 documentation +mlx.core.bitwise_and — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.bitwise_and#
- -bitwise_and(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +bitwise_and(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise bitwise and.
Take the bitwise and of two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.bitwise_invert.html b/docs/build/html/python/_autosummary/mlx.core.bitwise_invert.html index f0d448581..c1769ad7e 100644 --- a/docs/build/html/python/_autosummary/mlx.core.bitwise_invert.html +++ b/docs/build/html/python/_autosummary/mlx.core.bitwise_invert.html @@ -8,7 +8,7 @@ -mlx.core.bitwise_invert — MLX 0.29.2 documentation +mlx.core.bitwise_invert — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.bitwise_invert#
- -bitwise_invert(a: scalar | array, stream: None | Stream | Device = None) array# +bitwise_invert(a: scalar | array, stream: None | Stream | Device = None) array#
Element-wise bitwise inverse.
Take the bitwise complement of the input.
-
diff --git a/docs/build/html/python/_autosummary/mlx.core.bitwise_or.html b/docs/build/html/python/_autosummary/mlx.core.bitwise_or.html
index a612f3c01..a3b02c1e5 100644
--- a/docs/build/html/python/_autosummary/mlx.core.bitwise_or.html
+++ b/docs/build/html/python/_autosummary/mlx.core.bitwise_or.html
@@ -8,7 +8,7 @@
-
- -bitwise_or(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +bitwise_or(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise bitwise or.
Take the bitwise or of two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.bitwise_xor.html b/docs/build/html/python/_autosummary/mlx.core.bitwise_xor.html index 6f823f4c7..5e542dcfb 100644 --- a/docs/build/html/python/_autosummary/mlx.core.bitwise_xor.html +++ b/docs/build/html/python/_autosummary/mlx.core.bitwise_xor.html @@ -8,7 +8,7 @@ -mlx.core.bitwise_xor — MLX 0.29.2 documentation +mlx.core.bitwise_xor — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.bitwise_xor#
- -bitwise_xor(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +bitwise_xor(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise bitwise xor.
Take the bitwise exclusive or of two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be diff --git a/docs/build/html/python/_autosummary/mlx.core.block_masked_mm.html b/docs/build/html/python/_autosummary/mlx.core.block_masked_mm.html index d25ac436f..cad137f2f 100644 --- a/docs/build/html/python/_autosummary/mlx.core.block_masked_mm.html +++ b/docs/build/html/python/_autosummary/mlx.core.block_masked_mm.html @@ -8,7 +8,7 @@ -
mlx.core.block_masked_mm — MLX 0.29.2 documentation +mlx.core.block_masked_mm — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -141,8 +141,8 @@ -
-
+
+
@@ -933,7 +933,7 @@ document.write(`
mlx.core.block_masked_mm#
- -block_masked_mm(a: array, b: array, /, block_size: int = 64, mask_out: array | None = None, mask_lhs: array | None = None, mask_rhs: array | None = None, *, stream: None | Stream | Device = None) array# +block_masked_mm(a: array, b: array, /, block_size: int = 64, mask_out: array | None = None, mask_lhs: array | None = None, mask_rhs: array | None = None, *, stream: None | Stream | Device = None) array#
Matrix multiplication with block masking.
Perform the (possibly batched) matrix multiplication of two arrays and with blocks of size
@@ -949,7 +949,7 @@ of sizeblock_size x block_sizeoptionally masked out.block_size<a (array) – Input array or scalar.
b (array) – Input array or scalar.
-block_size (int) – Size of blocks to be masked. Must be
32or64. Default:64.
+block_size (int) – Size of blocks to be masked. Must be
32or64. Default:64.mask_out (array, optional) – Mask for output. Default:
None.mask_lhs (array, optional) – Mask for
a. Default:None.mask_rhs (array, optional) – Mask for
b. Default:None.
diff --git a/docs/build/html/python/_autosummary/mlx.core.broadcast_arrays.html b/docs/build/html/python/_autosummary/mlx.core.broadcast_arrays.html
index 73d0d3e6e..a6d233cd7 100644
--- a/docs/build/html/python/_autosummary/mlx.core.broadcast_arrays.html
+++ b/docs/build/html/python/_autosummary/mlx.core.broadcast_arrays.html
@@ -8,7 +8,7 @@
- - -broadcast_arrays(*arrays: array, stream: None | Stream | Device = None) Tuple[array, ...]# +broadcast_arrays(*arrays: array, stream: None | Stream | Device = None) Tuple[array, ...]#
Broadcast arrays against one another.
The broadcasting semantics are the same as Numpy.
- -broadcast_to(a: scalar | array, /, shape: Sequence[int], *, stream: None | Stream | Device = None) array# +broadcast_to(a: scalar | array, /, shape: Sequence[int], *, stream: None | Stream | Device = None) array#
Broadcast an array to the given shape.
The broadcasting semantics are the same as Numpy.
- Parameters:
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.ceil.html b/docs/build/html/python/_autosummary/mlx.core.ceil.html index 3e6d61fd2..51f7d0820 100644 --- a/docs/build/html/python/_autosummary/mlx.core.ceil.html +++ b/docs/build/html/python/_autosummary/mlx.core.ceil.html @@ -8,7 +8,7 @@ -
- -ceil(a: array, /, *, stream: None | Stream | Device = None) array# +ceil(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise ceil.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.clear_cache.html b/docs/build/html/python/_autosummary/mlx.core.clear_cache.html index 1c180f8cf..0faa44f69 100644 --- a/docs/build/html/python/_autosummary/mlx.core.clear_cache.html +++ b/docs/build/html/python/_autosummary/mlx.core.clear_cache.html @@ -8,7 +8,7 @@ -
- -clear_cache() None# +clear_cache() None#
Clear the memory cache.
After calling this,
get_cache_memory()should return0.- -clip(a: array, /, a_min: scalar | array | None, a_max: scalar | array | None, *, stream: None | Stream | Device = None) array# +clip(a: array, /, a_min: scalar | array | None, a_max: scalar | array | None, *, stream: None | Stream | Device = None) array#
Clip the values of the array between the given minimum and maximum.
If either
a_minora_maxareNone, then corresponding edge is ignored. At least one ofa_minanda_maxcannot beNone. diff --git a/docs/build/html/python/_autosummary/mlx.core.compile.html b/docs/build/html/python/_autosummary/mlx.core.compile.html index bc04ef254..a30dd5bc8 100644 --- a/docs/build/html/python/_autosummary/mlx.core.compile.html +++ b/docs/build/html/python/_autosummary/mlx.core.compile.html @@ -8,7 +8,7 @@ -mlx.core.compile — MLX 0.29.2 documentation +mlx.core.compile — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.compile#
- -compile(fun: Callable, inputs: object | None = None, outputs: object | None = None, shapeless: bool = False) Callable# +compile(fun: Callable, inputs: object | None = None, outputs: object | None = None, shapeless: bool = False) Callable#
Returns a compiled function which produces the same output as
fun.- Parameters: @@ -940,17 +940,17 @@ document.write(`
fun (Callable) – A function which takes a variable number of
arrayor trees ofarrayand returns a variable number ofarrayor trees ofarray.inputs (list or dict, optional) – These inputs will be captured during +
inputs (list or dict, optional) – These inputs will be captured during the function compilation along with the inputs to
fun. Theinputs-can be alistor adictcontaining arbitrarily nested +can be alistor adictcontaining arbitrarily nested lists, dictionaries, or arrays. Leaf nodes that are notarrayare ignored. Default:Noneoutputs (list or dict, optional) – These outputs will be captured and +
outputs (list or dict, optional) – These outputs will be captured and updated in a compiled function. The
outputscan be a -listor adictcontaining arbitrarily nested lists, +listor adictcontaining arbitrarily nested lists, dictionaries, or arrays. Leaf nodes that are notarrayare ignored. Default:Noneshapeless (bool, optional) – A function compiled with the
shapeless+shapeless (bool, optional) – A function compiled with the
shapelessoption enabled will not be recompiled when the input shape changes. Not all functions can be compiled withshapelessenabled. Attempting to compile such functions with shapeless enabled will throw. Note, changing the number diff --git a/docs/build/html/python/_autosummary/mlx.core.concatenate.html b/docs/build/html/python/_autosummary/mlx.core.concatenate.html index 653eeea95..4a4cec769 100644 --- a/docs/build/html/python/_autosummary/mlx.core.concatenate.html +++ b/docs/build/html/python/_autosummary/mlx.core.concatenate.html @@ -8,7 +8,7 @@ -mlx.core.concatenate — MLX 0.29.2 documentation +mlx.core.concatenate — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.concatenate#
- -concatenate(arrays: list[array], axis: int | None = 0, *, stream: None | Stream | Device = None) array# +concatenate(arrays: list[array], axis: int | None = 0, *, stream: None | Stream | Device = None) array#
Concatenate the arrays along the given axis.
- Parameters:
- diff --git a/docs/build/html/python/_autosummary/mlx.core.conj.html b/docs/build/html/python/_autosummary/mlx.core.conj.html index 2146a84ec..196f3267b 100644 --- a/docs/build/html/python/_autosummary/mlx.core.conj.html +++ b/docs/build/html/python/_autosummary/mlx.core.conj.html @@ -8,7 +8,7 @@ -
- -conj(a: array, *, stream: None | Stream | Device = None) array# +conj(a: array, *, stream: None | Stream | Device = None) array#
Return the elementwise complex conjugate of the input. Alias for mx.conjugate.
-
diff --git a/docs/build/html/python/_autosummary/mlx.core.conjugate.html b/docs/build/html/python/_autosummary/mlx.core.conjugate.html
index b9df96599..1e1d0f9c0 100644
--- a/docs/build/html/python/_autosummary/mlx.core.conjugate.html
+++ b/docs/build/html/python/_autosummary/mlx.core.conjugate.html
@@ -8,7 +8,7 @@
-
- -conjugate(a: array, *, stream: None | Stream | Device = None) array# +conjugate(a: array, *, stream: None | Stream | Device = None) array#
Return the elementwise complex conjugate of the input. Alias for mx.conj.
-
diff --git a/docs/build/html/python/_autosummary/mlx.core.contiguous.html b/docs/build/html/python/_autosummary/mlx.core.contiguous.html
index f9acdeee3..7033cda02 100644
--- a/docs/build/html/python/_autosummary/mlx.core.contiguous.html
+++ b/docs/build/html/python/_autosummary/mlx.core.contiguous.html
@@ -8,7 +8,7 @@
-
- -contiguous(a: array, /, allow_col_major: bool = False, *, stream: None | Stream | Device = None) array# +contiguous(a: array, /, allow_col_major: bool = False, *, stream: None | Stream | Device = None) array#
Force an array to be row contiguous. Copy if necessary.
- Parameters:
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.conv1d.html b/docs/build/html/python/_autosummary/mlx.core.conv1d.html index 04ba47054..a68852892 100644 --- a/docs/build/html/python/_autosummary/mlx.core.conv1d.html +++ b/docs/build/html/python/_autosummary/mlx.core.conv1d.html @@ -8,7 +8,7 @@ -
- -conv1d(input: array, weight: array, /, stride: int = 1, padding: int = 0, dilation: int = 1, groups: int = 1, *, stream: None | Stream | Device = None) array# +conv1d(input: array, weight: array, /, stride: int = 1, padding: int = 0, dilation: int = 1, groups: int = 1, *, stream: None | Stream | Device = None) array#
1D convolution over an input with several channels
- Parameters:
input (array) – Input array of shape
(N, L, C_in).weight (array) – Weight array of shape
(C_out, K, C_in).
-stride (int, optional) – Kernel stride. Default:
1.
-padding (int, optional) – Input padding. Default:
0.
-dilation (int, optional) – Kernel dilation. Default:
1.
-groups (int, optional) – Input feature groups. Default:
1.
+stride (int, optional) – Kernel stride. Default:
1.
+padding (int, optional) – Input padding. Default:
0.
+dilation (int, optional) – Kernel dilation. Default:
1.
+groups (int, optional) – Input feature groups. Default:
1.
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.conv2d.html b/docs/build/html/python/_autosummary/mlx.core.conv2d.html index 4e1e2e104..1fd0536f1 100644 --- a/docs/build/html/python/_autosummary/mlx.core.conv2d.html +++ b/docs/build/html/python/_autosummary/mlx.core.conv2d.html @@ -8,7 +8,7 @@ -
- -conv2d(input: array, weight: array, /, stride: int | tuple[int, int] = 1, padding: int | tuple[int, int] = 0, dilation: int | tuple[int, int] = 1, groups: int = 1, *, stream: None | Stream | Device = None) array# +conv2d(input: array, weight: array, /, stride: int | tuple[int, int] = 1, padding: int | tuple[int, int] = 0, dilation: int | tuple[int, int] = 1, groups: int = 1, *, stream: None | Stream | Device = None) array#
2D convolution over an input with several channels
- Parameters:
input (array) – Input array of shape
(N, H, W, C_in).weight (array) – Weight array of shape
(C_out, KH, KW, C_in).
-stride (int or tuple(int), optional) –
tupleof size 2 with +stride (int or tuple(int), optional) –
tupleof size 2 with kernel strides. All spatial dimensions get the same stride if only one number is specified. Default:1.
-padding (int or tuple(int), optional) –
tupleof size 2 with +padding (int or tuple(int), optional) –
tupleof size 2 with symmetric input padding. All spatial dimensions get the same padding if only one number is specified. Default:0.
-dilation (int or tuple(int), optional) –
tupleof size 2 with +dilation (int or tuple(int), optional) –
tupleof size 2 with kernel dilation. All spatial dimensions get the same dilation if only one number is specified. Default:1
-groups (int, optional) – input feature groups. Default:
1.
+groups (int, optional) – input feature groups. Default:
1.
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.conv3d.html b/docs/build/html/python/_autosummary/mlx.core.conv3d.html index 9bb6bccfa..72ef40086 100644 --- a/docs/build/html/python/_autosummary/mlx.core.conv3d.html +++ b/docs/build/html/python/_autosummary/mlx.core.conv3d.html @@ -8,7 +8,7 @@ -
- -conv3d(input: array, weight: array, /, stride: int | tuple[int, int, int] = 1, padding: int | tuple[int, int, int] = 0, dilation: int | tuple[int, int, int] = 1, groups: int = 1, *, stream: None | Stream | Device = None) array# +conv3d(input: array, weight: array, /, stride: int | tuple[int, int, int] = 1, padding: int | tuple[int, int, int] = 0, dilation: int | tuple[int, int, int] = 1, groups: int = 1, *, stream: None | Stream | Device = None) array#
3D convolution over an input with several channels
Note: Only the default
groups=1is currently supported.-
@@ -940,16 +940,16 @@ document.write(`
input (array) – Input array of shape
(N, D, H, W, C_in).weight (array) – Weight array of shape
(C_out, KD, KH, KW, C_in).
-stride (int or tuple(int), optional) –
tupleof size 3 with +stride (int or tuple(int), optional) –
tupleof size 3 with kernel strides. All spatial dimensions get the same stride if only one number is specified. Default:1.
-padding (int or tuple(int), optional) –
tupleof size 3 with +padding (int or tuple(int), optional) –
tupleof size 3 with symmetric input padding. All spatial dimensions get the same padding if only one number is specified. Default:0.
-dilation (int or tuple(int), optional) –
tupleof size 3 with +dilation (int or tuple(int), optional) –
tupleof size 3 with kernel dilation. All spatial dimensions get the same dilation if only one number is specified. Default:1
-groups (int, optional) – input feature groups. Default:
1.
+groups (int, optional) – input feature groups. Default:
1.
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.conv_general.html b/docs/build/html/python/_autosummary/mlx.core.conv_general.html index 001509b97..d601ce0ed 100644 --- a/docs/build/html/python/_autosummary/mlx.core.conv_general.html +++ b/docs/build/html/python/_autosummary/mlx.core.conv_general.html @@ -8,7 +8,7 @@ -
- -conv_general(input: array, weight: array, /, stride: int | Sequence[int] = 1, padding: int | Sequence[int] | tuple[Sequence[int], Sequence[int]] = 0, kernel_dilation: int | Sequence[int] = 1, input_dilation: int | Sequence[int] = 1, groups: int = 1, flip: bool = False, *, stream: None | Stream | Device = None) array# +conv_general(input: array, weight: array, /, stride: int | Sequence[int] = 1, padding: int | Sequence[int] | tuple[Sequence[int], Sequence[int]] = 0, kernel_dilation: int | Sequence[int] = 1, input_dilation: int | Sequence[int] = 1, groups: int = 1, flip: bool = False, *, stream: None | Stream | Device = None) array#
General convolution over an input with several channels
- Parameters:
input (array) – Input array of shape
(N, ..., C_in).weight (array) – Weight array of shape
(C_out, ..., C_in).
-stride (int or list(int), optional) –
listwith kernel strides. +stride (int or list(int), optional) –
listwith kernel strides. All spatial dimensions get the same stride if only one number is specified. Default:1.
-padding (int, list(int), or tuple(list(int), list(int)), optional) –
listwith input padding. All spatial dimensions get the same +padding (int, list(int), or tuple(list(int), list(int)), optional) –
listwith input padding. All spatial dimensions get the same padding if only one number is specified. Default:0.
-kernel_dilation (int or list(int), optional) –
listwith kernel dilation. All spatial dimensions get the same dilation if only one number is specified. Default:1
-input_dilation (int or list(int), optional) –
listwith input dilation. All spatial dimensions get the same dilation if only one number is specified. Default:1
-groups (int, optional) – Input feature groups. Default:
1.
-flip (bool, optional) – Flip the order in which the spatial dimensions of +
groups (int, optional) – Input feature groups. Default:
1.
+flip (bool, optional) – Flip the order in which the spatial dimensions of the weights are processed. Performs the cross-correlation operator when
flipisFalseand the convolution operator otherwise. Default:False.
diff --git a/docs/build/html/python/_autosummary/mlx.core.conv_transpose1d.html b/docs/build/html/python/_autosummary/mlx.core.conv_transpose1d.html
index 80225ef6e..9574eded6 100644
--- a/docs/build/html/python/_autosummary/mlx.core.conv_transpose1d.html
+++ b/docs/build/html/python/_autosummary/mlx.core.conv_transpose1d.html
@@ -8,7 +8,7 @@
- - -conv_transpose1d(input: array, weight: array, /, stride: int = 1, padding: int = 0, dilation: int = 1, output_padding: int = 0, groups: int = 1, *, stream: None | Stream | Device = None) array# +conv_transpose1d(input: array, weight: array, /, stride: int = 1, padding: int = 0, dilation: int = 1, output_padding: int = 0, groups: int = 1, *, stream: None | Stream | Device = None) array#
1D transposed convolution over an input with several channels
- Parameters:
input (array) – Input array of shape
(N, L, C_in).weight (array) – Weight array of shape
(C_out, K, C_in).
-stride (int, optional) – Kernel stride. Default:
1.
-padding (int, optional) – Input padding. Default:
0.
-dilation (int, optional) – Kernel dilation. Default:
1.
-output_padding (int, optional) – Output padding. Default:
0.
-groups (int, optional) – Input feature groups. Default:
1.
+stride (int, optional) – Kernel stride. Default:
1.
+padding (int, optional) – Input padding. Default:
0.
+dilation (int, optional) – Kernel dilation. Default:
1.
+output_padding (int, optional) – Output padding. Default:
0.
+groups (int, optional) – Input feature groups. Default:
1.
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.conv_transpose2d.html b/docs/build/html/python/_autosummary/mlx.core.conv_transpose2d.html index 73b7c335c..aeb23f841 100644 --- a/docs/build/html/python/_autosummary/mlx.core.conv_transpose2d.html +++ b/docs/build/html/python/_autosummary/mlx.core.conv_transpose2d.html @@ -8,7 +8,7 @@ -
- -conv_transpose2d(input: array, weight: array, /, stride: int | Tuple[int, int] = 1, padding: int | Tuple[int, int] = 0, dilation: int | Tuple[int, int] = 1, output_padding: int | Tuple[int, int] = 0, groups: int = 1, *, stream: None | Stream | Device = None) array# +conv_transpose2d(input: array, weight: array, /, stride: int | Tuple[int, int] = 1, padding: int | Tuple[int, int] = 0, dilation: int | Tuple[int, int] = 1, output_padding: int | Tuple[int, int] = 0, groups: int = 1, *, stream: None | Stream | Device = None) array#
2D transposed convolution over an input with several channels
Note: Only the default
groups=1is currently supported.-
@@ -940,19 +940,19 @@ document.write(`
input (array) – Input array of shape
(N, H, W, C_in).weight (array) – Weight array of shape
(C_out, KH, KW, C_in).
-stride (int or tuple(int), optional) –
tupleof size 2 with +stride (int or tuple(int), optional) –
tupleof size 2 with kernel strides. All spatial dimensions get the same stride if only one number is specified. Default:1.
-padding (int or tuple(int), optional) –
tupleof size 2 with +padding (int or tuple(int), optional) –
tupleof size 2 with symmetric input padding. All spatial dimensions get the same padding if only one number is specified. Default:0.
-dilation (int or tuple(int), optional) –
tupleof size 2 with +dilation (int or tuple(int), optional) –
tupleof size 2 with kernel dilation. All spatial dimensions get the same dilation if only one number is specified. Default:1
-output_padding (int or tuple(int), optional) –
tupleof size 2 with +output_padding (int or tuple(int), optional) –
tupleof size 2 with output padding. All spatial dimensions get the same output padding if only one number is specified. Default:0.
-groups (int, optional) – input feature groups. Default:
1.
+groups (int, optional) – input feature groups. Default:
1.
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.conv_transpose3d.html b/docs/build/html/python/_autosummary/mlx.core.conv_transpose3d.html index 79174d458..9934a3374 100644 --- a/docs/build/html/python/_autosummary/mlx.core.conv_transpose3d.html +++ b/docs/build/html/python/_autosummary/mlx.core.conv_transpose3d.html @@ -8,7 +8,7 @@ -
- -conv_transpose3d(input: array, weight: array, /, stride: int | Tuple[int, int, int] = 1, padding: int | Tuple[int, int, int] = 0, dilation: int | Tuple[int, int, int] = 1, output_padding: int | Tuple[int, int, int] = 0, groups: int = 1, *, stream: None | Stream | Device = None) array# +conv_transpose3d(input: array, weight: array, /, stride: int | Tuple[int, int, int] = 1, padding: int | Tuple[int, int, int] = 0, dilation: int | Tuple[int, int, int] = 1, output_padding: int | Tuple[int, int, int] = 0, groups: int = 1, *, stream: None | Stream | Device = None) array#
3D transposed convolution over an input with several channels
Note: Only the default
groups=1is currently supported.-
@@ -940,19 +940,19 @@ document.write(`
input (array) – Input array of shape
(N, D, H, W, C_in).weight (array) – Weight array of shape
(C_out, KD, KH, KW, C_in).
-stride (int or tuple(int), optional) –
tupleof size 3 with +stride (int or tuple(int), optional) –
tupleof size 3 with kernel strides. All spatial dimensions get the same stride if only one number is specified. Default:1.
-padding (int or tuple(int), optional) –
tupleof size 3 with +padding (int or tuple(int), optional) –
tupleof size 3 with symmetric input padding. All spatial dimensions get the same padding if only one number is specified. Default:0.
-dilation (int or tuple(int), optional) –
tupleof size 3 with +dilation (int or tuple(int), optional) –
tupleof size 3 with kernel dilation. All spatial dimensions get the same dilation if only one number is specified. Default:1
-output_padding (int or tuple(int), optional) –
tupleof size 3 with +output_padding (int or tuple(int), optional) –
tupleof size 3 with output padding. All spatial dimensions get the same output padding if only one number is specified. Default:0.
-groups (int, optional) – input feature groups. Default:
1.
+groups (int, optional) – input feature groups. Default:
1.
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.convolve.html b/docs/build/html/python/_autosummary/mlx.core.convolve.html index 60ac75072..5ea3adf83 100644 --- a/docs/build/html/python/_autosummary/mlx.core.convolve.html +++ b/docs/build/html/python/_autosummary/mlx.core.convolve.html @@ -8,7 +8,7 @@ -
- -convolve(a: array, v: array, /, mode: str = 'full', *, stream: None | Stream | Device = None) array# +convolve(a: array, v: array, /, mode: str = 'full', *, stream: None | Stream | Device = None) array#
The discrete convolution of 1D arrays.
If
@@ -941,7 +941,7 @@ The conv filter is flipped following signal processing convention.vis longer thana, then they are swapped. The conv filter is flipped following signal processing convention.- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.cos.html b/docs/build/html/python/_autosummary/mlx.core.cos.html index f39af5ea4..d5af5c768 100644 --- a/docs/build/html/python/_autosummary/mlx.core.cos.html +++ b/docs/build/html/python/_autosummary/mlx.core.cos.html @@ -8,7 +8,7 @@ -
- -cos(a: array, /, *, stream: None | Stream | Device = None) array# +cos(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise cosine.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.cosh.html b/docs/build/html/python/_autosummary/mlx.core.cosh.html index 6e0626d83..fe5425201 100644 --- a/docs/build/html/python/_autosummary/mlx.core.cosh.html +++ b/docs/build/html/python/_autosummary/mlx.core.cosh.html @@ -8,7 +8,7 @@ -
- -cosh(a: array, /, *, stream: None | Stream | Device = None) array# +cosh(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise hyperbolic cosine.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.cuda.is_available.html b/docs/build/html/python/_autosummary/mlx.core.cuda.is_available.html index 15b84273b..e7af101de 100644 --- a/docs/build/html/python/_autosummary/mlx.core.cuda.is_available.html +++ b/docs/build/html/python/_autosummary/mlx.core.cuda.is_available.html @@ -8,7 +8,7 @@ -
- -cummax(a: array, /, axis: int | None = None, *, reverse: bool = False, inclusive: bool = True, stream: None | Stream | Device = None) array# +cummax(a: array, /, axis: int | None = None, *, reverse: bool = False, inclusive: bool = True, stream: None | Stream | Device = None) array#
Return the cumulative maximum of the elements along the given axis.
- Parameters:
a (array) – Input array
-axis (int, optional) – Optional axis to compute the cumulative maximum +
axis (int, optional) – Optional axis to compute the cumulative maximum over. If unspecified the cumulative maximum of the flattened array is returned.
-reverse (bool) – Perform the cumulative maximum in reverse.
-inclusive (bool) – The i-th element of the output includes the i-th +
reverse (bool) – Perform the cumulative maximum in reverse.
+inclusive (bool) – The i-th element of the output includes the i-th element of the input.
diff --git a/docs/build/html/python/_autosummary/mlx.core.cummin.html b/docs/build/html/python/_autosummary/mlx.core.cummin.html
index 1ed73da00..b8ef6c806 100644
--- a/docs/build/html/python/_autosummary/mlx.core.cummin.html
+++ b/docs/build/html/python/_autosummary/mlx.core.cummin.html
@@ -8,7 +8,7 @@
- - -cummin(a: array, /, axis: int | None = None, *, reverse: bool = False, inclusive: bool = True, stream: None | Stream | Device = None) array# +cummin(a: array, /, axis: int | None = None, *, reverse: bool = False, inclusive: bool = True, stream: None | Stream | Device = None) array#
Return the cumulative minimum of the elements along the given axis.
- Parameters:
a (array) – Input array
-axis (int, optional) – Optional axis to compute the cumulative minimum +
axis (int, optional) – Optional axis to compute the cumulative minimum over. If unspecified the cumulative minimum of the flattened array is returned.
-reverse (bool) – Perform the cumulative minimum in reverse.
-inclusive (bool) – The i-th element of the output includes the i-th +
reverse (bool) – Perform the cumulative minimum in reverse.
+inclusive (bool) – The i-th element of the output includes the i-th element of the input.
diff --git a/docs/build/html/python/_autosummary/mlx.core.cumprod.html b/docs/build/html/python/_autosummary/mlx.core.cumprod.html
index fb81b6a13..5250357eb 100644
--- a/docs/build/html/python/_autosummary/mlx.core.cumprod.html
+++ b/docs/build/html/python/_autosummary/mlx.core.cumprod.html
@@ -8,7 +8,7 @@
- - -cumprod(a: array, /, axis: int | None = None, *, reverse: bool = False, inclusive: bool = True, stream: None | Stream | Device = None) array# +cumprod(a: array, /, axis: int | None = None, *, reverse: bool = False, inclusive: bool = True, stream: None | Stream | Device = None) array#
Return the cumulative product of the elements along the given axis.
- Parameters:
a (array) – Input array
-axis (int, optional) – Optional axis to compute the cumulative product +
axis (int, optional) – Optional axis to compute the cumulative product over. If unspecified the cumulative product of the flattened array is returned.
-reverse (bool) – Perform the cumulative product in reverse.
-inclusive (bool) – The i-th element of the output includes the i-th +
reverse (bool) – Perform the cumulative product in reverse.
+inclusive (bool) – The i-th element of the output includes the i-th element of the input.
diff --git a/docs/build/html/python/_autosummary/mlx.core.cumsum.html b/docs/build/html/python/_autosummary/mlx.core.cumsum.html
index 87e1bc8fe..5030d4204 100644
--- a/docs/build/html/python/_autosummary/mlx.core.cumsum.html
+++ b/docs/build/html/python/_autosummary/mlx.core.cumsum.html
@@ -8,7 +8,7 @@
- - -cumsum(a: array, /, axis: int | None = None, *, reverse: bool = False, inclusive: bool = True, stream: None | Stream | Device = None) array# +cumsum(a: array, /, axis: int | None = None, *, reverse: bool = False, inclusive: bool = True, stream: None | Stream | Device = None) array#
Return the cumulative sum of the elements along the given axis.
- Parameters:
a (array) – Input array
-axis (int, optional) – Optional axis to compute the cumulative sum +
axis (int, optional) – Optional axis to compute the cumulative sum over. If unspecified the cumulative sum of the flattened array is returned.
-reverse (bool) – Perform the cumulative sum in reverse.
-inclusive (bool) – The i-th element of the output includes the i-th +
reverse (bool) – Perform the cumulative sum in reverse.
+inclusive (bool) – The i-th element of the output includes the i-th element of the input.
diff --git a/docs/build/html/python/_autosummary/mlx.core.custom_function.html b/docs/build/html/python/_autosummary/mlx.core.custom_function.html
index 7a73b4639..0db2a36b4 100644
--- a/docs/build/html/python/_autosummary/mlx.core.custom_function.html
+++ b/docs/build/html/python/_autosummary/mlx.core.custom_function.html
@@ -8,7 +8,7 @@
- - -degrees(a: array, /, *, stream: None | Stream | Device = None) array# +degrees(a: array, /, *, stream: None | Stream | Device = None) array#
Convert angles from radians to degrees.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.dequantize.html b/docs/build/html/python/_autosummary/mlx.core.dequantize.html index af3d727ad..36a00fa7d 100644 --- a/docs/build/html/python/_autosummary/mlx.core.dequantize.html +++ b/docs/build/html/python/_autosummary/mlx.core.dequantize.html @@ -8,7 +8,7 @@ -
- -dequantize(w: array, /, scales: array, biases: array | None = None, group_size: int = 64, bits: int = 4, mode: str = 'affine', *, stream: None | Stream | Device = None) array# +dequantize(w: array, /, scales: array, biases: array | None = None, group_size: int = 64, bits: int = 4, mode: str = 'affine', *, stream: None | Stream | Device = None) array#
Dequantize the matrix
wusing quantization parameters.- Parameters: @@ -942,11 +942,11 @@ document.write(`
scales (array) – The scales to use per
group_sizeelements ofw.biases (array, optional) – The biases to use per
group_sizeelements ofw. Default:None.group_size (int, optional) – The size of the group in
wthat shares a +group_size (int, optional) – The size of the group in
wthat shares a scale and bias. Default:64.bits (int, optional) – The number of bits occupied by each element in +
bits (int, optional) – The number of bits occupied by each element in
w. Default:4.mode (str, optional) – The quantization mode. Default:
"affine".mode (str, optional) – The quantization mode. Default:
"affine".
mlx.core.dequantize — MLX 0.29.2 documentation +mlx.core.dequantize — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -141,8 +141,8 @@ -
-
+
+
@@ -933,7 +933,7 @@ document.write(`
mlx.core.dequantize#
mlx.core.custom_function — MLX 0.29.2 documentation +mlx.core.custom_function — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.default_device.html b/docs/build/html/python/_autosummary/mlx.core.default_device.html
index 54afcafce..1812d41d6 100644
--- a/docs/build/html/python/_autosummary/mlx.core.default_device.html
+++ b/docs/build/html/python/_autosummary/mlx.core.default_device.html
@@ -8,7 +8,7 @@
- mlx.core.default_device — MLX 0.29.2 documentation +mlx.core.default_device — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.default_stream.html b/docs/build/html/python/_autosummary/mlx.core.default_stream.html
index 333cba83e..73e0c1e2e 100644
--- a/docs/build/html/python/_autosummary/mlx.core.default_stream.html
+++ b/docs/build/html/python/_autosummary/mlx.core.default_stream.html
@@ -8,7 +8,7 @@
- mlx.core.default_stream — MLX 0.29.2 documentation +mlx.core.default_stream — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.degrees.html b/docs/build/html/python/_autosummary/mlx.core.degrees.html
index 3909cc1c4..8fd0da3ff 100644
--- a/docs/build/html/python/_autosummary/mlx.core.degrees.html
+++ b/docs/build/html/python/_autosummary/mlx.core.degrees.html
@@ -8,7 +8,7 @@
- mlx.core.degrees — MLX 0.29.2 documentation +mlx.core.degrees — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.degrees#
mlx.core.cumsum — MLX 0.29.2 documentation +mlx.core.cumsum — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,17 +932,17 @@ document.write(`
mlx.core.cumsum#
mlx.core.cumprod — MLX 0.29.2 documentation +mlx.core.cumprod — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,17 +932,17 @@ document.write(`
mlx.core.cumprod#
mlx.core.cummin — MLX 0.29.2 documentation +mlx.core.cummin — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,17 +932,17 @@ document.write(`
mlx.core.cummin#
mlx.core.cuda.is_available — MLX 0.29.2 documentation +mlx.core.cuda.is_available — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.cuda.is_available#
diff --git a/docs/build/html/python/_autosummary/mlx.core.cummax.html b/docs/build/html/python/_autosummary/mlx.core.cummax.html index 66904c6ee..ca3c63884 100644 --- a/docs/build/html/python/_autosummary/mlx.core.cummax.html +++ b/docs/build/html/python/_autosummary/mlx.core.cummax.html @@ -8,7 +8,7 @@ -mlx.core.cummax — MLX 0.29.2 documentation +mlx.core.cummax — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,17 +932,17 @@ document.write(`
mlx.core.cummax#
mlx.core.cosh — MLX 0.29.2 documentation +mlx.core.cosh — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.cosh#
mlx.core.convolve — MLX 0.29.2 documentation +mlx.core.convolve — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.convolve#
mlx.core.cos — MLX 0.29.2 documentation +mlx.core.cos — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.cos#
mlx.core.conv_transpose3d — MLX 0.29.2 documentation +mlx.core.conv_transpose3d — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.conv_transpose3d#
mlx.core.conv_transpose2d — MLX 0.29.2 documentation +mlx.core.conv_transpose2d — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.conv_transpose2d#
mlx.core.conv_transpose1d — MLX 0.29.2 documentation +mlx.core.conv_transpose1d — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,18 +932,18 @@ document.write(`
mlx.core.conv_transpose1d#
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.diag.html b/docs/build/html/python/_autosummary/mlx.core.diag.html index a5b7539c1..2bf766d95 100644 --- a/docs/build/html/python/_autosummary/mlx.core.diag.html +++ b/docs/build/html/python/_autosummary/mlx.core.diag.html @@ -8,7 +8,7 @@ -
- -diag(a: array, /, k: int = 0, *, stream: None | Stream | Device = None) array# +diag(a: array, /, k: int = 0, *, stream: None | Stream | Device = None) array#
Extract a diagonal or construct a diagonal matrix. If
ais 1-D then a diagonal matrix is constructed withaon the \(k\)-th diagonal. Ifais 2-D then the \(k\)-th diagonal is @@ -942,7 +942,7 @@ returned.- Parameters:
- diff --git a/docs/build/html/python/_autosummary/mlx.core.diagonal.html b/docs/build/html/python/_autosummary/mlx.core.diagonal.html index b0fb55425..c1be958f8 100644 --- a/docs/build/html/python/_autosummary/mlx.core.diagonal.html +++ b/docs/build/html/python/_autosummary/mlx.core.diagonal.html @@ -8,7 +8,7 @@ -
- -diagonal(a: array, offset: int = 0, axis1: int = 0, axis2: int = 1, stream: None | Stream | Device = None) array# +diagonal(a: array, offset: int = 0, axis1: int = 0, axis2: int = 1, stream: None | Stream | Device = None) array#
Return specified diagonals.
If
@@ -944,11 +944,11 @@ new dimension inserted at the end corresponding to the diagonal.ais 2-D, then a 1-D array containing the diagonal at the givenoffsetis returned.- Parameters:
a (array) – Input array
-offset (int, optional) – Offset of the diagonal from the main diagonal. +
offset (int, optional) – Offset of the diagonal from the main diagonal. Can be positive or negative. Default:
0.
-axis1 (int, optional) – The first axis of the 2-D sub-arrays from which +
axis1 (int, optional) – The first axis of the 2-D sub-arrays from which the diagonals should be taken. Default:
0.
-axis2 (int, optional) – The second axis of the 2-D sub-arrays from which +
axis2 (int, optional) – The second axis of the 2-D sub-arrays from which the diagonals should be taken. Default:
1.
diff --git a/docs/build/html/python/_autosummary/mlx.core.disable_compile.html b/docs/build/html/python/_autosummary/mlx.core.disable_compile.html
index 859056597..a27149c64 100644
--- a/docs/build/html/python/_autosummary/mlx.core.disable_compile.html
+++ b/docs/build/html/python/_autosummary/mlx.core.disable_compile.html
@@ -8,7 +8,7 @@
- - -disable_compile() None# +disable_compile() None#
Globally disable compilation. Setting the environment variable
MLX_DISABLE_COMPILEcan also be used to disable compilation.- -all_gather(x: array, *, group: Group | None = None, stream: None | Stream | Device = None) array# +all_gather(x: array, *, group: Group | None = None, stream: None | Stream | Device = None) array#
Gather arrays from all processes.
Gather the
diff --git a/docs/build/html/python/_autosummary/mlx.core.distributed.all_sum.html b/docs/build/html/python/_autosummary/mlx.core.distributed.all_sum.html index b9b3be5b7..05a392de6 100644 --- a/docs/build/html/python/_autosummary/mlx.core.distributed.all_sum.html +++ b/docs/build/html/python/_autosummary/mlx.core.distributed.all_sum.html @@ -8,7 +8,7 @@ -xarrays from all processes in the group and concatenate them along the first axis. The arrays should all have the same shape.mlx.core.distributed.all_sum — MLX 0.29.2 documentation +mlx.core.distributed.all_sum — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.distributed.all_sum#
- -all_sum(x: array, *, group: Group | None = None, stream: None | Stream | Device = None) array# +all_sum(x: array, *, group: Group | None = None, stream: None | Stream | Device = None) array#
All reduce sum.
Sum the
xarrays from all processes in the group.-
diff --git a/docs/build/html/python/_autosummary/mlx.core.distributed.init.html b/docs/build/html/python/_autosummary/mlx.core.distributed.init.html
index 5df1b86c1..aed107475 100644
--- a/docs/build/html/python/_autosummary/mlx.core.distributed.init.html
+++ b/docs/build/html/python/_autosummary/mlx.core.distributed.init.html
@@ -8,7 +8,7 @@
-
- -init(strict: bool = False, backend: str = 'any') Group# +init(strict: bool = False, backend: str = 'any') Group#
Initialize the communication backend and create the global communication group.
Example
@@ -932,15 +932,15 @@ document.write(`@@ -932,7 +932,7 @@ document.write(`import mlx.core as mx @@ -943,10 +943,10 @@ document.write(`
- Parameters:
-
-
strict (bool, optional) – If set to False it returns a singleton group +
strict (bool, optional) – If set to False it returns a singleton group in case
mx.distributed.is_available()returns False otherwise it throws a runtime error. Default:False
-backend (str, optional) – Which distributed backend to initialize. +
backend (str, optional) – Which distributed backend to initialize. Possible values
mpi,ring,nccl,any. If set toanyall available backends are tried and the first one that succeeds becomes the global group which will be returned in subsequent diff --git a/docs/build/html/python/_autosummary/mlx.core.distributed.is_available.html b/docs/build/html/python/_autosummary/mlx.core.distributed.is_available.html index d00bbf3d8..80880effa 100644 --- a/docs/build/html/python/_autosummary/mlx.core.distributed.is_available.html +++ b/docs/build/html/python/_autosummary/mlx.core.distributed.is_available.html @@ -8,7 +8,7 @@ -mlx.core.distributed.is_available — MLX 0.29.2 documentation +mlx.core.distributed.is_available — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.distributed.is_available#
diff --git a/docs/build/html/python/_autosummary/mlx.core.distributed.recv.html b/docs/build/html/python/_autosummary/mlx.core.distributed.recv.html index e4e334e33..d95b850c7 100644 --- a/docs/build/html/python/_autosummary/mlx.core.distributed.recv.html +++ b/docs/build/html/python/_autosummary/mlx.core.distributed.recv.html @@ -8,7 +8,7 @@ -mlx.core.distributed.recv — MLX 0.29.2 documentation +mlx.core.distributed.recv — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.distributed.recv#
- -recv(shape: Sequence[int], dtype: Dtype, src: int, *, group: Group | None = None, stream: None | Stream | Device = None) array# +recv(shape: Sequence[int], dtype: Dtype, src: int, *, group: Group | None = None, stream: None | Stream | Device = None) array#
Recv an array with shape
shapeand dtypedtypefrom process with ranksrc.- Parameters:
-
-
shape (Tuple[int]) – The shape of the array we are receiving.
+shape (Tuple[int]) – The shape of the array we are receiving.
dtype (Dtype) – The data type of the array we are receiving.
-src (int) – Rank of the source process in the group.
+src (int) – Rank of the source process in the group.
group (Group) – The group of processes that will participate in the recv. If set to
Nonethe global group is used. Default:None.
diff --git a/docs/build/html/python/_autosummary/mlx.core.distributed.recv_like.html b/docs/build/html/python/_autosummary/mlx.core.distributed.recv_like.html
index 13645ee75..265a8241c 100644
--- a/docs/build/html/python/_autosummary/mlx.core.distributed.recv_like.html
+++ b/docs/build/html/python/_autosummary/mlx.core.distributed.recv_like.html
@@ -8,7 +8,7 @@
- - -recv_like(x: array, src: int, *, group: Group | None = None, stream: None | Stream | Device = None) array# +recv_like(x: array, src: int, *, group: Group | None = None, stream: None | Stream | Device = None) array#
Recv an array with shape and type like
xfrom process with ranksrc.It is equivalent to calling
@@ -941,7 +941,7 @@ document.write(`mx.distributed.recv(x.shape, x.dtype, src).x (array) – An array defining the shape and dtype of the array we are receiving.
-src (int) – Rank of the source process in the group.
+src (int) – Rank of the source process in the group.
group (Group) – The group of processes that will participate in the recv. If set to
Nonethe global group is used. Default:None.
diff --git a/docs/build/html/python/_autosummary/mlx.core.distributed.send.html b/docs/build/html/python/_autosummary/mlx.core.distributed.send.html
index 42f8e8866..d7f0403c9 100644
--- a/docs/build/html/python/_autosummary/mlx.core.distributed.send.html
+++ b/docs/build/html/python/_autosummary/mlx.core.distributed.send.html
@@ -8,7 +8,7 @@
- - -send(x: array, dst: int, *, group: Group | None = None, stream: None | Stream | Device = None) array# +send(x: array, dst: int, *, group: Group | None = None, stream: None | Stream | Device = None) array#
Send an array from the current process to the process that has rank
dstin the group.- Parameters:
x (array) – Input array.
-dst (int) – Rank of the destination process in the group.
+dst (int) – Rank of the destination process in the group.
group (Group) – The group of processes that will participate in the sned. If set to
Nonethe global group is used. Default:None.
diff --git a/docs/build/html/python/_autosummary/mlx.core.divide.html b/docs/build/html/python/_autosummary/mlx.core.divide.html
index 92fe4f728..2ead715b4 100644
--- a/docs/build/html/python/_autosummary/mlx.core.divide.html
+++ b/docs/build/html/python/_autosummary/mlx.core.divide.html
@@ -8,7 +8,7 @@
- - -divide(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +divide(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise division.
Divide two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.divmod.html b/docs/build/html/python/_autosummary/mlx.core.divmod.html index e818120e2..cd2f0cb55 100644 --- a/docs/build/html/python/_autosummary/mlx.core.divmod.html +++ b/docs/build/html/python/_autosummary/mlx.core.divmod.html @@ -8,7 +8,7 @@ -mlx.core.divmod — MLX 0.29.2 documentation +mlx.core.divmod — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.divmod#
- -divmod(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +divmod(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise quotient and remainder.
The fuction
divmod(a, b)is equivalent to but faster than(a // b, a % b). The function uses numpy-style broadcasting @@ -948,7 +948,7 @@ semantics. Either or both input arrays can also be scalars.The quotient
a // band remaindera % b.- Return type: -
-
+
- -einsum(subscripts: str, *operands, stream: None | Stream | Device = None) array# +einsum(subscripts: str, *operands, stream: None | Stream | Device = None) array#
Perform the Einstein summation convention on the operands.
- Parameters:
- diff --git a/docs/build/html/python/_autosummary/mlx.core.einsum_path.html b/docs/build/html/python/_autosummary/mlx.core.einsum_path.html index 031825fe4..e827916bc 100644 --- a/docs/build/html/python/_autosummary/mlx.core.einsum_path.html +++ b/docs/build/html/python/_autosummary/mlx.core.einsum_path.html @@ -8,7 +8,7 @@ -
mlx.core.einsum_path — MLX 0.29.2 documentation +mlx.core.einsum_path — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,12 +932,12 @@ document.write(`
mlx.core.einsum_path#
- -enable_compile() None# +enable_compile() None#
Globally enable compilation. This will override the environment variable
MLX_DISABLE_COMPILEif set.- -equal(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +equal(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise equality.
Equality comparison on two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.erf.html b/docs/build/html/python/_autosummary/mlx.core.erf.html index 2972dc4b6..eea40c905 100644 --- a/docs/build/html/python/_autosummary/mlx.core.erf.html +++ b/docs/build/html/python/_autosummary/mlx.core.erf.html @@ -8,7 +8,7 @@ -mlx.core.erf — MLX 0.29.2 documentation +mlx.core.erf — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -141,8 +141,8 @@ -
-
+
+
@@ -933,7 +933,7 @@ document.write(`
mlx.core.erf#
- -erf(a: array, /, *, stream: None | Stream | Device = None) array# +erf(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise error function.
\[\mathrm{erf}(x) = \frac{2}{\sqrt{\pi}} \int_0^x e^{-t^2} \, dt\]diff --git a/docs/build/html/python/_autosummary/mlx.core.erfinv.html b/docs/build/html/python/_autosummary/mlx.core.erfinv.html index a7509e0d7..e3c9bc0da 100644 --- a/docs/build/html/python/_autosummary/mlx.core.erfinv.html +++ b/docs/build/html/python/_autosummary/mlx.core.erfinv.html @@ -8,7 +8,7 @@ -mlx.core.erfinv — MLX 0.29.2 documentation +mlx.core.erfinv — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.erfinv#
- -erfinv(a: array, /, *, stream: None | Stream | Device = None) array# +erfinv(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise inverse of
erf().- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.eval.html b/docs/build/html/python/_autosummary/mlx.core.eval.html index 313b48fa7..7aa207241 100644 --- a/docs/build/html/python/_autosummary/mlx.core.eval.html +++ b/docs/build/html/python/_autosummary/mlx.core.eval.html @@ -8,7 +8,7 @@ -
- -eval(*args) None# +eval(*args) None#
Evaluate an
arrayor tree ofarray.- Parameters:
*args (arrays or trees of arrays) – Each argument can be a single array or a tree of arrays. If a tree is given the nodes can be a Python -
list,tupleordict. Leaves which are not +list,tupleordict. Leaves which are not arrays are ignored.
mlx.core.exp — MLX 0.29.2 documentation +mlx.core.exp — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.exp#
- -exp(a: array, /, *, stream: None | Stream | Device = None) array# +exp(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise exponential.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.expand_dims.html b/docs/build/html/python/_autosummary/mlx.core.expand_dims.html index a566c2807..eebae7964 100644 --- a/docs/build/html/python/_autosummary/mlx.core.expand_dims.html +++ b/docs/build/html/python/_autosummary/mlx.core.expand_dims.html @@ -8,7 +8,7 @@ -
- -expand_dims(a: array, /, axis: int | Sequence[int], *, stream: None | Stream | Device = None) array# +expand_dims(a: array, /, axis: int | Sequence[int], *, stream: None | Stream | Device = None) array#
Add a size one dimension at the given axis.
- Parameters:
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.expm1.html b/docs/build/html/python/_autosummary/mlx.core.expm1.html index a5949c292..b67d2c83e 100644 --- a/docs/build/html/python/_autosummary/mlx.core.expm1.html +++ b/docs/build/html/python/_autosummary/mlx.core.expm1.html @@ -8,7 +8,7 @@ -
- -expm1(a: array, /, *, stream: None | Stream | Device = None) array# +expm1(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise exponential minus 1.
Computes
exp(x) - 1with greater precision for smallx.-
diff --git a/docs/build/html/python/_autosummary/mlx.core.export_function.html b/docs/build/html/python/_autosummary/mlx.core.export_function.html
index cbd9dfaa4..5deb2c8af 100644
--- a/docs/build/html/python/_autosummary/mlx.core.export_function.html
+++ b/docs/build/html/python/_autosummary/mlx.core.export_function.html
@@ -8,7 +8,7 @@
-
- -export_function(file: str, fun: Callable, *args, shapeless: bool = False, **kwargs) None# -
Export a function to a file.
+export_function(arg0: object, fun: Callable, *args, shapeless: bool = False, **kwargs) None# +Export an MLX function.
Example input arrays must be provided to export a function. The example inputs can be variable
@@ -946,11 +946,12 @@ versions of MLX may not be compatible with future versions.*argsand**kwargsor a tuple of arrays and/or dictionary of string keys with array values.- Parameters:
-
-
file (str) – File path to export the function to.
+file (str or Callable) – Either a file path to export the function +to or a callback.
fun (Callable) – A function which takes as input zero or more
arrayand returns one or morearray.*args (array) – Example array inputs to the function.
-shapeless (bool, optional) – Whether or not the function allows +
shapeless (bool, optional) – Whether or not the function allows inputs with variable shapes. Default:
False.**kwargs (array) – Additional example keyword array inputs to the function.
diff --git a/docs/build/html/python/_autosummary/mlx.core.export_to_dot.html b/docs/build/html/python/_autosummary/mlx.core.export_to_dot.html
index 07af8976b..3e3fe10dc 100644
--- a/docs/build/html/python/_autosummary/mlx.core.export_to_dot.html
+++ b/docs/build/html/python/_autosummary/mlx.core.export_to_dot.html
@@ -8,7 +8,7 @@
- - -export_to_dot(file: object, *args, **kwargs) None# +export_to_dot(file: object, *args, **kwargs) None#
Export a graph to DOT format for visualization.
A variable number of output arrays can be provided for exporting The graph exported will recursively include all unevaluated inputs of @@ -940,9 +940,9 @@ the provided outputs.
- Parameters:
- diff --git a/docs/build/html/python/_autosummary/mlx.core.exporter.html b/docs/build/html/python/_autosummary/mlx.core.exporter.html index 37dd02a2e..ee83ff7e9 100644 --- a/docs/build/html/python/_autosummary/mlx.core.exporter.html +++ b/docs/build/html/python/_autosummary/mlx.core.exporter.html @@ -8,7 +8,7 @@ -
- -exporter(file: str, fun: Callable, *, shapeless: bool = False) mlx.core.FunctionExporter# +exporter(file: str, fun: Callable, *, shapeless: bool = False) mlx.core.FunctionExporter#
Make a callable object to export multiple traces of a function to a file.
@@ -932,14 +932,14 @@ document.write(`Warning
@@ -943,8 +943,8 @@ versions of MLX may not be compatible with future versions.- Parameters:
- diff --git a/docs/build/html/python/_autosummary/mlx.core.eye.html b/docs/build/html/python/_autosummary/mlx.core.eye.html index d7406da85..c608dee47 100644 --- a/docs/build/html/python/_autosummary/mlx.core.eye.html +++ b/docs/build/html/python/_autosummary/mlx.core.eye.html @@ -8,7 +8,7 @@ -
mlx.core.eye — MLX 0.29.2 documentation +mlx.core.eye — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.eye#
- -eye(n: int, m: int | None = None, k: int = 0, dtype: Dtype | None = float32, *, stream: None | Stream | Device = None) array# +eye(n: int, m: int | None = None, k: int = 0, dtype: Dtype | None = float32, *, stream: None | Stream | Device = None) array#
Create an identity matrix or a general diagonal matrix.
- Parameters:
-
-
n (int) – The number of rows in the output.
-m (int, optional) – The number of columns in the output. Defaults to n.
-k (int, optional) – Index of the diagonal. Defaults to 0 (main diagonal).
+n (int) – The number of rows in the output.
+m (int, optional) – The number of columns in the output. Defaults to n.
+k (int, optional) – Index of the diagonal. Defaults to 0 (main diagonal).
dtype (Dtype, optional) – Data type of the output array. Defaults to float32.
stream (Stream, optional) – Stream or device. Defaults to None.
mlx.core.fast.cuda_kernel — MLX 0.29.2 documentation +mlx.core.fast.cuda_kernel — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,25 +932,25 @@ document.write(`
mlx.core.fast.cuda_kernel#
- -cuda_kernel(name: str, input_names: Sequence[str], output_names: Sequence[str], source: str, header: str = '', ensure_row_contiguous: bool = True, shared_memory: int = 0) object# +cuda_kernel(name: str, input_names: Sequence[str], output_names: Sequence[str], source: str, header: str = '', ensure_row_contiguous: bool = True, shared_memory: int = 0) object#
A jit-compiled custom CUDA kernel defined from a source string.
This is the CUDA equivalent of Custom Metal Kernels.
- Parameters:
-
-
name (str) – Name for the kernel.
-input_names (List[str]) – The parameter names of the inputs in the +
name (str) – Name for the kernel.
+input_names (List[str]) – The parameter names of the inputs in the function signature.
-output_names (List[str]) – The parameter names of the outputs in the +
output_names (List[str]) – The parameter names of the outputs in the function signature.
-source (str) – Source code. This is the body of a function in CUDA, +
source (str) – Source code. This is the body of a function in CUDA, the function signature will be automatically generated.
-header (str) – Header source code to include before the main function. +
header (str) – Header source code to include before the main function. Useful for helper functions or includes that should live outside of the main function body.
-ensure_row_contiguous (bool) – Whether to ensure the inputs are row contiguous +
ensure_row_contiguous (bool) – Whether to ensure the inputs are row contiguous before the kernel runs. Default:
True.
-shared_memory (int) – The dynamic shared memory to request for the +
shared_memory (int) – The dynamic shared memory to request for the kernel. A value of 0 means no dynamic shared memory. Default:
0.
diff --git a/docs/build/html/python/_autosummary/mlx.core.fast.layer_norm.html b/docs/build/html/python/_autosummary/mlx.core.fast.layer_norm.html
index 5a062fc4f..6a1c30a7c 100644
--- a/docs/build/html/python/_autosummary/mlx.core.fast.layer_norm.html
+++ b/docs/build/html/python/_autosummary/mlx.core.fast.layer_norm.html
@@ -8,7 +8,7 @@
- - -layer_norm(x: array, weight: array | None, bias: array | None, eps: float, *, stream: None | Stream | Device = None) array# +layer_norm(x: array, weight: array | None, bias: array | None, eps: float, *, stream: None | Stream | Device = None) array#
Layer normalization.
The normalization is with respect to the last axis of the input
x.-
@@ -945,7 +945,7 @@ as the last axis of
bias (array, optional) – An additive offset to be added to the result. The
biasshould be one-dimensional with the same size as the last axis ofx. If set toNonethen no translation happens.
mlx.core.fast.layer_norm — MLX 0.29.2 documentation +mlx.core.fast.layer_norm — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.fast.layer_norm#
mlx.core.exporter — MLX 0.29.2 documentation +mlx.core.exporter — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.exporter#
mlx.core.export_to_dot — MLX 0.29.2 documentation +mlx.core.export_to_dot — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.export_to_dot#
mlx.core.export_function — MLX 0.29.2 documentation +mlx.core.export_function — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,8 +932,8 @@ document.write(`
mlx.core.export_function#
mlx.core.expm1 — MLX 0.29.2 documentation +mlx.core.expm1 — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.expm1#
mlx.core.expand_dims — MLX 0.29.2 documentation +mlx.core.expand_dims — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.expand_dims#
mlx.core.eval — MLX 0.29.2 documentation +mlx.core.eval — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.eval#
mlx.core.divide — MLX 0.29.2 documentation +mlx.core.divide — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.divide#
mlx.core.einsum — MLX 0.29.2 documentation +mlx.core.einsum — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,12 +932,12 @@ document.write(`
mlx.core.einsum#
mlx.core.enable_compile — MLX 0.29.2 documentation +mlx.core.enable_compile — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.enable_compile#
mlx.core.equal — MLX 0.29.2 documentation +mlx.core.equal — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.equal#
mlx.core.distributed.send — MLX 0.29.2 documentation +mlx.core.distributed.send — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,14 +932,14 @@ document.write(`
mlx.core.distributed.send#
mlx.core.distributed.recv_like — MLX 0.29.2 documentation +mlx.core.distributed.recv_like — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.distributed.recv_like#
mlx.core.distributed.init — MLX 0.29.2 documentation +mlx.core.distributed.init — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.distributed.init#
mlx.core.diag — MLX 0.29.2 documentation +mlx.core.diag — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -141,8 +141,8 @@ -
-
+
+
@@ -933,7 +933,7 @@ document.write(`
mlx.core.diag#
mlx.core.diagonal — MLX 0.29.2 documentation +mlx.core.diagonal — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.diagonal#
mlx.core.disable_compile — MLX 0.29.2 documentation +mlx.core.disable_compile — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.disable_compile#
mlx.core.distributed.Group — MLX 0.29.2 documentation +mlx.core.distributed.Group — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.distributed.all_gather.html b/docs/build/html/python/_autosummary/mlx.core.distributed.all_gather.html
index 23947803a..dfd6a39c8 100644
--- a/docs/build/html/python/_autosummary/mlx.core.distributed.all_gather.html
+++ b/docs/build/html/python/_autosummary/mlx.core.distributed.all_gather.html
@@ -8,7 +8,7 @@
- mlx.core.distributed.all_gather — MLX 0.29.2 documentation +mlx.core.distributed.all_gather — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.distributed.all_gather#
mlx.core.conv_general — MLX 0.29.2 documentation +mlx.core.conv_general — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,26 +932,26 @@ document.write(`
mlx.core.conv_general#
mlx.core.conv3d — MLX 0.29.2 documentation +mlx.core.conv3d — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.conv3d#
mlx.core.conv2d — MLX 0.29.2 documentation +mlx.core.conv2d — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,23 +932,23 @@ document.write(`
mlx.core.conv2d#
mlx.core.conv1d — MLX 0.29.2 documentation +mlx.core.conv1d — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,17 +932,17 @@ document.write(`
mlx.core.conv1d#
mlx.core.contiguous — MLX 0.29.2 documentation +mlx.core.contiguous — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.contiguous#
mlx.core.conjugate — MLX 0.29.2 documentation +mlx.core.conjugate — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.conjugate#
mlx.core.conj — MLX 0.29.2 documentation +mlx.core.conj — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.conj#
eps (float) – A small additive constant for numerical stability.
eps (float) – A small additive constant for numerical stability.
mlx.core.clear_cache — MLX 0.29.2 documentation +mlx.core.clear_cache — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.clear_cache#
mlx.core.clip — MLX 0.29.2 documentation +mlx.core.clip — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.clip#
mlx.core.ceil — MLX 0.29.2 documentation +mlx.core.ceil — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.ceil#
mlx.core.broadcast_arrays — MLX 0.29.2 documentation +mlx.core.broadcast_arrays — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.broadcast_arrays#
mlx.core.broadcast_to — MLX 0.29.2 documentation +mlx.core.broadcast_to — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,14 +932,14 @@ document.write(`
mlx.core.broadcast_to#
- Returns:
diff --git a/docs/build/html/python/_autosummary/mlx.core.fast.metal_kernel.html b/docs/build/html/python/_autosummary/mlx.core.fast.metal_kernel.html index 347bbbe46..9702b1d96 100644 --- a/docs/build/html/python/_autosummary/mlx.core.fast.metal_kernel.html +++ b/docs/build/html/python/_autosummary/mlx.core.fast.metal_kernel.html @@ -8,7 +8,7 @@ -mlx.core.fast.metal_kernel — MLX 0.29.2 documentation +mlx.core.fast.metal_kernel — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,25 +932,25 @@ document.write(`
mlx.core.fast.metal_kernel#
- -metal_kernel(name: str, input_names: Sequence[str], output_names: Sequence[str], source: str, header: str = '', ensure_row_contiguous: bool = True, atomic_outputs: bool = False) object# +metal_kernel(name: str, input_names: Sequence[str], output_names: Sequence[str], source: str, header: str = '', ensure_row_contiguous: bool = True, atomic_outputs: bool = False) object#
A jit-compiled custom Metal kernel defined from a source string.
Full documentation: Custom Metal Kernels.
- Parameters:
-
-
name (str) – Name for the kernel.
-input_names (List[str]) – The parameter names of the inputs in the +
name (str) – Name for the kernel.
+input_names (List[str]) – The parameter names of the inputs in the function signature.
-output_names (List[str]) – The parameter names of the outputs in the +
output_names (List[str]) – The parameter names of the outputs in the function signature.
-source (str) – Source code. This is the body of a function in Metal, +
source (str) – Source code. This is the body of a function in Metal, the function signature will be automatically generated.
-header (str) – Header source code to include before the main function. +
header (str) – Header source code to include before the main function. Useful for helper functions or includes that should live outside of the main function body.
-ensure_row_contiguous (bool) – Whether to ensure the inputs are row contiguous +
ensure_row_contiguous (bool) – Whether to ensure the inputs are row contiguous before the kernel runs. Default:
True.
-atomic_outputs (bool) – Whether to use atomic outputs in the function signature +
atomic_outputs (bool) – Whether to use atomic outputs in the function signature e.g.
device atomic<float>. Default:False.
diff --git a/docs/build/html/python/_autosummary/mlx.core.fast.rms_norm.html b/docs/build/html/python/_autosummary/mlx.core.fast.rms_norm.html
index d444af59a..f5d6d4670 100644
--- a/docs/build/html/python/_autosummary/mlx.core.fast.rms_norm.html
+++ b/docs/build/html/python/_autosummary/mlx.core.fast.rms_norm.html
@@ -8,7 +8,7 @@
- - -rms_norm(x: array, weight: array | None, eps: float, *, stream: None | Stream | Device = None) array# +rms_norm(x: array, weight: array | None, eps: float, *, stream: None | Stream | Device = None) array#
Root Mean Square normalization (RMS norm).
The normalization is with respect to the last axis of the input
x.-
@@ -942,7 +942,7 @@ document.write(`
weight (array, optional) – A multiplicative weight to scale the result by. The
weightshould be one-dimensional with the same size as the last axis ofx. If set toNonethen no scaling happens.eps (float) – A small additive constant for numerical stability.
eps (float) – A small additive constant for numerical stability.
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.fast.rope.html b/docs/build/html/python/_autosummary/mlx.core.fast.rope.html index 7e77c3271..a58b4bad3 100644 --- a/docs/build/html/python/_autosummary/mlx.core.fast.rope.html +++ b/docs/build/html/python/_autosummary/mlx.core.fast.rope.html @@ -8,7 +8,7 @@ -
- -rope(a: array, dims: int, *, traditional: bool, base: float | None, scale: float, offset: int | array, freqs: array | None = None, stream: None | Stream | Device = None) array# +rope(a: array, dims: int, *, traditional: bool, base: float | None, scale: float, offset: int | array, freqs: array | None = None, stream: None | Stream | Device = None) array#
Apply rotary positional encoding to the input.
- The input is expected to be at least 3D with shape
(B, *, T, D)where: -
@@ -946,16 +946,16 @@ document.write(`
- Parameters:
a (array) – The input array.
-dims (int) – The feature dimensions to be rotated. If the input feature +
dims (int) – The feature dimensions to be rotated. If the input feature is larger than dims then the rest is left unchanged.
-traditional (bool) – If set to
Truechoose the traditional +traditional (bool) – If set to
Truechoose the traditional implementation which rotates consecutive dimensions.
-base (float, optional) – The base used to compute angular frequency for +
base (float, optional) – The base used to compute angular frequency for each dimension in the positional encodings. Exactly one of
baseandfreqsmust beNone.
-scale (float) – The scale used to scale the positions.
-offset (int or array) – The position offset to start at. If an -
arrayis given it can be a scalar or vector ofB+scale (float) – The scale used to scale the positions.
+offset (int or array) – The position offset to start at. If an +
arrayis given it can be a scalar or vector ofBoffsets for each example in the batch.freqs (array, optional) – Optional frequencies to use with RoPE. If set, the
baseparameter must beNone. Default:None.
diff --git a/docs/build/html/python/_autosummary/mlx.core.fast.scaled_dot_product_attention.html b/docs/build/html/python/_autosummary/mlx.core.fast.scaled_dot_product_attention.html
index 7f11414bc..403a85acd 100644
--- a/docs/build/html/python/_autosummary/mlx.core.fast.scaled_dot_product_attention.html
+++ b/docs/build/html/python/_autosummary/mlx.core.fast.scaled_dot_product_attention.html
@@ -8,7 +8,7 @@
- - -scaled_dot_product_attention(q: array, k: array, v: array, *, scale: float, mask: None | str | array = None, sinks: array | None = None, stream: None | Stream | Device = None) array# +scaled_dot_product_attention(q: array, k: array, v: array, *, scale: float, mask: None | str | array = None, sinks: array | None = None, stream: None | Stream | Device = None) array#
A fast implementation of multi-head attention:
O = softmax(Q @ K.T, dim=-1) @ V.Supports:
-
@@ -964,8 +964,8 @@ and
q (array) – Queries with shape
[B, N_q, T_q, D].k (array) – Keys with shape
[B, N_kv, T_kv, D].v (array) – Values with shape
[B, N_kv, T_kv, D].
-scale (float) – Scale for queries (typically
1.0 / sqrt(q.shape(-1)).
-scale (float) – Scale for queries (typically
1.0 / sqrt(q.shape(-1)).
+mask (str or array, optional) – The mask to apply to the query-key scores. The mask can be an array or a string indicating the mask type. The only supported string type is
"causal". If the mask is an array it can be a boolean or additive mask. The mask diff --git a/docs/build/html/python/_autosummary/mlx.core.fft.fft.html b/docs/build/html/python/_autosummary/mlx.core.fft.fft.html index f83e73217..7d311aa4f 100644 --- a/docs/build/html/python/_autosummary/mlx.core.fft.fft.html +++ b/docs/build/html/python/_autosummary/mlx.core.fft.fft.html @@ -8,7 +8,7 @@ -mlx.core.fft.fft — MLX 0.29.2 documentation +mlx.core.fft.fft — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,16 +932,16 @@ document.write(`
mlx.core.fft.fft#
- -fft(a: array, n: Optional[int] = None, axis: int = -1, stream: Optional[Union[Stream, Device]] = None) array# +fft(a: array, n: Optional[int] = None, axis: int = -1, stream: Optional[Union[Stream, Device]] = None) array#
One dimensional discrete Fourier Transform.
- Parameters:
a (array) – The input array.
-n (int, optional) – Size of the transformed axis. The +
n (int, optional) – Size of the transformed axis. The corresponding axis in the input is truncated or padded with zeros to match
n. The default value isa.shape[axis].
-axis (int, optional) – Axis along which to perform the FFT. The +
axis (int, optional) – Axis along which to perform the FFT. The default is
-1.
diff --git a/docs/build/html/python/_autosummary/mlx.core.fft.fft2.html b/docs/build/html/python/_autosummary/mlx.core.fft.fft2.html
index 051bf8080..c79b44f85 100644
--- a/docs/build/html/python/_autosummary/mlx.core.fft.fft2.html
+++ b/docs/build/html/python/_autosummary/mlx.core.fft.fft2.html
@@ -8,7 +8,7 @@
- - -fft2(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = [-2, -1], stream: Optional[Union[Stream, Device]] = None) array# +fft2(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = [-2, -1], stream: Optional[Union[Stream, Device]] = None) array#
Two dimensional discrete Fourier Transform.
- Parameters:
a (array) – The input array.
-s (list(int), optional) – Sizes of the transformed axes. The +
s (list(int), optional) – Sizes of the transformed axes. The corresponding axes in the input are truncated or padded with zeros to match the sizes in
s. The default value is the sizes ofaalongaxes.
-axes (list(int), optional) – Axes along which to perform the FFT. +
axes (list(int), optional) – Axes along which to perform the FFT. The default is
[-2, -1].
diff --git a/docs/build/html/python/_autosummary/mlx.core.fft.fftn.html b/docs/build/html/python/_autosummary/mlx.core.fft.fftn.html
index 1b5ea8bbc..0713a2266 100644
--- a/docs/build/html/python/_autosummary/mlx.core.fft.fftn.html
+++ b/docs/build/html/python/_autosummary/mlx.core.fft.fftn.html
@@ -8,7 +8,7 @@
- - -fftn(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = None, stream: Optional[Union[Stream, Device]] = None) array# +fftn(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = None, stream: Optional[Union[Stream, Device]] = None) array#
n-dimensional discrete Fourier Transform.
- Parameters:
a (array) – The input array.
-s (list(int), optional) – Sizes of the transformed axes. The +
s (list(int), optional) – Sizes of the transformed axes. The corresponding axes in the input are truncated or padded with zeros to match the sizes in
s. The default value is the sizes ofaalongaxes.
-axes (list(int), optional) – Axes along which to perform the FFT. +
axes (list(int), optional) – Axes along which to perform the FFT. The default is
Nonein which case the FFT is over the lastlen(s)axes are or all axes ifsis alsoNone.
mlx.core.fft.fftshift — MLX 0.29.2 documentation +mlx.core.fft.fftshift — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.fft.fftshift#
- -fftshift(a: array, axes: Optional[Sequence[int]] = None, stream: Optional[Union[Stream, Device]] = None) array# +fftshift(a: array, axes: Optional[Sequence[int]] = None, stream: Optional[Union[Stream, Device]] = None) array#
Shift the zero-frequency component to the center of the spectrum.
- Parameters:
- diff --git a/docs/build/html/python/_autosummary/mlx.core.fft.ifft.html b/docs/build/html/python/_autosummary/mlx.core.fft.ifft.html index e98cf85df..fb88010a5 100644 --- a/docs/build/html/python/_autosummary/mlx.core.fft.ifft.html +++ b/docs/build/html/python/_autosummary/mlx.core.fft.ifft.html @@ -8,7 +8,7 @@ -
- -ifft(a: array, n: Optional[int] = None, axis: int = -1, stream: Optional[Union[Stream, Device]] = None) array# +ifft(a: array, n: Optional[int] = None, axis: int = -1, stream: Optional[Union[Stream, Device]] = None) array#
One dimensional inverse discrete Fourier Transform.
- Parameters:
a (array) – The input array.
-n (int, optional) – Size of the transformed axis. The +
n (int, optional) – Size of the transformed axis. The corresponding axis in the input is truncated or padded with zeros to match
n. The default value isa.shape[axis].
-axis (int, optional) – Axis along which to perform the FFT. The +
axis (int, optional) – Axis along which to perform the FFT. The default is
-1.
diff --git a/docs/build/html/python/_autosummary/mlx.core.fft.ifft2.html b/docs/build/html/python/_autosummary/mlx.core.fft.ifft2.html
index 38defe529..5743b366a 100644
--- a/docs/build/html/python/_autosummary/mlx.core.fft.ifft2.html
+++ b/docs/build/html/python/_autosummary/mlx.core.fft.ifft2.html
@@ -8,7 +8,7 @@
- - -ifft2(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = [-2, -1], stream: Optional[Union[Stream, Device]] = None) array# +ifft2(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = [-2, -1], stream: Optional[Union[Stream, Device]] = None) array#
Two dimensional inverse discrete Fourier Transform.
- Parameters:
a (array) – The input array.
-s (list(int), optional) – Sizes of the transformed axes. The +
s (list(int), optional) – Sizes of the transformed axes. The corresponding axes in the input are truncated or padded with zeros to match the sizes in
s. The default value is the sizes ofaalongaxes.
-axes (list(int), optional) – Axes along which to perform the FFT. +
axes (list(int), optional) – Axes along which to perform the FFT. The default is
[-2, -1].
diff --git a/docs/build/html/python/_autosummary/mlx.core.fft.ifftn.html b/docs/build/html/python/_autosummary/mlx.core.fft.ifftn.html
index 74b3eff8c..38ce3c6fe 100644
--- a/docs/build/html/python/_autosummary/mlx.core.fft.ifftn.html
+++ b/docs/build/html/python/_autosummary/mlx.core.fft.ifftn.html
@@ -8,7 +8,7 @@
- - -ifftn(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = None, stream: Optional[Union[Stream, Device]] = None) array# +ifftn(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = None, stream: Optional[Union[Stream, Device]] = None) array#
n-dimensional inverse discrete Fourier Transform.
- Parameters:
a (array) – The input array.
-s (list(int), optional) – Sizes of the transformed axes. The +
s (list(int), optional) – Sizes of the transformed axes. The corresponding axes in the input are truncated or padded with zeros to match the sizes in
s. The default value is the sizes ofaalongaxes.
-axes (list(int), optional) – Axes along which to perform the FFT. +
axes (list(int), optional) – Axes along which to perform the FFT. The default is
Nonein which case the FFT is over the lastlen(s)axes or all axes ifsis alsoNone.
mlx.core.fft.ifftshift — MLX 0.29.2 documentation +mlx.core.fft.ifftshift — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,14 +932,14 @@ document.write(`
mlx.core.fft.ifftshift#
- -ifftshift(a: array, axes: Optional[Sequence[int]] = None, stream: Optional[Union[Stream, Device]] = None) array# +ifftshift(a: array, axes: Optional[Sequence[int]] = None, stream: Optional[Union[Stream, Device]] = None) array#
The inverse of
fftshift(). While identical tofftshift()for even-length axes, the behavior differs for odd-length axes.- Parameters:
- diff --git a/docs/build/html/python/_autosummary/mlx.core.fft.irfft.html b/docs/build/html/python/_autosummary/mlx.core.fft.irfft.html index 8a29a8202..e98f09936 100644 --- a/docs/build/html/python/_autosummary/mlx.core.fft.irfft.html +++ b/docs/build/html/python/_autosummary/mlx.core.fft.irfft.html @@ -8,7 +8,7 @@ -
- -irfft(a: array, n: Optional[int] = None, axis: int = -1, stream: Optional[Union[Stream, Device]] = None) array# +irfft(a: array, n: Optional[int] = None, axis: int = -1, stream: Optional[Union[Stream, Device]] = None) array#
The inverse of
rfft().The output has the same shape as the input except along
@@ -940,11 +940,11 @@ which case it has sizeaxisin which case it has sizen.Parameters:a (array) – The input array.
-n (int, optional) – Size of the transformed axis. The +
n (int, optional) – Size of the transformed axis. The corresponding axis in the input is truncated or padded with zeros to match
n // 2 + 1. The default value isa.shape[axis] // 2 + 1.
-axis (int, optional) – Axis along which to perform the FFT. The +
axis (int, optional) – Axis along which to perform the FFT. The default is
-1.
mlx.core.fft.irfft2 — MLX 0.29.2 documentation +mlx.core.fft.irfft2 — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.fft.irfft2#
- -irfft2(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = [-2, -1], stream: Optional[Union[Stream, Device]] = None) array# +irfft2(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = [-2, -1], stream: Optional[Union[Stream, Device]] = None) array#
The inverse of
rfft2().Note the input is generally complex. The dimensions of the input specified in
axesare padded or truncated to match the sizes @@ -942,12 +942,12 @@ and will have size- Parameters:
a (array) – The input array.
-s (list(int), optional) – Sizes of the transformed axes. The +
s (list(int), optional) – Sizes of the transformed axes. The corresponding axes in the input are truncated or padded with zeros to match the sizes in
sexcept for the last axis which has sizes[-1] // 2 + 1. The default value is the sizes ofaalongaxes.
-axes (list(int), optional) – Axes along which to perform the FFT. +
axes (list(int), optional) – Axes along which to perform the FFT. The default is
[-2, -1].
mlx.core.fft.irfftn — MLX 0.29.2 documentation +mlx.core.fft.irfftn — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.fft.irfftn#
- -irfftn(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = None, stream: Optional[Union[Stream, Device]] = None) array# +irfftn(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = None, stream: Optional[Union[Stream, Device]] = None) array#
The inverse of
rfftn().Note the input is generally complex. The dimensions of the input specified in
axesare padded or truncated to match the sizes @@ -942,11 +942,11 @@ and will have size- Parameters:
a (array) – The input array.
-s (list(int), optional) – Sizes of the transformed axes. The +
s (list(int), optional) – Sizes of the transformed axes. The corresponding axes in the input are truncated or padded with zeros to match the sizes in
s. The default value is the sizes ofaalongaxes.
-axes (list(int), optional) – Axes along which to perform the FFT. +
axes (list(int), optional) – Axes along which to perform the FFT. The default is
Nonein which case the FFT is over the lastlen(s)axes or all axes ifsis alsoNone.
mlx.core.fft.rfft — MLX 0.29.2 documentation +mlx.core.fft.rfft — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.fft.rfft#
- -rfft(a: array, n: Optional[int] = None, axis: int = -1, stream: Optional[Union[Stream, Device]] = None) array# +rfft(a: array, n: Optional[int] = None, axis: int = -1, stream: Optional[Union[Stream, Device]] = None) array#
One dimensional discrete Fourier Transform on a real input.
The output has the same shape as the input except along
@@ -941,10 +941,10 @@ which case it has sizeaxisin which case it has sizen // 2 + 1.a (array) – The input array. If the array is complex it will be silently cast to a real type.
-n (int, optional) – Size of the transformed axis. The +
n (int, optional) – Size of the transformed axis. The corresponding axis in the input is truncated or padded with zeros to match
n. The default value isa.shape[axis].
-axis (int, optional) – Axis along which to perform the FFT. The +
axis (int, optional) – Axis along which to perform the FFT. The default is
-1.
diff --git a/docs/build/html/python/_autosummary/mlx.core.fft.rfft2.html b/docs/build/html/python/_autosummary/mlx.core.fft.rfft2.html
index 7fa730b0b..2cb5ee3e9 100644
--- a/docs/build/html/python/_autosummary/mlx.core.fft.rfft2.html
+++ b/docs/build/html/python/_autosummary/mlx.core.fft.rfft2.html
@@ -8,7 +8,7 @@
- - -rfft2(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = [-2, -1], stream: Optional[Union[Stream, Device]] = None) array# +rfft2(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = [-2, -1], stream: Optional[Union[Stream, Device]] = None) array#
Two dimensional real discrete Fourier Transform.
The output has the same shape as the input except along the dimensions in
axesin which case it has sizes froms. The last axis inaxesis @@ -942,11 +942,11 @@ treated as the real axis and will have sizea (array) – The input array. If the array is complex it will be silently cast to a real type.
-s (list(int), optional) – Sizes of the transformed axes. The +
s (list(int), optional) – Sizes of the transformed axes. The corresponding axes in the input are truncated or padded with zeros to match the sizes in
s. The default value is the sizes ofaalongaxes.
-axes (list(int), optional) – Axes along which to perform the FFT. +
axes (list(int), optional) – Axes along which to perform the FFT. The default is
[-2, -1].
diff --git a/docs/build/html/python/_autosummary/mlx.core.fft.rfftn.html b/docs/build/html/python/_autosummary/mlx.core.fft.rfftn.html
index 9ec513a7d..90017a926 100644
--- a/docs/build/html/python/_autosummary/mlx.core.fft.rfftn.html
+++ b/docs/build/html/python/_autosummary/mlx.core.fft.rfftn.html
@@ -8,7 +8,7 @@
- - -rfftn(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = None, stream: Optional[Union[Stream, Device]] = None) array# +rfftn(a: array, s: Optional[tuple[int, ...]] = None, axes: Optional[Sequence[int]] = None, stream: Optional[Union[Stream, Device]] = None) array#
n-dimensional real discrete Fourier Transform.
The output has the same shape as the input except along the dimensions in
axesin which case it has sizes froms. The last axis inaxesis @@ -942,11 +942,11 @@ treated as the real axis and will have sizea (array) – The input array. If the array is complex it will be silently cast to a real type.
-s (list(int), optional) – Sizes of the transformed axes. The +
s (list(int), optional) – Sizes of the transformed axes. The corresponding axes in the input are truncated or padded with zeros to match the sizes in
s. The default value is the sizes ofaalongaxes.
-axes (list(int), optional) – Axes along which to perform the FFT. +
axes (list(int), optional) – Axes along which to perform the FFT. The default is
Nonein which case the FFT is over the lastlen(s)axes or all axes ifsis alsoNone.
mlx.core.finfo — MLX 0.29.2 documentation +mlx.core.finfo — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -939,7 +939,7 @@ document.write(`
Get information on floating-point types.
Methods
diff --git a/docs/build/html/python/_autosummary/mlx.core.flatten.html b/docs/build/html/python/_autosummary/mlx.core.flatten.html index d496710b9..c08150c89 100644 --- a/docs/build/html/python/_autosummary/mlx.core.flatten.html +++ b/docs/build/html/python/_autosummary/mlx.core.flatten.html @@ -8,7 +8,7 @@ -mlx.core.flatten — MLX 0.29.2 documentation +mlx.core.flatten — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.flatten#
- -flatten(a: array, /, start_axis: int = 0, end_axis: int = -1, *, stream: None | Stream | Device = None) array# +flatten(a: array, /, start_axis: int = 0, end_axis: int = -1, *, stream: None | Stream | Device = None) array#
Flatten an array.
The axes flattened will be between
start_axisandend_axis, inclusive. Negative axes are supported. After converting negative axis to @@ -942,8 +942,8 @@ positive, axes outside the valid range will be clamped to a valid value,- Parameters:
a (array) – Input array.
-start_axis (int, optional) – The first dimension to flatten. Defaults to
0.
-end_axis (int, optional) – The last dimension to flatten. Defaults to
-1.
+start_axis (int, optional) – The first dimension to flatten. Defaults to
0.
+end_axis (int, optional) – The last dimension to flatten. Defaults to
-1.stream (Stream, optional) – Stream or device. Defaults to
Nonein which case the default stream of the default device is used.
mlx.core.floor — MLX 0.29.2 documentation +mlx.core.floor — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.floor#
- -floor(a: array, /, *, stream: None | Stream | Device = None) array# +floor(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise floor.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.floor_divide.html b/docs/build/html/python/_autosummary/mlx.core.floor_divide.html index 0722c74f9..fb3a3fded 100644 --- a/docs/build/html/python/_autosummary/mlx.core.floor_divide.html +++ b/docs/build/html/python/_autosummary/mlx.core.floor_divide.html @@ -8,7 +8,7 @@ -
- -floor_divide(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +floor_divide(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise integer division.
If either array is a floating point type then it is equivalent to calling
diff --git a/docs/build/html/python/_autosummary/mlx.core.full.html b/docs/build/html/python/_autosummary/mlx.core.full.html index 2db1f5e51..08d2b286f 100644 --- a/docs/build/html/python/_autosummary/mlx.core.full.html +++ b/docs/build/html/python/_autosummary/mlx.core.full.html @@ -8,7 +8,7 @@ -floor()afterdivide().mlx.core.full — MLX 0.29.2 documentation +mlx.core.full — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,15 +932,15 @@ document.write(`
mlx.core.full#
- -full(shape: int | Sequence[int], vals: scalar | array, dtype: Dtype | None = None, *, stream: None | Stream | Device = None) array# +full(shape: int | Sequence[int], vals: scalar | array, dtype: Dtype | None = None, *, stream: None | Stream | Device = None) array#
Construct an array with the given value.
Constructs an array of size
shapefilled withvals. Ifvalsis anarrayit must be broadcastable to the givenshape.- Parameters:
-
-
- -
vals (float or int or array) – Values to fill the array with.
+- +
vals (float or int or array) – Values to fill the array with.
dtype (Dtype, optional) – Data type of the output array. If unspecified the output type is inferred from
vals.
mlx.core.gather_mm — MLX 0.29.2 documentation +mlx.core.gather_mm — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.gather_mm#
- -gather_mm(a: array, b: array, /, lhs_indices: array, rhs_indices: array, *, sorted_indices: bool = False, stream: None | Stream | Device = None) array# +gather_mm(a: array, b: array, /, lhs_indices: array, rhs_indices: array, *, sorted_indices: bool = False, stream: None | Stream | Device = None) array#
Matrix multiplication with matrix-level gather.
Performs a gather of the operands with the given indices followed by a (possibly batched) matrix multiplication of two arrays. This operation @@ -954,7 +954,7 @@ flag can be passed for a possible faster implementation.
b (array) – Input array.
lhs_indices (array, optional) – Integer indices for
a. Default:Nonerhs_indices (array, optional) – Integer indices for
b. Default:Nonesorted_indices (bool, optional) – May allow a faster implementation +
sorted_indices (bool, optional) – May allow a faster implementation if the passed indices are sorted. Default:
False.
mlx.core.floor_divide — MLX 0.29.2 documentation +mlx.core.floor_divide — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.floor_divide#
mlx.core.fft.rfft2 — MLX 0.29.2 documentation +mlx.core.fft.rfft2 — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.fft.rfft2#
mlx.core.fft.rfftn — MLX 0.29.2 documentation +mlx.core.fft.rfftn — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.fft.rfftn#
mlx.core.fft.irfft — MLX 0.29.2 documentation +mlx.core.fft.irfft — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.fft.irfft#
mlx.core.fft.ifftn — MLX 0.29.2 documentation +mlx.core.fft.ifftn — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,17 +932,17 @@ document.write(`
mlx.core.fft.ifftn#
mlx.core.fft.ifft2 — MLX 0.29.2 documentation +mlx.core.fft.ifft2 — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,17 +932,17 @@ document.write(`
mlx.core.fft.ifft2#
mlx.core.fft.ifft — MLX 0.29.2 documentation +mlx.core.fft.ifft — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,16 +932,16 @@ document.write(`
mlx.core.fft.ifft#
mlx.core.fft.fftn — MLX 0.29.2 documentation +mlx.core.fft.fftn — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,17 +932,17 @@ document.write(`
mlx.core.fft.fftn#
mlx.core.fft.fft2 — MLX 0.29.2 documentation +mlx.core.fft.fft2 — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,17 +932,17 @@ document.write(`
mlx.core.fft.fft2#
v
diff --git a/docs/build/html/python/_autosummary/mlx.core.gather_qmm.html b/docs/build/html/python/_autosummary/mlx.core.gather_qmm.html
index 988a99bec..d874da9c9 100644
--- a/docs/build/html/python/_autosummary/mlx.core.gather_qmm.html
+++ b/docs/build/html/python/_autosummary/mlx.core.gather_qmm.html
@@ -8,7 +8,7 @@
- - -gather_qmm(x: array, w: array, /, scales: array, biases: array | None = None, lhs_indices: array | None = None, rhs_indices: array | None = None, transpose: bool = True, group_size: int = 64, bits: int = 4, mode: str = 'affine', *, sorted_indices: bool = False, stream: None | Stream | Device = None) array# +gather_qmm(x: array, w: array, /, scales: array, biases: array | None = None, lhs_indices: array | None = None, rhs_indices: array | None = None, transpose: bool = True, group_size: int = 64, bits: int = 4, mode: str = 'affine', *, sorted_indices: bool = False, stream: None | Stream | Device = None) array#
Perform quantized matrix multiplication with matrix-level gather.
This operation is the quantized equivalent to
gather_mm(). Similar togather_mm(), the indiceslhs_indicesand @@ -950,15 +950,15 @@ aswelements ofw. Default:None.lhs_indices (array, optional) – Integer indices for
x. Default:None.rhs_indices (array, optional) – Integer indices for
w. Default:None.transpose (bool, optional) – Defines whether to multiply with the +
transpose (bool, optional) – Defines whether to multiply with the transposed
wor not, namely whether we are performingx @ w.Torx @ w. Default:True.group_size (int, optional) – The size of the group in
wthat +group_size (int, optional) – The size of the group in
wthat shares a scale and bias. Default:64.bits (int, optional) – The number of bits occupied by each element in +
bits (int, optional) – The number of bits occupied by each element in
w. Default:4.mode (str, optional) – The quantization mode. Default:
"affine".sorted_indices (bool, optional) – May allow a faster implementation +
mode (str, optional) – The quantization mode. Default:
"affine".sorted_indices (bool, optional) – May allow a faster implementation if the passed indices are sorted. Default:
False.
mlx.core.fast.scaled_dot_product_attention — MLX 0.29.2 documentation +mlx.core.fast.scaled_dot_product_attention — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.fast.scaled_dot_product_attention#
mlx.core.gather_qmm — MLX 0.29.2 documentation +mlx.core.gather_qmm — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.gather_qmm#
diff --git a/docs/build/html/python/_autosummary/mlx.core.get_active_memory.html b/docs/build/html/python/_autosummary/mlx.core.get_active_memory.html
index ace245a87..21b0079c0 100644
--- a/docs/build/html/python/_autosummary/mlx.core.get_active_memory.html
+++ b/docs/build/html/python/_autosummary/mlx.core.get_active_memory.html
@@ -8,7 +8,7 @@
- - -get_active_memory() int# +get_active_memory() int#
Get the actively used memory in bytes.
Note, this will not always match memory use reported by the system because it does not include cached memory buffers.
diff --git a/docs/build/html/python/_autosummary/mlx.core.get_cache_memory.html b/docs/build/html/python/_autosummary/mlx.core.get_cache_memory.html index 4315bf809..c52fa7c90 100644 --- a/docs/build/html/python/_autosummary/mlx.core.get_cache_memory.html +++ b/docs/build/html/python/_autosummary/mlx.core.get_cache_memory.html @@ -8,7 +8,7 @@ -mlx.core.get_cache_memory — MLX 0.29.2 documentation +mlx.core.get_cache_memory — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.get_cache_memory#
- -get_cache_memory() int# +get_cache_memory() int#
Get the cache size in bytes.
The cache includes memory not currently used that has not been returned to the system allocator.
diff --git a/docs/build/html/python/_autosummary/mlx.core.get_peak_memory.html b/docs/build/html/python/_autosummary/mlx.core.get_peak_memory.html index 641313459..b5a2ce622 100644 --- a/docs/build/html/python/_autosummary/mlx.core.get_peak_memory.html +++ b/docs/build/html/python/_autosummary/mlx.core.get_peak_memory.html @@ -8,7 +8,7 @@ -mlx.core.get_peak_memory — MLX 0.29.2 documentation +mlx.core.get_peak_memory — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.get_peak_memory#
- -get_peak_memory() int# +get_peak_memory() int#
Get the peak amount of used memory in bytes.
The maximum memory used recorded from the beginning of the program execution or since the last call to
diff --git a/docs/build/html/python/_autosummary/mlx.core.grad.html b/docs/build/html/python/_autosummary/mlx.core.grad.html index 84740f43a..27ba1b5ac 100644 --- a/docs/build/html/python/_autosummary/mlx.core.grad.html +++ b/docs/build/html/python/_autosummary/mlx.core.grad.html @@ -8,7 +8,7 @@ -reset_peak_memory().mlx.core.grad — MLX 0.29.2 documentation +mlx.core.grad — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.grad#
- -grad(fun: Callable, argnums: int | Sequence[int] | None = None, argnames: str | Sequence[str] = []) Callable# +grad(fun: Callable, argnums: int | Sequence[int] | None = None, argnames: str | Sequence[str] = []) Callable#
Returns a function which computes the gradient of
fun.- Parameters: @@ -940,12 +940,12 @@ document.write(`
fun (Callable) – A function which takes a variable number of
arrayor trees ofarrayand returns a scalar outputarray.argnums (int or list(int), optional) – Specify the index (or indices) +
argnums (int or list(int), optional) – Specify the index (or indices) of the positional arguments of
funto compute the gradient with respect to. If neitherargnumsnorargnamesare providedargnumsdefaults to0indicatingfun’s first argument.argnames (str or list(str), optional) – Specify keyword arguments of +
argnames (str or list(str), optional) – Specify keyword arguments of
funto compute gradients with respect to. It defaults to [] so no gradients for keyword arguments by default.
mlx.core.get_active_memory — MLX 0.29.2 documentation +mlx.core.get_active_memory — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.get_active_memory#
mlx.core.greater — MLX 0.29.2 documentation +mlx.core.greater — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.greater#
- -greater(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +greater(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise greater than.
Strict greater than on two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.greater_equal.html b/docs/build/html/python/_autosummary/mlx.core.greater_equal.html index ee3fceac4..75c28b61b 100644 --- a/docs/build/html/python/_autosummary/mlx.core.greater_equal.html +++ b/docs/build/html/python/_autosummary/mlx.core.greater_equal.html @@ -8,7 +8,7 @@ -mlx.core.greater_equal — MLX 0.29.2 documentation +mlx.core.greater_equal — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.greater_equal#
- -greater_equal(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +greater_equal(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise greater or equal.
Greater than or equal on two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.hadamard_transform.html b/docs/build/html/python/_autosummary/mlx.core.hadamard_transform.html index a563a8378..b4c821455 100644 --- a/docs/build/html/python/_autosummary/mlx.core.hadamard_transform.html +++ b/docs/build/html/python/_autosummary/mlx.core.hadamard_transform.html @@ -8,7 +8,7 @@ -mlx.core.hadamard_transform — MLX 0.29.2 documentation +mlx.core.hadamard_transform — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.hadamard_transform#
- -hadamard_transform(a: array, scale: float | None = None, stream: None | Stream | Device = None) array# +hadamard_transform(a: array, scale: float | None = None, stream: None | Stream | Device = None) array#
Perform the Walsh-Hadamard transform along the final axis.
Equivalent to:
@@ -932,7 +932,7 @@ document.write(`@@ -932,12 +932,12 @@ document.write(`from scipy.linalg import hadamard @@ -946,7 +946,7 @@ document.write(`
- Parameters:
mlx.core.identity — MLX 0.29.2 documentation +mlx.core.identity — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.identity#
- -identity(n: int, dtype: Dtype | None = float32, *, stream: None | Stream | Device = None) array# +identity(n: int, dtype: Dtype | None = float32, *, stream: None | Stream | Device = None) array#
Create a square identity matrix.
- Parameters:
-
-
n (int) – The number of rows and columns in the output.
+n (int) – The number of rows and columns in the output.
dtype (Dtype, optional) – Data type of the output array. Defaults to float32.
stream (Stream, optional) – Stream or device. Defaults to None.
mlx.core.imag — MLX 0.29.2 documentation +mlx.core.imag — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.imag#
- -imag(a: array, /, *, stream: None | Stream | Device = None) array# +imag(a: array, /, *, stream: None | Stream | Device = None) array#
Returns the imaginary part of a complex array.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.import_function.html b/docs/build/html/python/_autosummary/mlx.core.import_function.html index 837604be3..c72399374 100644 --- a/docs/build/html/python/_autosummary/mlx.core.import_function.html +++ b/docs/build/html/python/_autosummary/mlx.core.import_function.html @@ -8,7 +8,7 @@ -
- -import_function(file: str) Callable# +import_function(file: str) Callable#
Import a function from a file.
The imported function can be called either with
*argsand**kwargsor with a tuple of arrays and/or dictionary of string @@ -946,7 +946,7 @@ versions of MLX may not be compatible with future versions.- Parameters: -
file (str) – The file path to import the function from.
+file (str) – The file path to import the function from.
- Returns:
The imported function.
diff --git a/docs/build/html/python/_autosummary/mlx.core.inner.html b/docs/build/html/python/_autosummary/mlx.core.inner.html index 849f0bc61..c3a3cd024 100644 --- a/docs/build/html/python/_autosummary/mlx.core.inner.html +++ b/docs/build/html/python/_autosummary/mlx.core.inner.html @@ -8,7 +8,7 @@ -mlx.core.inner — MLX 0.29.2 documentation +mlx.core.inner — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.inner#
- -inner(a: array, b: array, /, *, stream: None | Stream | Device = None) array# +inner(a: array, b: array, /, *, stream: None | Stream | Device = None) array#
Ordinary inner product of vectors for 1-D arrays, in higher dimensions a sum product over the last axes.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.isclose.html b/docs/build/html/python/_autosummary/mlx.core.isclose.html index f2b530dfc..2cc0e8052 100644 --- a/docs/build/html/python/_autosummary/mlx.core.isclose.html +++ b/docs/build/html/python/_autosummary/mlx.core.isclose.html @@ -8,7 +8,7 @@ -
- -isclose(a: array, b: array, /, rtol: float = 1e-05, atol: float = 1e-08, *, equal_nan: bool = False, stream: None | Stream | Device = None) array# +isclose(a: array, b: array, /, rtol: float = 1e-05, atol: float = 1e-08, *, equal_nan: bool = False, stream: None | Stream | Device = None) array#
Returns a boolean array where two arrays are element-wise equal within a tolerance.
Infinite values are considered equal if they have the same sign, NaN values are not equal unless
@@ -947,9 +947,9 @@ broadcasting.equal_nanisTrue.a (array) – Input array.
b (array) – Input array.
-rtol (float) – Relative tolerance.
-atol (float) – Absolute tolerance.
-equal_nan (bool) – If
True, NaNs are considered equal. +rtol (float) – Relative tolerance.
+atol (float) – Absolute tolerance.
+equal_nan (bool) – If
True, NaNs are considered equal. Defaults toFalse.
mlx.core.isfinite — MLX 0.29.2 documentation +mlx.core.isfinite — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.isfinite#
- -isfinite(a: array, stream: None | Stream | Device = None) array# +isfinite(a: array, stream: None | Stream | Device = None) array#
Return a boolean array indicating which elements are finite.
An element is finite if it is not infinite or NaN.
-
diff --git a/docs/build/html/python/_autosummary/mlx.core.isinf.html b/docs/build/html/python/_autosummary/mlx.core.isinf.html
index 9dbc16f0c..93e32616d 100644
--- a/docs/build/html/python/_autosummary/mlx.core.isinf.html
+++ b/docs/build/html/python/_autosummary/mlx.core.isinf.html
@@ -8,7 +8,7 @@
-
- -isinf(a: array, stream: None | Stream | Device = None) array# +isinf(a: array, stream: None | Stream | Device = None) array#
Return a boolean array indicating which elements are +/- inifnity.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.isnan.html b/docs/build/html/python/_autosummary/mlx.core.isnan.html index 9353113f4..7d181a833 100644 --- a/docs/build/html/python/_autosummary/mlx.core.isnan.html +++ b/docs/build/html/python/_autosummary/mlx.core.isnan.html @@ -8,7 +8,7 @@ -
- -isnan(a: array, stream: None | Stream | Device = None) array# +isnan(a: array, stream: None | Stream | Device = None) array#
Return a boolean array indicating which elements are NaN.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.isneginf.html b/docs/build/html/python/_autosummary/mlx.core.isneginf.html index da9025184..abb25eafb 100644 --- a/docs/build/html/python/_autosummary/mlx.core.isneginf.html +++ b/docs/build/html/python/_autosummary/mlx.core.isneginf.html @@ -8,7 +8,7 @@ -
- -isneginf(a: array, stream: None | Stream | Device = None) array# +isneginf(a: array, stream: None | Stream | Device = None) array#
Return a boolean array indicating which elements are negative infinity.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.isposinf.html b/docs/build/html/python/_autosummary/mlx.core.isposinf.html index 115e1e582..cff948f44 100644 --- a/docs/build/html/python/_autosummary/mlx.core.isposinf.html +++ b/docs/build/html/python/_autosummary/mlx.core.isposinf.html @@ -8,7 +8,7 @@ -
- -isposinf(a: array, stream: None | Stream | Device = None) array# +isposinf(a: array, stream: None | Stream | Device = None) array#
Return a boolean array indicating which elements are positive infinity.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.issubdtype.html b/docs/build/html/python/_autosummary/mlx.core.issubdtype.html index 27b348e49..17e7005c9 100644 --- a/docs/build/html/python/_autosummary/mlx.core.issubdtype.html +++ b/docs/build/html/python/_autosummary/mlx.core.issubdtype.html @@ -8,7 +8,7 @@ -
- -issubdtype(arg1: Dtype | DtypeCategory, arg2: Dtype | DtypeCategory) bool# +issubdtype(arg1: Dtype | DtypeCategory, arg2: Dtype | DtypeCategory) bool#
Check if a
DtypeorDtypeCategoryis a subtype of another.-
@@ -949,7 +949,7 @@ of another.
second input.
- Return type: -
-
+
- -jvp(fun: Callable, primals: list[array], tangents: list[array]) tuple[list[array], list[array]]# +jvp(fun: Callable, primals: list[array], tangents: list[array]) tuple[list[array], list[array]]#
Compute the Jacobian-vector product.
This computes the product of the Jacobian of a function
@@ -941,9 +941,9 @@ atfunevaluated atprimalswith thetangents.primalsfun (Callable) – A function which takes a variable number of
arrayand returns a singlearrayor list ofarray.
-primals (list(array)) – A list of
arrayat which to evaluate the Jacobian.
-tangents (list(array)) – A list of
arraywhich are the “vector” in the Jacobian-vector product. Thetangentsshould be the same in number, shape, and type as the inputs offun(i.e. theprimals).
fun.- Return type: -
-
+
mlx.core.issubdtype — MLX 0.29.2 documentation +mlx.core.issubdtype — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.issubdtype#
Example
diff --git a/docs/build/html/python/_autosummary/mlx.core.jvp.html b/docs/build/html/python/_autosummary/mlx.core.jvp.html index d93f830ce..8aa82976c 100644 --- a/docs/build/html/python/_autosummary/mlx.core.jvp.html +++ b/docs/build/html/python/_autosummary/mlx.core.jvp.html @@ -8,7 +8,7 @@ -mlx.core.jvp — MLX 0.29.2 documentation +mlx.core.jvp — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.jvp#
- -kron(a: array, b: array, *, stream: None | Stream | Device = None) array# +kron(a: array, b: array, *, stream: None | Stream | Device = None) array#
Compute the Kronecker product of two arrays
aandb.- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.left_shift.html b/docs/build/html/python/_autosummary/mlx.core.left_shift.html index 84bbba492..a09e9e13b 100644 --- a/docs/build/html/python/_autosummary/mlx.core.left_shift.html +++ b/docs/build/html/python/_autosummary/mlx.core.left_shift.html @@ -8,7 +8,7 @@ -
- -left_shift(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +left_shift(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise left shift.
Shift the bits of the first input to the left by the second using numpy-style broadcasting semantics. Either or both input arrays can diff --git a/docs/build/html/python/_autosummary/mlx.core.less.html b/docs/build/html/python/_autosummary/mlx.core.less.html index 4481dd051..f1504fa97 100644 --- a/docs/build/html/python/_autosummary/mlx.core.less.html +++ b/docs/build/html/python/_autosummary/mlx.core.less.html @@ -8,7 +8,7 @@ -
mlx.core.less — MLX 0.29.2 documentation +mlx.core.less — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.less#
- -less(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +less(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise less than.
Strict less than on two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.less_equal.html b/docs/build/html/python/_autosummary/mlx.core.less_equal.html index e85949843..5e3c738db 100644 --- a/docs/build/html/python/_autosummary/mlx.core.less_equal.html +++ b/docs/build/html/python/_autosummary/mlx.core.less_equal.html @@ -8,7 +8,7 @@ -mlx.core.less_equal — MLX 0.29.2 documentation +mlx.core.less_equal — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.less_equal#
- -less_equal(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +less_equal(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise less than or equal.
Less than or equal on two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.linalg.cholesky.html b/docs/build/html/python/_autosummary/mlx.core.linalg.cholesky.html index 3ee013dc0..df3942c28 100644 --- a/docs/build/html/python/_autosummary/mlx.core.linalg.cholesky.html +++ b/docs/build/html/python/_autosummary/mlx.core.linalg.cholesky.html @@ -8,7 +8,7 @@ -mlx.core.linalg.cholesky — MLX 0.29.2 documentation +mlx.core.linalg.cholesky — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.linalg.cholesky#
- -cholesky(a: array, upper: bool = False, *, stream: None | Stream | Device = None) array# +cholesky(a: array, upper: bool = False, *, stream: None | Stream | Device = None) array#
Compute the Cholesky decomposition of a real symmetric positive semi-definite matrix.
This function supports arrays with at least 2 dimensions. When the input has more than two dimensions, the Cholesky decomposition is computed for each matrix @@ -942,7 +942,7 @@ in the last two dimensions of
Parameters:a (array) – Input array.
-upper (bool, optional) – If
True, return the upper triangular Cholesky factor. +upper (bool, optional) – If
True, return the upper triangular Cholesky factor. IfFalse, return the lower triangular Cholesky factor. Default:False.stream (Stream, optional) – Stream or device. Defaults to
Nonein which case the default stream of the default device is used.
diff --git a/docs/build/html/python/_autosummary/mlx.core.linalg.cholesky_inv.html b/docs/build/html/python/_autosummary/mlx.core.linalg.cholesky_inv.html
index 79d27ed31..c66e9c38c 100644
--- a/docs/build/html/python/_autosummary/mlx.core.linalg.cholesky_inv.html
+++ b/docs/build/html/python/_autosummary/mlx.core.linalg.cholesky_inv.html
@@ -8,7 +8,7 @@
- - -cholesky_inv(L: array, upper: bool = False, *, stream: None | Stream | Device = None) array# +cholesky_inv(L: array, upper: bool = False, *, stream: None | Stream | Device = None) array#
Compute the inverse of a real symmetric positive semi-definite matrix using it’s Cholesky decomposition.
Let \(\mathbf{A}\) be a real symmetric positive semi-definite matrix and \(\mathbf{L}\) its Cholesky decomposition such that:
@@ -949,7 +949,7 @@ in the last two dimensions of \(\math@@ -932,7 +932,7 @@ document.write(`- Parameters:
L (array) – Input array.
-upper (bool, optional) – If
True, return the upper triangular Cholesky factor. +upper (bool, optional) – If
True, return the upper triangular Cholesky factor. IfFalse, return the lower triangular Cholesky factor. Default:False.stream (Stream, optional) – Stream or device. Defaults to
Nonein which case the default stream of the default device is used.
diff --git a/docs/build/html/python/_autosummary/mlx.core.linalg.cross.html b/docs/build/html/python/_autosummary/mlx.core.linalg.cross.html
index ef3fadb19..86bc153fe 100644
--- a/docs/build/html/python/_autosummary/mlx.core.linalg.cross.html
+++ b/docs/build/html/python/_autosummary/mlx.core.linalg.cross.html
@@ -8,7 +8,7 @@
-
mlx.core.linalg.cross — MLX 0.29.2 documentation +mlx.core.linalg.cross — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.linalg.cross#
- -cross(a: array, b: array, axis: int = -1, *, stream: None | Stream | Device = None) array# +cross(a: array, b: array, axis: int = -1, *, stream: None | Stream | Device = None) array#
Compute the cross product of two arrays along a specified axis.
The cross product is defined for arrays with size 2 or 3 in the specified axis. If the size is 2 then the third value is assumed @@ -942,7 +942,7 @@ to be zero.
a (array) – Input array.
b (array) – Input array.
-axis (int, optional) – Axis along which to compute the cross +
axis (int, optional) – Axis along which to compute the cross product. Default:
-1.stream (Stream, optional) – Stream or device. Defaults to
Nonein which case the default stream of the default device is used.
diff --git a/docs/build/html/python/_autosummary/mlx.core.linalg.eig.html b/docs/build/html/python/_autosummary/mlx.core.linalg.eig.html
index e4b11bcea..2ffd38d9f 100644
--- a/docs/build/html/python/_autosummary/mlx.core.linalg.eig.html
+++ b/docs/build/html/python/_autosummary/mlx.core.linalg.eig.html
@@ -8,7 +8,7 @@
- - -eig(a: array, *, stream: None | Stream | Device = None) Tuple[array, array]# +eig(a: array, *, stream: None | Stream | Device = None) Tuple[array, array]#
Compute the eigenvalues and eigenvectors of a square matrix.
This function differs from
diff --git a/docs/build/html/python/_autosummary/mlx.core.linalg.eigh.html b/docs/build/html/python/_autosummary/mlx.core.linalg.eigh.html index 31874bb1e..a7580ae21 100644 --- a/docs/build/html/python/_autosummary/mlx.core.linalg.eigh.html +++ b/docs/build/html/python/_autosummary/mlx.core.linalg.eigh.html @@ -8,7 +8,7 @@ -numpy.linalg.eig()in that the return type is always complex even if the eigenvalues are all real.mlx.core.linalg.eigh — MLX 0.29.2 documentation +mlx.core.linalg.eigh — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.linalg.eigh#
- -eigh(a: array, UPLO: str = 'L', *, stream: None | Stream | Device = None) Tuple[array, array]# +eigh(a: array, UPLO: str = 'L', *, stream: None | Stream | Device = None) Tuple[array, array]#
Compute the eigenvalues and eigenvectors of a complex Hermitian or real symmetric matrix.
This function supports arrays with at least 2 dimensions. When the input @@ -943,7 +943,7 @@ computed for each matrix in the last two dimensions.
a (array) – Input array. Must be a real symmetric or complex Hermitian matrix.
-UPLO (str, optional) – Whether to use the upper (
"U") or +UPLO (str, optional) – Whether to use the upper (
"U") or lower ("L") triangle of the matrix. Default:"L".stream (Stream, optional) – Stream or device. Defaults to
Nonein which case the default stream of the default device is used.
diff --git a/docs/build/html/python/_autosummary/mlx.core.linalg.eigvals.html b/docs/build/html/python/_autosummary/mlx.core.linalg.eigvals.html
index f99462e7c..2f1b5acff 100644
--- a/docs/build/html/python/_autosummary/mlx.core.linalg.eigvals.html
+++ b/docs/build/html/python/_autosummary/mlx.core.linalg.eigvals.html
@@ -8,7 +8,7 @@
- - -eigvals(a: array, *, stream: Optional[Union[Stream, Device]] = None) array# +eigvals(a: array, *, stream: Optional[Union[Stream, Device]] = None) array#
Compute the eigenvalues of a square matrix.
This function differs from
diff --git a/docs/build/html/python/_autosummary/mlx.core.linalg.eigvalsh.html b/docs/build/html/python/_autosummary/mlx.core.linalg.eigvalsh.html index dc6d200f3..2eee81579 100644 --- a/docs/build/html/python/_autosummary/mlx.core.linalg.eigvalsh.html +++ b/docs/build/html/python/_autosummary/mlx.core.linalg.eigvalsh.html @@ -8,7 +8,7 @@ -numpy.linalg.eigvals()in that the return type is always complex even if the eigenvalues are all real.mlx.core.linalg.eigvalsh — MLX 0.29.2 documentation +mlx.core.linalg.eigvalsh — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.linalg.eigvalsh#
- -eigvalsh(a: array, UPLO: str = 'L', *, stream: Optional[Union[Stream, Device]] = None) array# +eigvalsh(a: array, UPLO: str = 'L', *, stream: Optional[Union[Stream, Device]] = None) array#
Compute the eigenvalues of a complex Hermitian or real symmetric matrix.
This function supports arrays with at least 2 dimensions. When the input has more than two dimensions, the eigenvalues are computed for @@ -942,7 +942,7 @@ each matrix in the last two dimensions.
a (array) – Input array. Must be a real symmetric or complex Hermitian matrix.
-UPLO (str, optional) – Whether to use the upper (
"U") or +UPLO (str, optional) – Whether to use the upper (
"U") or lower ("L") triangle of the matrix. Default:"L".stream (Stream, optional) – Stream or device. Defaults to
Nonein which case the default stream of the default device is used.
diff --git a/docs/build/html/python/_autosummary/mlx.core.linalg.inv.html b/docs/build/html/python/_autosummary/mlx.core.linalg.inv.html
index a171f6236..5f15b8068 100644
--- a/docs/build/html/python/_autosummary/mlx.core.linalg.inv.html
+++ b/docs/build/html/python/_autosummary/mlx.core.linalg.inv.html
@@ -8,7 +8,7 @@
- - -inv(a: array, *, stream: None | Stream | Device = None) array# +inv(a: array, *, stream: None | Stream | Device = None) array#
Compute the inverse of a square matrix.
This function supports arrays with at least 2 dimensions. When the input has more than two dimensions, the inverse is computed for each matrix diff --git a/docs/build/html/python/_autosummary/mlx.core.linalg.lu.html b/docs/build/html/python/_autosummary/mlx.core.linalg.lu.html index d450df564..77584b72a 100644 --- a/docs/build/html/python/_autosummary/mlx.core.linalg.lu.html +++ b/docs/build/html/python/_autosummary/mlx.core.linalg.lu.html @@ -8,7 +8,7 @@ -
mlx.core.linalg.lu — MLX 0.29.2 documentation +mlx.core.linalg.lu — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.linalg.lu#
- -lu(a: array, *, stream: None | Stream | Device = None) Tuple[array, array, array]# +lu(a: array, *, stream: None | Stream | Device = None) Tuple[array, array, array]#
Compute the LU factorization of the given matrix
A.Note, unlike the default behavior of
scipy.linalg.lu, the pivots are indices. To reconstruct the input useL[P, :] @ Ufor 2 @@ -954,7 +954,7 @@ in which case the default stream of the default device is used.The
p,L, andUarrays, such thatA = L[P, :] @ U- Return type: -
-
+
- -lu_factor(a: array, *, stream: None | Stream | Device = None) Tuple[array, array]# +lu_factor(a: array, *, stream: None | Stream | Device = None) Tuple[array, array]#
Computes a compact representation of the LU factorization.
- Parameters: @@ -946,7 +946,7 @@ in which case the default stream of the default device is used.
mlx.core.linalg.inv — MLX 0.29.2 documentation +mlx.core.linalg.inv — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.linalg.inv#
mlx.core.linalg.lu_factor — MLX 0.29.2 documentation +mlx.core.linalg.lu_factor — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.linalg.lu_factor#
mlx.core.linalg.eigvals — MLX 0.29.2 documentation +mlx.core.linalg.eigvals — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.linalg.eigvals#
mlx.core.linalg.eig — MLX 0.29.2 documentation +mlx.core.linalg.eig — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.linalg.eig#
mlx.core.linalg.cholesky_inv — MLX 0.29.2 documentation +mlx.core.linalg.cholesky_inv — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -141,8 +141,8 @@ -
-
+
+
@@ -933,7 +933,7 @@ document.write(`
mlx.core.linalg.cholesky_inv#
The
LUmatrix andpivotsarray.- Return type: -
-
+
mlx.core.linalg.norm — MLX 0.29.2 documentation +mlx.core.linalg.norm — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -141,8 +141,8 @@ -
-
+
+
@@ -933,7 +933,7 @@ document.write(`
mlx.core.linalg.norm#
- -norm(a: array, /, ord: None | int | float | str = None, axis: None | int | list[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array# +norm(a: array, /, ord: None | int | float | str = None, axis: None | int | list[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array#
Matrix or vector norm.
This function computes vector or matrix norms depending on the value of the
@@ -943,16 +943,16 @@ theordandaxisparameters.orda (array) – Input array. If
-axisisNone,amust be 1-D or 2-D, unlessordisNone. If bothaxisandordareNone, the 2-norm ofa.flattenwill be returned.ord (int, float or str, optional) – Order of the norm (see table under
Notes). +ord (int, float or str, optional) – Order of the norm (see table under
Notes). IfNone, the 2-norm (or Frobenius norm for matrices) will be computed along the givenaxis. Default:None.axis (int or list(int), optional) – If
axisis an integer, it specifies the +axis (int or list(int), optional) – If
axisis an integer, it specifies the axis ofaalong which to compute the vector norms. Ifaxisis a 2-tuple, it specifies the axes that hold 2-D matrices, and the matrix norms of these matrices are computed. If axis isNonethen either a vector norm (whenais 1-D) or a matrix norm (whenais 2-D) is returned. Default:None.keepdims (bool, optional) – If
True, the axes which are normed over are +keepdims (bool, optional) – If
True, the axes which are normed over are left in the result as dimensions with size one. DefaultFalse.
diff --git a/docs/build/html/python/_autosummary/mlx.core.linalg.pinv.html b/docs/build/html/python/_autosummary/mlx.core.linalg.pinv.html
index f245331c3..cf9735f0e 100644
--- a/docs/build/html/python/_autosummary/mlx.core.linalg.pinv.html
+++ b/docs/build/html/python/_autosummary/mlx.core.linalg.pinv.html
@@ -8,7 +8,7 @@
- - -pinv(a: array, *, stream: None | Stream | Device = None) array# +pinv(a: array, *, stream: None | Stream | Device = None) array#
Compute the (Moore-Penrose) pseudo-inverse of a matrix.
This function calculates a generalized inverse of a matrix using its singular-value decomposition. This function supports arrays with at least 2 dimensions. diff --git a/docs/build/html/python/_autosummary/mlx.core.linalg.qr.html b/docs/build/html/python/_autosummary/mlx.core.linalg.qr.html index d111a9c84..a954dae28 100644 --- a/docs/build/html/python/_autosummary/mlx.core.linalg.qr.html +++ b/docs/build/html/python/_autosummary/mlx.core.linalg.qr.html @@ -8,7 +8,7 @@ -
mlx.core.linalg.qr — MLX 0.29.2 documentation +mlx.core.linalg.qr — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.linalg.qr#
- -qr(a: array, *, stream: None | Stream | Device = None) Tuple[array, array]# +qr(a: array, *, stream: None | Stream | Device = None) Tuple[array, array]#
The QR factorization of the input matrix.
This function supports arrays with at least 2 dimensions. The matrices which are factorized are assumed to be in the last two dimensions of @@ -949,7 +949,7 @@ in which case the default stream of the default device is used.
QandRmatrices such thatQ @ R = a.- Return type: -
-
+
Example
diff --git a/docs/build/html/python/_autosummary/mlx.core.linalg.solve.html b/docs/build/html/python/_autosummary/mlx.core.linalg.solve.html index c23a87d95..45dabdf90 100644 --- a/docs/build/html/python/_autosummary/mlx.core.linalg.solve.html +++ b/docs/build/html/python/_autosummary/mlx.core.linalg.solve.html @@ -8,7 +8,7 @@ -mlx.core.linalg.solve — MLX 0.29.2 documentation +mlx.core.linalg.solve — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.linalg.solve#
- -solve(a: array, b: array, *, stream: None | Stream | Device = None) array# +solve(a: array, b: array, *, stream: None | Stream | Device = None) array#
Compute the solution to a system of linear equations
AX = B.- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.linalg.solve_triangular.html b/docs/build/html/python/_autosummary/mlx.core.linalg.solve_triangular.html index 30e103ae4..9b48f06b1 100644 --- a/docs/build/html/python/_autosummary/mlx.core.linalg.solve_triangular.html +++ b/docs/build/html/python/_autosummary/mlx.core.linalg.solve_triangular.html @@ -8,7 +8,7 @@ -
- -solve_triangular(a: array, b: array, *, upper: bool = False, stream: None | Stream | Device = None) array# +solve_triangular(a: array, b: array, *, upper: bool = False, stream: None | Stream | Device = None) array#
Computes the solution of a triangular system of linear equations
AX = B.- Parameters:
a (array) – Input array.
b (array) – Input array.
-upper (bool, optional) – Whether the array is upper or lower +
upper (bool, optional) – Whether the array is upper or lower triangular. Default:
False.stream (Stream, optional) – Stream or device. Defaults to
Nonein which case the default stream of the default device is used.
diff --git a/docs/build/html/python/_autosummary/mlx.core.linalg.svd.html b/docs/build/html/python/_autosummary/mlx.core.linalg.svd.html
index cef24b647..87a8f7849 100644
--- a/docs/build/html/python/_autosummary/mlx.core.linalg.svd.html
+++ b/docs/build/html/python/_autosummary/mlx.core.linalg.svd.html
@@ -8,7 +8,7 @@
- - -svd(a: array, compute_uv: bool = True, *, stream: None | Stream | Device = None) Tuple[array, array, array]# +svd(a: array, compute_uv: bool = True, *, stream: None | Stream | Device = None) Tuple[array, array, array]#
The Singular Value Decomposition (SVD) of the input matrix.
This function supports arrays with at least 2 dimensions. When the input has more than two dimensions, the function iterates over all indices of the first @@ -941,7 +941,7 @@ a.ndim - 2 dimensions and for each combination SVD is applied to the last two in
- Parameters:
a (array) – Input array.
-compute_uv (bool, optional) – If
True, return theU,S, andVtcomponents. +compute_uv (bool, optional) – If
True, return theU,S, andVtcomponents. IfFalse, return only theSarray. Default:True.stream (Stream, optional) – Stream or device. Defaults to
Nonein which case the default stream of the default device is used.
@@ -952,7 +952,7 @@ in which case the default stream of the default device is used.
A = U @ diag(S) @ Vt. If compute_uv isFalsereturns singular values arrayS.- Return type: -
-
+
mlx.core.linalg.svd — MLX 0.29.2 documentation +mlx.core.linalg.svd — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.linalg.svd#
mlx.core.linalg.tri_inv — MLX 0.29.2 documentation +mlx.core.linalg.tri_inv — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.linalg.tri_inv#
- -tri_inv(a: array, upper: bool = False, *, stream: None | Stream | Device = None) array# +tri_inv(a: array, upper: bool = False, *, stream: None | Stream | Device = None) array#
Compute the inverse of a triangular square matrix.
This function supports arrays with at least 2 dimensions. When the input has more than two dimensions, the inverse is computed for each matrix @@ -941,7 +941,7 @@ in the last two dimensions of
Parameters:a (array) – Input array.
-upper (bool, optional) – Whether the array is upper or lower triangular. Defaults to
False.
+upper (bool, optional) – Whether the array is upper or lower triangular. Defaults to
False.stream (Stream, optional) – Stream or device. Defaults to
Nonein which case the default stream of the default device is used.
mlx.core.linspace — MLX 0.29.2 documentation +mlx.core.linspace — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,14 +932,14 @@ document.write(`
mlx.core.linspace#
- -linspace(start, stop, num: int | None = 50, dtype: Dtype | None = float32, stream: None | Stream | Device = None) array# +linspace(start, stop, num: int | None = 50, dtype: Dtype | None = float32, stream: None | Stream | Device = None) array#
Generate
numevenly spaced numbers over interval[start, stop].- Parameters:
start (scalar) – Starting value.
stop (scalar) – Stopping value.
-num (int, optional) – Number of samples, defaults to
50.
+num (int, optional) – Number of samples, defaults to
50.dtype (Dtype, optional) – Specifies the data type of the output, default to
float32.
mlx.core.load — MLX 0.29.2 documentation +mlx.core.load — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,18 +932,18 @@ document.write(`
mlx.core.load#
- -load(file: file | str | Path, /, format: str | None = None, return_metadata: bool = False, *, stream: None | Stream | Device = None) array | dict[str, array]# +load(file: file | str | Path, /, format: str | None = None, return_metadata: bool = False, *, stream: None | Stream | Device = None) array | dict[str, array]#
Load array(s) from a binary file.
The supported formats are
.npy,.npz,.safetensors, and.gguf.- Parameters:
-
-
- -
format (str, optional) – Format of the file. If
None, the +- +
format (str, optional) – Format of the file. If
None, the format is inferred from the file extension. Supported formats:npy,npz, andsafetensors. Default:None.
-return_metadata (bool, optional) – Load the metadata for formats +
return_metadata (bool, optional) – Load the metadata for formats which support matadata. The metadata will be returned as an additional dictionary. Default:
False.
Return type: -- +
diff --git a/docs/build/html/python/_autosummary/mlx.core.log.html b/docs/build/html/python/_autosummary/mlx.core.log.html index 3236c853a..18be5e2da 100644 --- a/docs/build/html/python/_autosummary/mlx.core.log.html +++ b/docs/build/html/python/_autosummary/mlx.core.log.html @@ -8,7 +8,7 @@ -@@ -932,7 +932,7 @@ document.write(`mlx.core.log — MLX 0.29.2 documentation +mlx.core.log — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.log#
- -log(a: array, /, *, stream: None | Stream | Device = None) array# +log(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise natural logarithm.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.log10.html b/docs/build/html/python/_autosummary/mlx.core.log10.html index e1496f750..c752e6b58 100644 --- a/docs/build/html/python/_autosummary/mlx.core.log10.html +++ b/docs/build/html/python/_autosummary/mlx.core.log10.html @@ -8,7 +8,7 @@ -
- -log10(a: array, /, *, stream: None | Stream | Device = None) array# +log10(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise base-10 logarithm.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.log1p.html b/docs/build/html/python/_autosummary/mlx.core.log1p.html index ba958c591..54da27693 100644 --- a/docs/build/html/python/_autosummary/mlx.core.log1p.html +++ b/docs/build/html/python/_autosummary/mlx.core.log1p.html @@ -8,7 +8,7 @@ -
- -log1p(a: array, /, *, stream: None | Stream | Device = None) array# +log1p(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise natural log of one plus the array.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.log2.html b/docs/build/html/python/_autosummary/mlx.core.log2.html index d76fe036e..e6e389c07 100644 --- a/docs/build/html/python/_autosummary/mlx.core.log2.html +++ b/docs/build/html/python/_autosummary/mlx.core.log2.html @@ -8,7 +8,7 @@ -
- -log2(a: array, /, *, stream: None | Stream | Device = None) array# +log2(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise base-2 logarithm.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.logaddexp.html b/docs/build/html/python/_autosummary/mlx.core.logaddexp.html index ba28248a3..8d2c68b67 100644 --- a/docs/build/html/python/_autosummary/mlx.core.logaddexp.html +++ b/docs/build/html/python/_autosummary/mlx.core.logaddexp.html @@ -8,7 +8,7 @@ -
- -logaddexp(a: scalar | array, b: scalar | array, /, *, stream: None | Stream | Device = None) array# +logaddexp(a: scalar | array, b: scalar | array, /, *, stream: None | Stream | Device = None) array#
Element-wise log-add-exp.
This is a numerically stable log-add-exp of two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.logcumsumexp.html b/docs/build/html/python/_autosummary/mlx.core.logcumsumexp.html index 1cc696eb5..20ab9af93 100644 --- a/docs/build/html/python/_autosummary/mlx.core.logcumsumexp.html +++ b/docs/build/html/python/_autosummary/mlx.core.logcumsumexp.html @@ -8,7 +8,7 @@ -mlx.core.logcumsumexp — MLX 0.29.2 documentation +mlx.core.logcumsumexp — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,17 +932,17 @@ document.write(`
mlx.core.logcumsumexp#
- -logcumsumexp(a: array, /, axis: int | None = None, *, reverse: bool = False, inclusive: bool = True, stream: None | Stream | Device = None) array# +logcumsumexp(a: array, /, axis: int | None = None, *, reverse: bool = False, inclusive: bool = True, stream: None | Stream | Device = None) array#
Return the cumulative logsumexp of the elements along the given axis.
- Parameters:
a (array) – Input array
-axis (int, optional) – Optional axis to compute the cumulative logsumexp +
axis (int, optional) – Optional axis to compute the cumulative logsumexp over. If unspecified the cumulative logsumexp of the flattened array is returned.
-reverse (bool) – Perform the cumulative logsumexp in reverse.
-inclusive (bool) – The i-th element of the output includes the i-th +
reverse (bool) – Perform the cumulative logsumexp in reverse.
+inclusive (bool) – The i-th element of the output includes the i-th element of the input.
diff --git a/docs/build/html/python/_autosummary/mlx.core.logical_and.html b/docs/build/html/python/_autosummary/mlx.core.logical_and.html
index fd4e3b211..450d4e632 100644
--- a/docs/build/html/python/_autosummary/mlx.core.logical_and.html
+++ b/docs/build/html/python/_autosummary/mlx.core.logical_and.html
@@ -8,7 +8,7 @@
- - -logical_and(a: array, b: array, /, *, stream: None | Stream | Device = None) array# +logical_and(a: array, b: array, /, *, stream: None | Stream | Device = None) array#
Element-wise logical and.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.logical_not.html b/docs/build/html/python/_autosummary/mlx.core.logical_not.html index 0f2246a47..a700fdd9c 100644 --- a/docs/build/html/python/_autosummary/mlx.core.logical_not.html +++ b/docs/build/html/python/_autosummary/mlx.core.logical_not.html @@ -8,7 +8,7 @@ -
- -logical_not(a: array, /, *, stream: None | Stream | Device = None) array# +logical_not(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise logical not.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.logical_or.html b/docs/build/html/python/_autosummary/mlx.core.logical_or.html index 8ba800e97..873c32909 100644 --- a/docs/build/html/python/_autosummary/mlx.core.logical_or.html +++ b/docs/build/html/python/_autosummary/mlx.core.logical_or.html @@ -8,7 +8,7 @@ -
- -logical_or(a: array, b: array, /, *, stream: None | Stream | Device = None) array# +logical_or(a: array, b: array, /, *, stream: None | Stream | Device = None) array#
Element-wise logical or.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.logsumexp.html b/docs/build/html/python/_autosummary/mlx.core.logsumexp.html index c6037452e..f1683e975 100644 --- a/docs/build/html/python/_autosummary/mlx.core.logsumexp.html +++ b/docs/build/html/python/_autosummary/mlx.core.logsumexp.html @@ -8,7 +8,7 @@ -
- -logsumexp(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array# +logsumexp(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array#
A log-sum-exp reduction over the given axes.
The log-sum-exp reduction is a numerically stable version of:
@@ -932,16 +932,16 @@ document.write(`@@ -932,7 +932,7 @@ document.write(`log(sum(exp(a), axis)) @@ -942,10 +942,10 @@ document.write(`
- Parameters:
a (array) – Input array.
-axis (int or list(int), optional) – Optional axis or axes to reduce over. If unspecified this defaults to reducing over the entire array.
-keepdims (bool, optional) – Keep reduced axes as +
keepdims (bool, optional) – Keep reduced axes as singleton dimensions, defaults to False.
mlx.core.matmul — MLX 0.29.2 documentation +mlx.core.matmul — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.matmul#
- -matmul(a: array, b: array, /, *, stream: None | Stream | Device = None) array# +matmul(a: array, b: array, /, *, stream: None | Stream | Device = None) array#
Matrix multiplication.
Perform the (possibly batched) matrix multiplication of two arrays. This function supports broadcasting for arrays with more than two dimensions.
diff --git a/docs/build/html/python/_autosummary/mlx.core.max.html b/docs/build/html/python/_autosummary/mlx.core.max.html index 4d961651b..2fbb64192 100644 --- a/docs/build/html/python/_autosummary/mlx.core.max.html +++ b/docs/build/html/python/_autosummary/mlx.core.max.html @@ -8,7 +8,7 @@ -mlx.core.max — MLX 0.29.2 documentation +mlx.core.max — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.max#
- -max(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array# +max(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array#
A max reduction over the given axes.
- Parameters:
a (array) – Input array.
-axis (int or list(int), optional) – Optional axis or axes to reduce over. If unspecified this defaults to reducing over the entire array.
-keepdims (bool, optional) – Keep reduced axes as +
keepdims (bool, optional) – Keep reduced axes as singleton dimensions, defaults to False.
diff --git a/docs/build/html/python/_autosummary/mlx.core.maximum.html b/docs/build/html/python/_autosummary/mlx.core.maximum.html
index 4f2ad70ec..42bfab7c4 100644
--- a/docs/build/html/python/_autosummary/mlx.core.maximum.html
+++ b/docs/build/html/python/_autosummary/mlx.core.maximum.html
@@ -8,7 +8,7 @@
- - -maximum(a: scalar | array, b: scalar | array, /, *, stream: None | Stream | Device = None) array# +maximum(a: scalar | array, b: scalar | array, /, *, stream: None | Stream | Device = None) array#
Element-wise maximum.
Take the element-wise max of two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.mean.html b/docs/build/html/python/_autosummary/mlx.core.mean.html index a5283b0f5..10216761b 100644 --- a/docs/build/html/python/_autosummary/mlx.core.mean.html +++ b/docs/build/html/python/_autosummary/mlx.core.mean.html @@ -8,7 +8,7 @@ -mlx.core.mean — MLX 0.29.2 documentation +mlx.core.mean — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,16 +932,16 @@ document.write(`
mlx.core.mean#
- -mean(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array# +mean(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array#
Compute the mean(s) over the given axes.
- Parameters:
a (array) – Input array.
-axis (int or list(int), optional) – Optional axis or axes to reduce over. If unspecified this defaults to reducing over the entire array.
-keepdims (bool, optional) – Keep reduced axes as +
keepdims (bool, optional) – Keep reduced axes as singleton dimensions, defaults to False.
diff --git a/docs/build/html/python/_autosummary/mlx.core.meshgrid.html b/docs/build/html/python/_autosummary/mlx.core.meshgrid.html
index e49e97052..9437c03c3 100644
--- a/docs/build/html/python/_autosummary/mlx.core.meshgrid.html
+++ b/docs/build/html/python/_autosummary/mlx.core.meshgrid.html
@@ -8,7 +8,7 @@
- - -meshgrid(*arrays: array, sparse: bool | None = False, indexing: str | None = 'xy', stream: None | Stream | Device = None) array# +meshgrid(*arrays: array, sparse: bool | None = False, indexing: str | None = 'xy', stream: None | Stream | Device = None) array#
Generate multidimensional coordinate grids from 1-D coordinate arrays
- Parameters:
*arrays (array) – Input arrays.
-sparse (bool, optional) – If
True, a sparse grid is returned in which each output +sparse (bool, optional) – If
True, a sparse grid is returned in which each output array has a single non-zero element. IfFalse, a dense grid is returned. Defaults toFalse.
-indexing (str, optional) – Cartesian (‘xy’) or matrix (‘ij’) indexing of the output arrays. +
indexing (str, optional) – Cartesian (‘xy’) or matrix (‘ij’) indexing of the output arrays. Defaults to
'xy'.
@@ -949,7 +949,7 @@ Defaults to
'xy'The output arrays.
- Return type: -
-
+
mlx.core.meshgrid — MLX 0.29.2 documentation +mlx.core.meshgrid — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,16 +932,16 @@ document.write(`
mlx.core.meshgrid#
mlx.core.metal.device_info — MLX 0.29.2 documentation +mlx.core.metal.device_info — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.metal.device_info#
- -start_capture(path: str) None# +start_capture(path: str) None#
Start a Metal capture.
- Parameters: -
path (str) – The path to save the capture which should have +
path (str) – The path to save the capture which should have the extension
.gputrace.
mlx.core.metal.stop_capture — MLX 0.29.2 documentation +mlx.core.metal.stop_capture — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.metal.stop_capture#
diff --git a/docs/build/html/python/_autosummary/mlx.core.min.html b/docs/build/html/python/_autosummary/mlx.core.min.html index 163c9794d..1594d8b33 100644 --- a/docs/build/html/python/_autosummary/mlx.core.min.html +++ b/docs/build/html/python/_autosummary/mlx.core.min.html @@ -8,7 +8,7 @@ -mlx.core.min — MLX 0.29.2 documentation +mlx.core.min — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,16 +932,16 @@ document.write(`
mlx.core.min#
- -min(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array# +min(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array#
A min reduction over the given axes.
- Parameters:
a (array) – Input array.
-axis (int or list(int), optional) – Optional axis or axes to reduce over. If unspecified this defaults to reducing over the entire array.
-keepdims (bool, optional) – Keep reduced axes as +
keepdims (bool, optional) – Keep reduced axes as singleton dimensions, defaults to False.
diff --git a/docs/build/html/python/_autosummary/mlx.core.minimum.html b/docs/build/html/python/_autosummary/mlx.core.minimum.html
index 6decb87a4..a9269d047 100644
--- a/docs/build/html/python/_autosummary/mlx.core.minimum.html
+++ b/docs/build/html/python/_autosummary/mlx.core.minimum.html
@@ -8,7 +8,7 @@
- - -minimum(a: scalar | array, b: scalar | array, /, *, stream: None | Stream | Device = None) array# +minimum(a: scalar | array, b: scalar | array, /, *, stream: None | Stream | Device = None) array#
Element-wise minimum.
Take the element-wise min of two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.moveaxis.html b/docs/build/html/python/_autosummary/mlx.core.moveaxis.html index cd6346906..de48bd65b 100644 --- a/docs/build/html/python/_autosummary/mlx.core.moveaxis.html +++ b/docs/build/html/python/_autosummary/mlx.core.moveaxis.html @@ -8,7 +8,7 @@ -mlx.core.moveaxis — MLX 0.29.2 documentation +mlx.core.moveaxis — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,14 +932,14 @@ document.write(`
mlx.core.moveaxis#
- -moveaxis(a: array, /, source: int, destination: int, *, stream: None | Stream | Device = None) array# +moveaxis(a: array, /, source: int, destination: int, *, stream: None | Stream | Device = None) array#
Move an axis to a new position.
- Parameters:
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.multiply.html b/docs/build/html/python/_autosummary/mlx.core.multiply.html index 65e9ef79a..99f21941e 100644 --- a/docs/build/html/python/_autosummary/mlx.core.multiply.html +++ b/docs/build/html/python/_autosummary/mlx.core.multiply.html @@ -8,7 +8,7 @@ -
- -multiply(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +multiply(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise multiplication.
Multiply two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.nan_to_num.html b/docs/build/html/python/_autosummary/mlx.core.nan_to_num.html index f996420c6..40a027d26 100644 --- a/docs/build/html/python/_autosummary/mlx.core.nan_to_num.html +++ b/docs/build/html/python/_autosummary/mlx.core.nan_to_num.html @@ -8,7 +8,7 @@ -mlx.core.nan_to_num — MLX 0.29.2 documentation +mlx.core.nan_to_num — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,17 +932,17 @@ document.write(`
mlx.core.nan_to_num#
- -nan_to_num(a: scalar | array, nan: float = 0, posinf: float | None = None, neginf: float | None = None, *, stream: None | Stream | Device = None) array# +nan_to_num(a: scalar | array, nan: float = 0, posinf: float | None = None, neginf: float | None = None, *, stream: None | Stream | Device = None) array#
Replace NaN and Inf values with finite numbers.
- Parameters:
a (array) – Input array
-nan (float, optional) – Value to replace NaN with. Default:
0.
-posinf (float, optional) – Value to replace positive infinities +
nan (float, optional) – Value to replace NaN with. Default:
0.
+posinf (float, optional) – Value to replace positive infinities with. If
None, defaults to largest finite value for the given data type. Default:None.
-neginf (float, optional) – Value to replace negative infinities +
neginf (float, optional) – Value to replace negative infinities with. If
None, defaults to the negative of the largest finite value for the given data type. Default:None.
mlx.core.negative — MLX 0.29.2 documentation +mlx.core.negative — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.negative#
- -negative(a: array, /, *, stream: None | Stream | Device = None) array# +negative(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise negation.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.new_stream.html b/docs/build/html/python/_autosummary/mlx.core.new_stream.html index 7d0f65143..3506afe94 100644 --- a/docs/build/html/python/_autosummary/mlx.core.new_stream.html +++ b/docs/build/html/python/_autosummary/mlx.core.new_stream.html @@ -8,7 +8,7 @@ -
- -not_equal(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +not_equal(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise not equal.
Not equal comparison on two arrays with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.ones.html b/docs/build/html/python/_autosummary/mlx.core.ones.html index 7a32df6f1..a22f8f386 100644 --- a/docs/build/html/python/_autosummary/mlx.core.ones.html +++ b/docs/build/html/python/_autosummary/mlx.core.ones.html @@ -8,7 +8,7 @@ -mlx.core.ones — MLX 0.29.2 documentation +mlx.core.ones — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,12 +932,12 @@ document.write(`
mlx.core.ones#
- -ones(shape: int | Sequence[int], dtype: Dtype | None = float32, *, stream: None | Stream | Device = None) array# +ones(shape: int | Sequence[int], dtype: Dtype | None = float32, *, stream: None | Stream | Device = None) array#
Construct an array of ones.
- Parameters:
-
-
- +
dtype (Dtype, optional) – Data type of the output array. If unspecified the output type defaults to
float32.
mlx.core.ones_like — MLX 0.29.2 documentation +mlx.core.ones_like — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.ones_like#
- -ones_like(a: array, /, *, stream: None | Stream | Device = None) array# +ones_like(a: array, /, *, stream: None | Stream | Device = None) array#
An array of ones like the input.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.outer.html b/docs/build/html/python/_autosummary/mlx.core.outer.html index e047d2b35..28595a4aa 100644 --- a/docs/build/html/python/_autosummary/mlx.core.outer.html +++ b/docs/build/html/python/_autosummary/mlx.core.outer.html @@ -8,7 +8,7 @@ -
- -outer(a: array, b: array, /, *, stream: None | Stream | Device = None) array# +outer(a: array, b: array, /, *, stream: None | Stream | Device = None) array#
Compute the outer product of two 1-D arrays, if the array’s passed are not 1-D a flatten op will be run beforehand.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.pad.html b/docs/build/html/python/_autosummary/mlx.core.pad.html index 2abe0985a..4adab8b0c 100644 --- a/docs/build/html/python/_autosummary/mlx.core.pad.html +++ b/docs/build/html/python/_autosummary/mlx.core.pad.html @@ -8,7 +8,7 @@ -
- -pad(a: array, pad_width: int | tuple[int] | tuple[int, int] | list[tuple[int, int]], mode: Literal['constant', 'edge'] = 'constant', constant_values: scalar | array = 0, *, stream: None | Stream | Device = None) array# +pad(a: array, pad_width: int | tuple[int] | tuple[int, int] | list[tuple[int, int]], mode: Literal['constant', 'edge'] = 'constant', constant_values: scalar | array = 0, *, stream: None | Stream | Device = None) array#
Pad an array with a constant value
- Parameters:
a (array) – Input array.
-pad_width (int, tuple(int), tuple(int, int) or list(tuple(int, int))) – Number of padded +
pad_width (int, tuple(int), tuple(int, int) or list(tuple(int, int))) – Number of padded values to add to the edges of each axis:
((before_1, after_1), (before_2, after_2), ..., (before_N, after_N)). If a single pair of integers is passed then(before_i, after_i)are all the same. diff --git a/docs/build/html/python/_autosummary/mlx.core.partition.html b/docs/build/html/python/_autosummary/mlx.core.partition.html index f8d1c4177..aa4f0eb3a 100644 --- a/docs/build/html/python/_autosummary/mlx.core.partition.html +++ b/docs/build/html/python/_autosummary/mlx.core.partition.html @@ -8,7 +8,7 @@ -mlx.core.partition — MLX 0.29.2 documentation +mlx.core.partition — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.partition#
- -partition(a: array, /, kth: int, axis: None | int = -1, *, stream: None | Stream | Device = None) array# +partition(a: array, /, kth: int, axis: None | int = -1, *, stream: None | Stream | Device = None) array#
Returns a partitioned copy of the array such that the smaller
kthelements are first.The ordering of the elements in partitions is undefined.
@@ -940,11 +940,11 @@ elements are first.
mlx.core.pad — MLX 0.29.2 documentation +mlx.core.pad — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.pad#
mlx.core.outer — MLX 0.29.2 documentation +mlx.core.outer — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.outer#
mlx.core.new_stream — MLX 0.29.2 documentation +mlx.core.new_stream — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.not_equal.html b/docs/build/html/python/_autosummary/mlx.core.not_equal.html
index b33de99dc..ff86889f0 100644
--- a/docs/build/html/python/_autosummary/mlx.core.not_equal.html
+++ b/docs/build/html/python/_autosummary/mlx.core.not_equal.html
@@ -8,7 +8,7 @@
- mlx.core.not_equal — MLX 0.29.2 documentation +mlx.core.not_equal — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.not_equal#
mlx.core.multiply — MLX 0.29.2 documentation +mlx.core.multiply — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.multiply#
mlx.core.minimum — MLX 0.29.2 documentation +mlx.core.minimum — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.minimum#
mlx.core.maximum — MLX 0.29.2 documentation +mlx.core.maximum — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.maximum#
mlx.core.metal.is_available — MLX 0.29.2 documentation +mlx.core.metal.is_available — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.metal.is_available#
diff --git a/docs/build/html/python/_autosummary/mlx.core.metal.start_capture.html b/docs/build/html/python/_autosummary/mlx.core.metal.start_capture.html index 7dc085587..ad4e7f604 100644 --- a/docs/build/html/python/_autosummary/mlx.core.metal.start_capture.html +++ b/docs/build/html/python/_autosummary/mlx.core.metal.start_capture.html @@ -8,7 +8,7 @@ -mlx.core.metal.start_capture — MLX 0.29.2 documentation +mlx.core.metal.start_capture — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,11 +932,11 @@ document.write(`
mlx.core.metal.start_capture#
mlx.core.logsumexp — MLX 0.29.2 documentation +mlx.core.logsumexp — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.logsumexp#
mlx.core.logical_or — MLX 0.29.2 documentation +mlx.core.logical_or — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.logical_or#
mlx.core.logical_not — MLX 0.29.2 documentation +mlx.core.logical_not — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.logical_not#
mlx.core.logical_and — MLX 0.29.2 documentation +mlx.core.logical_and — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.logical_and#
mlx.core.logaddexp — MLX 0.29.2 documentation +mlx.core.logaddexp — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.logaddexp#
mlx.core.log2 — MLX 0.29.2 documentation +mlx.core.log2 — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.log2#
mlx.core.log1p — MLX 0.29.2 documentation +mlx.core.log1p — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.log1p#
mlx.core.log10 — MLX 0.29.2 documentation +mlx.core.log10 — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.log10#
- Parameters:
a (array) – Input array.
-kth (int) – Element at the
kthindex will be in its sorted +kth (int) – Element at the
kthindex will be in its sorted position in the output. All elements before the kth index will be less or equal to thekthelement and all elements after will be greater or equal to thekthelement in the output.
-axis (int or None, optional) – Optional axis to partition over. +
axis (int or None, optional) – Optional axis to partition over. If
None, this partitions over the flattened array. If unspecified, it defaults to-1.
mlx.core.power — MLX 0.29.2 documentation +mlx.core.power — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.power#
- -power(a: scalar | array, b: scalar | array, /, *, stream: None | Stream | Device = None) array# +power(a: scalar | array, b: scalar | array, /, *, stream: None | Stream | Device = None) array#
Element-wise power operation.
Raise the elements of a to the powers in elements of b with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.prod.html b/docs/build/html/python/_autosummary/mlx.core.prod.html index e192557e3..90e75904d 100644 --- a/docs/build/html/python/_autosummary/mlx.core.prod.html +++ b/docs/build/html/python/_autosummary/mlx.core.prod.html @@ -8,7 +8,7 @@ -mlx.core.prod — MLX 0.29.2 documentation +mlx.core.prod — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,16 +932,16 @@ document.write(`
mlx.core.prod#
- -prod(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array# +prod(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array#
An product reduction over the given axes.
- Parameters:
a (array) – Input array.
-axis (int or list(int), optional) – Optional axis or axes to reduce over. If unspecified this defaults to reducing over the entire array.
-keepdims (bool, optional) – Keep reduced axes as +
keepdims (bool, optional) – Keep reduced axes as singleton dimensions, defaults to False.
diff --git a/docs/build/html/python/_autosummary/mlx.core.put_along_axis.html b/docs/build/html/python/_autosummary/mlx.core.put_along_axis.html
index 6347aae9c..68ca85325 100644
--- a/docs/build/html/python/_autosummary/mlx.core.put_along_axis.html
+++ b/docs/build/html/python/_autosummary/mlx.core.put_along_axis.html
@@ -8,7 +8,7 @@
- - -put_along_axis(a: array, /, indices: array, values: array, axis: int | None = None, *, stream: None | Stream | Device = None) array# +put_along_axis(a: array, /, indices: array, values: array, axis: int | None = None, *, stream: None | Stream | Device = None) array#
Put values along an axis at the specified indices.
- Parameters: @@ -942,7 +942,7 @@ document.write(` the input array excluding the axis dimension.
values (array) – Values array. These should be broadcastable with the indices.
axis (int or None) – Axis in the destination to put the values to. If +
axis (int or None) – Axis in the destination to put the values to. If
axis == Nonethe destination is flattened prior to the put operation.mlx.core.quantize — MLX 0.29.2 documentation +mlx.core.quantize — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -141,8 +141,8 @@ -
-
+
+
@@ -933,7 +933,7 @@ document.write(`
mlx.core.quantize#
- -quantize(w: array, /, group_size: int = 64, bits: int = 4, mode: str = 'affine', *, stream: None | Stream | Device = None) tuple[array, array, array]# +quantize(w: array, /, group_size: int = 64, bits: int = 4, mode: str = 'affine', *, stream: None | Stream | Device = None) tuple[array, array, array]#
Quantize the matrix
wusingbitsbits per element.Note, every
group_sizeelements in a row ofware quantized together. Hence, number of columns ofwshould be divisible by @@ -950,11 +950,11 @@ are described in more detail below.- Parameters:
w (array) – Matrix to be quantized
-group_size (int, optional) – The size of the group in
wthat shares a +group_size (int, optional) – The size of the group in
wthat shares a scale and bias. Default:64.
-bits (int, optional) – The number of bits occupied by each element of +
bits (int, optional) – The number of bits occupied by each element of
win the returned quantized matrix. Default:4.
-mode (str, optional) – The quantization mode. Default:
"affine".
+mode (str, optional) – The quantization mode. Default:
"affine".
- Returns: @@ -967,7 +967,7 @@ scale and bias. Default:
- Return type: -
-
+
- -quantized_matmul(x: array, w: array, /, scales: array, biases: array | None = None, transpose: bool = True, group_size: int = 64, bits: int = 4, mode: str = 'affine', *, stream: None | Stream | Device = None) array# +quantized_matmul(x: array, w: array, /, scales: array, biases: array | None = None, transpose: bool = True, group_size: int = 64, bits: int = 4, mode: str = 'affine', *, stream: None | Stream | Device = None) array#
Perform the matrix multiplication with the quantized matrix
w. The quantization uses one floating point scale and bias pergroup_sizeof elements. Each element inwtakesbitsbits and is packed in an @@ -945,14 +945,14 @@ unsigned 32 bit integer.scales (array) – The scales to use per
group_sizeelements ofwbiases (array, optional) – The biases to use per
group_sizeelements ofw. Default:None.transpose (bool, optional) – Defines whether to multiply with the +
transpose (bool, optional) – Defines whether to multiply with the transposed
wor not, namely whether we are performingx @ w.Torx @ w. Default:True.group_size (int, optional) – The size of the group in
wthat +group_size (int, optional) – The size of the group in
wthat shares a scale and bias. Default:64.bits (int, optional) – The number of bits occupied by each element in +
bits (int, optional) – The number of bits occupied by each element in
w. Default:4.mode (str, optional) – The quantization mode. Default:
"affine".mode (str, optional) – The quantization mode. Default:
"affine".- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.radians.html b/docs/build/html/python/_autosummary/mlx.core.radians.html index 1a7d5ab09..6ab2887a8 100644 --- a/docs/build/html/python/_autosummary/mlx.core.radians.html +++ b/docs/build/html/python/_autosummary/mlx.core.radians.html @@ -8,7 +8,7 @@ -
- -radians(a: array, /, *, stream: None | Stream | Device = None) array# +radians(a: array, /, *, stream: None | Stream | Device = None) array#
Convert angles from degrees to radians.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.random.bernoulli.html b/docs/build/html/python/_autosummary/mlx.core.random.bernoulli.html index 175e39299..e14facbd1 100644 --- a/docs/build/html/python/_autosummary/mlx.core.random.bernoulli.html +++ b/docs/build/html/python/_autosummary/mlx.core.random.bernoulli.html @@ -8,7 +8,7 @@ -
- -bernoulli(p: scalar | array = 0.5, shape: Sequence[int] | None = None, key: array | None = None, stream: None | Stream | Device = None) array# +bernoulli(p: scalar | array = 0.5, shape: Sequence[int] | None = None, key: array | None = None, stream: None | Stream | Device = None) array#
Generate Bernoulli random values.
The values are sampled from the bernoulli distribution with parameter -
p. The parameterpcan be afloatorarrayand +p. The parameterpcan be afloatorarrayand must be broadcastable toshape.- Parameters:
-
-
p (float or array, optional) – Parameter of the Bernoulli distribution. Default:
0.5.
-shape (list(int), optional) – Shape of the output. Default:
p.shape.key (array, optional) – A PRNG key. Default:
None.
mlx.core.random.categorical — MLX 0.29.2 documentation +mlx.core.random.categorical — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.random.categorical#
- -categorical(logits: array, axis: int = -1, shape: Sequence[int] | None = None, num_samples: int | None = None, key: array | None = None, stream: None | Stream | Device = None) array# +categorical(logits: array, axis: int = -1, shape: Sequence[int] | None = None, num_samples: int | None = None, key: array | None = None, stream: None | Stream | Device = None) array#
Sample from a categorical distribution.
The values are sampled from the categorical distribution specified by the unnormalized values in
logits. Note, at most one ofshape@@ -942,12 +942,12 @@ has the same shape asParameters:logits (array) – The unnormalized categorical distribution(s).
-axis (int, optional) – The axis which specifies the distribution. +
axis (int, optional) – The axis which specifies the distribution. Default:
-1.
-shape (list(int), optional) – The shape of the output. This must +
shape (list(int), optional) – The shape of the output. This must be broadcast compatible with
logits.shapewith theaxisdimension removed. Default:None
-num_samples (int, optional) – The number of samples to draw from each +
num_samples (int, optional) – The number of samples to draw from each of the categorical distributions in
logits. The output will havenum_samplesin the last dimension. Default:None.key (array, optional) – A PRNG key. Default:
None.
diff --git a/docs/build/html/python/_autosummary/mlx.core.random.gumbel.html b/docs/build/html/python/_autosummary/mlx.core.random.gumbel.html
index b04e894ed..6d7acec20 100644
--- a/docs/build/html/python/_autosummary/mlx.core.random.gumbel.html
+++ b/docs/build/html/python/_autosummary/mlx.core.random.gumbel.html
@@ -8,7 +8,7 @@
- - -gumbel(shape: Sequence[int] = [], dtype: Dtype | None = float32, key: None | Stream | Device = None, stream: array | None = None) array# +gumbel(shape: Sequence[int] = [], dtype: Dtype | None = float32, key: None | Stream | Device = None, stream: array | None = None) array#
Sample from the standard Gumbel distribution.
The values are sampled from a standard Gumbel distribution which CDF
exp(-exp(-x)).- Parameters:
-
-
- +
dtype (Dtype, optional) – The data type of the output. Default:
float32.key (array, optional) – A PRNG key. Default:
None.
diff --git a/docs/build/html/python/_autosummary/mlx.core.random.key.html b/docs/build/html/python/_autosummary/mlx.core.random.key.html
index 5263606b9..75e4b7e6c 100644
--- a/docs/build/html/python/_autosummary/mlx.core.random.key.html
+++ b/docs/build/html/python/_autosummary/mlx.core.random.key.html
@@ -8,7 +8,7 @@
- - -key(seed: int) array# +key(seed: int) array#
Get a PRNG key from a seed.
- Parameters: -
seed (int) – Seed for the PRNG.
+seed (int) – Seed for the PRNG.
- Returns:
The PRNG key array.
diff --git a/docs/build/html/python/_autosummary/mlx.core.random.laplace.html b/docs/build/html/python/_autosummary/mlx.core.random.laplace.html index 70ee5534c..f20d5aa92 100644 --- a/docs/build/html/python/_autosummary/mlx.core.random.laplace.html +++ b/docs/build/html/python/_autosummary/mlx.core.random.laplace.html @@ -8,7 +8,7 @@ -mlx.core.random.laplace — MLX 0.29.2 documentation +mlx.core.random.laplace — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,15 +932,15 @@ document.write(`
mlx.core.random.laplace#
- -laplace(shape: Sequence[int] = [], dtype: Dtype | None = float32, loc: float = 0.0, scale: float = 1.0, key: array | None = None, stream: None | Stream | Device = None) array# +laplace(shape: Sequence[int] = [], dtype: Dtype | None = float32, loc: float = 0.0, scale: float = 1.0, key: array | None = None, stream: None | Stream | Device = None) array#
Sample numbers from a Laplace distribution.
- Parameters:
-
-
shape (list(int), optional) – Shape of the output. Default:
().
+shape (list(int), optional) – Shape of the output. Default:
().dtype (Dtype, optional) – Type of the output. Default:
float32.
-loc (float, optional) – Mean of the distribution. Default:
0.0.
-scale (float, optional) – The scale “b” of the Laplace distribution. +
loc (float, optional) – Mean of the distribution. Default:
0.0.
+scale (float, optional) – The scale “b” of the Laplace distribution. Default:
1.0.key (array, optional) – A PRNG key. Default:
None.
mlx.core.random.multivariate_normal — MLX 0.29.2 documentation +mlx.core.random.multivariate_normal — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.random.multivariate_normal#
- -multivariate_normal(mean: array, cov: array, shape: Sequence[int] = [], dtype: Dtype | None = float32, key: array | None = None, stream: None | Stream | Device = None) array# +multivariate_normal(mean: array, cov: array, shape: Sequence[int] = [], dtype: Dtype | None = float32, key: array | None = None, stream: None | Stream | Device = None) array#
Generate jointly-normal random samples given a mean and covariance.
The matrix
@@ -944,7 +944,7 @@ distribution.covmust be positive semi-definite. The behavior is undefined if it is not. The only supporteddtypeisfloat32.
mlx.core.random.key — MLX 0.29.2 documentation +mlx.core.random.key — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,11 +932,11 @@ document.write(`
mlx.core.random.key#
mlx.core.random.gumbel — MLX 0.29.2 documentation +mlx.core.random.gumbel — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,14 +932,14 @@ document.write(`
mlx.core.random.gumbel#
cov (array) – array of shape
(..., n, n), the covariance matrix of the distribution. The batch shape...must be broadcast-compatible with that ofmean.shape (list(int), optional) – The output shape must be broadcast-compatible with
mean.shape[:-1]andcov.shape[:-2]. If empty, the result shape is determined by broadcasting the batch shapes ofmeanandcov. Default:[].mlx.core.random.normal — MLX 0.29.2 documentation +mlx.core.random.normal — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.random.normal#
- -normal(shape: Sequence[int] = [], dtype: Dtype | None = float32, loc: scalar | array | None = None, scale: scalar | array | None = None, key: array | None = None, stream: None | Stream | Device = None) array# +normal(shape: Sequence[int] = [], dtype: Dtype | None = float32, loc: scalar | array | None = None, scale: scalar | array | None = None, key: array | None = None, stream: None | Stream | Device = None) array#
Generate normally distributed random numbers.
If
locandscaleare not provided the “standard” normal distribution is used. That means $x sim mathcal{N}(0, 1)$ for @@ -941,7 +941,7 @@ frac{1}{2})$ for complex numbers.- Parameters:
-
-
shape (list(int), optional) – Shape of the output. Default:
().
+shape (list(int), optional) – Shape of the output. Default:
().dtype (Dtype, optional) – Type of the output. Default:
float32.loc (scalar or array, optional) – Mean of the distribution. Default:
None.
diff --git a/docs/build/html/python/_autosummary/mlx.core.random.permutation.html b/docs/build/html/python/_autosummary/mlx.core.random.permutation.html
index c6b12fd65..a7f275174 100644
--- a/docs/build/html/python/_autosummary/mlx.core.random.permutation.html
+++ b/docs/build/html/python/_autosummary/mlx.core.random.permutation.html
@@ -8,7 +8,7 @@
- - -permutation(x: int | array, axis: int = 0, key: array | None = None, stream: None | Stream | Device = None) array# +permutation(x: int | array, axis: int = 0, key: array | None = None, stream: None | Stream | Device = None) array#
Generate a random permutation or permute the entries of an array.
- Parameters:
-
-
x (int or array, optional) – If an integer is provided a random +
x (int or array, optional) – If an integer is provided a random permtuation of
mx.arange(x)is returned. Otherwise the entries ofxalong the given axis are randomly permuted.
-axis (int, optional) – The axis to permute along. Default:
0.
+axis (int, optional) – The axis to permute along. Default:
0.key (array, optional) – A PRNG key. Default:
None.
diff --git a/docs/build/html/python/_autosummary/mlx.core.random.randint.html b/docs/build/html/python/_autosummary/mlx.core.random.randint.html
index ee1950cc8..f2d743e4c 100644
--- a/docs/build/html/python/_autosummary/mlx.core.random.randint.html
+++ b/docs/build/html/python/_autosummary/mlx.core.random.randint.html
@@ -8,7 +8,7 @@
- - -randint(low: scalar | array, high: scalar | array, shape: Sequence[int] = [], dtype: Dtype | None = int32, key: array | None = None, stream: None | Stream | Device = None) array# +randint(low: scalar | array, high: scalar | array, shape: Sequence[int] = [], dtype: Dtype | None = int32, key: array | None = None, stream: None | Stream | Device = None) array#
Generate random integers from the given interval.
The values are sampled with equal probability from the integers in half-open interval
[low, high). The lower and upper bound can be @@ -942,7 +942,7 @@ scalars or arrays and must be broadcastable tolow (scalar or array) – Lower bound of the interval.
high (scalar or array) – Upper bound of the interval.
-shape (list(int), optional) – Shape of the output. Default:
().
+shape (list(int), optional) – Shape of the output. Default:
().dtype (Dtype, optional) – Type of the output. Default:
int32.key (array, optional) – A PRNG key. Default:
None.
mlx.core.random.seed — MLX 0.29.2 documentation +mlx.core.random.seed — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,11 +932,11 @@ document.write(`
mlx.core.random.seed#
diff --git a/docs/build/html/python/_autosummary/mlx.core.random.split.html b/docs/build/html/python/_autosummary/mlx.core.random.split.html index eade6f8ed..131d94d9e 100644 --- a/docs/build/html/python/_autosummary/mlx.core.random.split.html +++ b/docs/build/html/python/_autosummary/mlx.core.random.split.html @@ -8,7 +8,7 @@ -mlx.core.random.split — MLX 0.29.2 documentation +mlx.core.random.split — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.random.split#
- -split(key: array, num: int = 2, stream: None | Stream | Device = None) array# +split(key: array, num: int = 2, stream: None | Stream | Device = None) array#
Split a PRNG key into sub keys.
- Parameters:
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.random.truncated_normal.html b/docs/build/html/python/_autosummary/mlx.core.random.truncated_normal.html index ad8ffc3f4..6ec2820f8 100644 --- a/docs/build/html/python/_autosummary/mlx.core.random.truncated_normal.html +++ b/docs/build/html/python/_autosummary/mlx.core.random.truncated_normal.html @@ -8,7 +8,7 @@ -
- -truncated_normal(lower: scalar | array, upper: scalar | array, shape: Sequence[int] | None = None, dtype: Dtype | None = float32, key: array | None = None, stream: None | Stream | Device = None) array# +truncated_normal(lower: scalar | array, upper: scalar | array, shape: Sequence[int] | None = None, dtype: Dtype | None = float32, key: array | None = None, stream: None | Stream | Device = None) array#
Generate values from a truncated normal distribution.
The values are sampled from the truncated normal distribution on the domain
(lower, upper). The boundslowerandupper@@ -942,7 +942,7 @@ can be scalars or arrays and must be broadcastable tolower (scalar or array) – Lower bound of the domain.
upper (scalar or array) – Upper bound of the domain.
-shape (list(int), optional) – The shape of the output. Default:
().dtype (Dtype, optional) – The data type of the output. Default:
float32.
diff --git a/docs/build/html/python/_autosummary/mlx.core.random.uniform.html b/docs/build/html/python/_autosummary/mlx.core.random.uniform.html
index 60180364a..199a62569 100644
--- a/docs/build/html/python/_autosummary/mlx.core.random.uniform.html
+++ b/docs/build/html/python/_autosummary/mlx.core.random.uniform.html
@@ -8,7 +8,7 @@
- - -uniform(low: scalar | array = 0, high: scalar | array = 1, shape: Sequence[int] = [], dtype: Dtype | None = float32, key: array | None = None, stream: None | Stream | Device = None) array# +uniform(low: scalar | array = 0, high: scalar | array = 1, shape: Sequence[int] = [], dtype: Dtype | None = float32, key: array | None = None, stream: None | Stream | Device = None) array#
Generate uniformly distributed random numbers.
The values are sampled uniformly in the half-open interval
[low, high). The lower and upper bound can be scalars or arrays and must be @@ -944,7 +944,7 @@ broadcastable tosh Default:0.high (scalar or array, optional) – Upper bound of the distribution. Default:
1.shape (list(int), optional) – Shape of the output. Default:
().shape (list(int), optional) – Shape of the output. Default:
().dtype (Dtype, optional) – Type of the output. Default:
float32.key (array, optional) – A PRNG key. Default:
None.
mlx.core.random.uniform — MLX 0.29.2 documentation +mlx.core.random.uniform — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.random.uniform#
mlx.core.real — MLX 0.29.2 documentation +mlx.core.real — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.real#
- -real(a: array, /, *, stream: None | Stream | Device = None) array# +real(a: array, /, *, stream: None | Stream | Device = None) array#
Returns the real part of a complex array.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.reciprocal.html b/docs/build/html/python/_autosummary/mlx.core.reciprocal.html index 421a91337..5c166f596 100644 --- a/docs/build/html/python/_autosummary/mlx.core.reciprocal.html +++ b/docs/build/html/python/_autosummary/mlx.core.reciprocal.html @@ -8,7 +8,7 @@ -
- -reciprocal(a: array, /, *, stream: None | Stream | Device = None) array# +reciprocal(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise reciprocal.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.remainder.html b/docs/build/html/python/_autosummary/mlx.core.remainder.html index 5bbe63230..31723797e 100644 --- a/docs/build/html/python/_autosummary/mlx.core.remainder.html +++ b/docs/build/html/python/_autosummary/mlx.core.remainder.html @@ -8,7 +8,7 @@ -
- -remainder(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +remainder(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise remainder of division.
Computes the remainder of dividing a with b with numpy-style broadcasting semantics. Either or both input arrays can also be diff --git a/docs/build/html/python/_autosummary/mlx.core.repeat.html b/docs/build/html/python/_autosummary/mlx.core.repeat.html index ae3b9cde8..aa352d3aa 100644 --- a/docs/build/html/python/_autosummary/mlx.core.repeat.html +++ b/docs/build/html/python/_autosummary/mlx.core.repeat.html @@ -8,7 +8,7 @@ -
mlx.core.repeat — MLX 0.29.2 documentation +mlx.core.repeat — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,14 +932,14 @@ document.write(`
mlx.core.repeat#
- -repeat(array: array, repeats: int, axis: int | None = None, *, stream: None | Stream | Device = None) array# +repeat(array: array, repeats: int, axis: int | None = None, *, stream: None | Stream | Device = None) array#
Repeat an array along a specified axis.
- Parameters:
array (array) – Input array.
-repeats (int) – The number of repetitions for each element.
-axis (int, optional) – The axis in which to repeat the array along. If +
repeats (int) – The number of repetitions for each element.
+axis (int, optional) – The axis in which to repeat the array along. If unspecified it uses the flattened array of the input and repeats along axis 0.
stream (Stream, optional) – Stream or device. Defaults to
None.
diff --git a/docs/build/html/python/_autosummary/mlx.core.reset_peak_memory.html b/docs/build/html/python/_autosummary/mlx.core.reset_peak_memory.html
index ff742a2a4..f722a594a 100644
--- a/docs/build/html/python/_autosummary/mlx.core.reset_peak_memory.html
+++ b/docs/build/html/python/_autosummary/mlx.core.reset_peak_memory.html
@@ -8,7 +8,7 @@
- - -reshape(a: array, /, shape: Sequence[int], *, stream: None | Stream | Device = None) array# +reshape(a: array, /, shape: Sequence[int], *, stream: None | Stream | Device = None) array#
Reshape an array while preserving the size.
- Parameters:
a (array) – Input array.
-- +
stream (Stream, optional) – Stream or device. Defaults to
Nonein which case the default stream of the default device is used.
mlx.core.right_shift — MLX 0.29.2 documentation +mlx.core.right_shift — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.right_shift#
- -right_shift(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +right_shift(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise right shift.
Shift the bits of the first input to the right by the second using numpy-style broadcasting semantics. Either or both input arrays can diff --git a/docs/build/html/python/_autosummary/mlx.core.roll.html b/docs/build/html/python/_autosummary/mlx.core.roll.html index dcd11e193..34d100a30 100644 --- a/docs/build/html/python/_autosummary/mlx.core.roll.html +++ b/docs/build/html/python/_autosummary/mlx.core.roll.html @@ -8,7 +8,7 @@ -
mlx.core.roll — MLX 0.29.2 documentation +mlx.core.roll — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.roll#
- -roll(a: array, shift: int | Tuple[int], axis: None | int | Tuple[int] = None, /, *, stream: None | Stream | Device = None) array# +roll(a: array, shift: int | Tuple[int], axis: None | int | Tuple[int] = None, /, *, stream: None | Stream | Device = None) array#
Roll array elements along a given axis.
Elements that are rolled beyond the end of the array are introduced at the beggining and vice-versa.
@@ -942,11 +942,11 @@ shape is restored.
mlx.core.reset_peak_memory — MLX 0.29.2 documentation +mlx.core.reset_peak_memory — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.reset_peak_memory#
diff --git a/docs/build/html/python/_autosummary/mlx.core.reshape.html b/docs/build/html/python/_autosummary/mlx.core.reshape.html index 22e189f3e..24f4fb8f2 100644 --- a/docs/build/html/python/_autosummary/mlx.core.reshape.html +++ b/docs/build/html/python/_autosummary/mlx.core.reshape.html @@ -8,7 +8,7 @@ -mlx.core.reshape — MLX 0.29.2 documentation +mlx.core.reshape — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.reshape#
mlx.core.remainder — MLX 0.29.2 documentation +mlx.core.remainder — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.remainder#
mlx.core.reciprocal — MLX 0.29.2 documentation +mlx.core.reciprocal — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.reciprocal#
- Parameters:
a (array) – Input array
-shift (int or tuple(int)) – The number of places by which elements +
shift (int or tuple(int)) – The number of places by which elements are shifted. If positive the array is rolled to the right, if negative it is rolled to the left. If an int is provided but the axis is a tuple then the same value is used for all axes.
-axis (int or tuple(int), optional) – The axis or axes along which to +
axis (int or tuple(int), optional) – The axis or axes along which to roll the elements.
diff --git a/docs/build/html/python/_autosummary/mlx.core.round.html b/docs/build/html/python/_autosummary/mlx.core.round.html
index 2143911ad..da49fcf61 100644
--- a/docs/build/html/python/_autosummary/mlx.core.round.html
+++ b/docs/build/html/python/_autosummary/mlx.core.round.html
@@ -8,7 +8,7 @@
- - -round(a: array, /, decimals: int = 0, stream: None | Stream | Device = None) array# +round(a: array, /, decimals: int = 0, stream: None | Stream | Device = None) array#
Round to the given number of decimals.
Basically performs:
@@ -932,12 +932,12 @@ document.write(`@@ -932,7 +932,7 @@ document.write(`s = 10**decimals @@ -943,7 +943,7 @@ document.write(`
- Parameters:
- Returns:
diff --git a/docs/build/html/python/_autosummary/mlx.core.rsqrt.html b/docs/build/html/python/_autosummary/mlx.core.rsqrt.html index c8d819682..987eb835c 100644 --- a/docs/build/html/python/_autosummary/mlx.core.rsqrt.html +++ b/docs/build/html/python/_autosummary/mlx.core.rsqrt.html @@ -8,7 +8,7 @@ -mlx.core.rsqrt — MLX 0.29.2 documentation +mlx.core.rsqrt — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.rsqrt#
- -rsqrt(a: array, /, *, stream: None | Stream | Device = None) array# +rsqrt(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise reciprocal and square root.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.save.html b/docs/build/html/python/_autosummary/mlx.core.save.html index e76fd4e82..84b3773b2 100644 --- a/docs/build/html/python/_autosummary/mlx.core.save.html +++ b/docs/build/html/python/_autosummary/mlx.core.save.html @@ -8,7 +8,7 @@ -
mlx.core.save — MLX 0.29.2 documentation +mlx.core.save — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.save#
- -save(file: file | str | Path, arr: array) None# +save(file: file | str | Path, arr: array) None#
Save the array to a binary file in
.npyformat.- Parameters:
- diff --git a/docs/build/html/python/_autosummary/mlx.core.save_gguf.html b/docs/build/html/python/_autosummary/mlx.core.save_gguf.html index c884c1722..984e50547 100644 --- a/docs/build/html/python/_autosummary/mlx.core.save_gguf.html +++ b/docs/build/html/python/_autosummary/mlx.core.save_gguf.html @@ -8,7 +8,7 @@ -
- -save_gguf(file: file | str | Path, arrays: dict[str, array], metadata: dict[str, array | str | list[str]])# +save_gguf(file: file | str | Path, arrays: dict[str, array], metadata: dict[str, array | str | list[str]])#
Save array(s) to a binary file in
.ggufformat.See the GGUF documentation for more information on the format.
- Parameters:
-
-
- -
arrays (dict(str, array)) – The dictionary of names to arrays to +
- +
arrays (dict(str, array)) – The dictionary of names to arrays to be saved.
-metadata (dict(str, Union[array, str, list(str)])) – The dictionary +
metadata (dict(str, Union[array, str, list(str)])) – The dictionary of metadata to be saved. The values can be a scalar or 1D -obj:array, a
str, or alistofstr.
+obj:array, a
str, or alistofstr.
mlx.core.save_gguf — MLX 0.29.2 documentation +mlx.core.save_gguf — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,19 +932,19 @@ document.write(`
mlx.core.save_gguf#
mlx.core.random.truncated_normal — MLX 0.29.2 documentation +mlx.core.random.truncated_normal — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.random.truncated_normal#
mlx.core.round — MLX 0.29.2 documentation +mlx.core.round — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.round#
mlx.core.random.randint — MLX 0.29.2 documentation +mlx.core.random.randint — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.random.randint#
mlx.core.random.permutation — MLX 0.29.2 documentation +mlx.core.random.permutation — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,15 +932,15 @@ document.write(`
mlx.core.random.permutation#
mlx.core.save_safetensors — MLX 0.29.2 documentation +mlx.core.save_safetensors — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,17 +932,17 @@ document.write(`
mlx.core.save_safetensors#
- -save_safetensors(file: file | str | Path, arrays: dict[str, array], metadata: dict[str, str] | None = None)# +save_safetensors(file: file | str | Path, arrays: dict[str, array], metadata: dict[str, str] | None = None)#
Save array(s) to a binary file in
.safetensorsformat.See the Safetensors documentation for more information on the format.
- Parameters:
- diff --git a/docs/build/html/python/_autosummary/mlx.core.savez.html b/docs/build/html/python/_autosummary/mlx.core.savez.html index 1ba4606bb..5b138e0d8 100644 --- a/docs/build/html/python/_autosummary/mlx.core.savez.html +++ b/docs/build/html/python/_autosummary/mlx.core.savez.html @@ -8,7 +8,7 @@ -
- -savez(file: file | str | Path, *args, **kwargs)# +savez(file: file | str | Path, *args, **kwargs)#
Save several arrays to a binary file in uncompressed
.npzformat.@@ -932,7 +932,7 @@ document.write(`@@ -932,12 +932,12 @@ document.write(`import mlx.core as mx @@ -951,7 +951,7 @@ format.
- Parameters:
-
-
file (file, str, Path) – Path to file to which the arrays are saved.
+file (file, str, Path) – Path to file to which the arrays are saved.
*args (arrays) – Arrays to be saved.
**kwargs (arrays) – Arrays to be saved. Each array will be saved with the associated keyword as the output file name.
diff --git a/docs/build/html/python/_autosummary/mlx.core.savez_compressed.html b/docs/build/html/python/_autosummary/mlx.core.savez_compressed.html
index 166eca651..98cfe399a 100644
--- a/docs/build/html/python/_autosummary/mlx.core.savez_compressed.html
+++ b/docs/build/html/python/_autosummary/mlx.core.savez_compressed.html
@@ -8,7 +8,7 @@
-
mlx.core.savez_compressed — MLX 0.29.2 documentation +mlx.core.savez_compressed — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.savez_compressed#
- -savez_compressed(file: file | str | Path, *args, **kwargs)# +savez_compressed(file: file | str | Path, *args, **kwargs)#
Save several arrays to a binary file in compressed
.npzformat.- Parameters:
-
-
file (file, str, Path) – Path to file to which the arrays are saved.
+file (file, str, Path) – Path to file to which the arrays are saved.
*args (arrays) – Arrays to be saved.
**kwargs (arrays) – Arrays to be saved. Each array will be saved with the associated keyword as the output file name.
diff --git a/docs/build/html/python/_autosummary/mlx.core.set_cache_limit.html b/docs/build/html/python/_autosummary/mlx.core.set_cache_limit.html
index 6f660c4f3..052485a57 100644
--- a/docs/build/html/python/_autosummary/mlx.core.set_cache_limit.html
+++ b/docs/build/html/python/_autosummary/mlx.core.set_cache_limit.html
@@ -8,7 +8,7 @@
-
mlx.core.set_cache_limit — MLX 0.29.2 documentation +mlx.core.set_cache_limit — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.set_cache_limit#
- -set_cache_limit(limit: int) int# +set_cache_limit(limit: int) int#
Set the free cache limit.
If using more than the given limit, free memory will be reclaimed from the cache on the next allocation. To disable the cache, set @@ -941,13 +941,13 @@ the limit to
0set_memory_limit()for more details.
mlx.core.set_default_device — MLX 0.29.2 documentation +mlx.core.set_default_device — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.set_default_device#
- -set_default_device(device: Device) None# +set_default_device(device: Device) None#
Set the default device.
mlx.core.set_default_stream — MLX 0.29.2 documentation +mlx.core.set_default_stream — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.set_default_stream#
- -set_default_stream(stream: Stream) None# +set_default_stream(stream: Stream) None#
Set the default stream.
This will make the given stream the default for the streams device. It will not change the default device.
diff --git a/docs/build/html/python/_autosummary/mlx.core.set_memory_limit.html b/docs/build/html/python/_autosummary/mlx.core.set_memory_limit.html index 722c1bad8..3deacdef2 100644 --- a/docs/build/html/python/_autosummary/mlx.core.set_memory_limit.html +++ b/docs/build/html/python/_autosummary/mlx.core.set_memory_limit.html @@ -8,7 +8,7 @@ -mlx.core.set_memory_limit — MLX 0.29.2 documentation +mlx.core.set_memory_limit — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.set_memory_limit#
- -set_memory_limit(limit: int) int# +set_memory_limit(limit: int) int#
Set the memory limit.
The memory limit is a guideline for the maximum amount of memory to use during graph evaluation. If the memory limit is exceeded and there is no @@ -942,13 +942,13 @@ exception.
maximum recommended working set size reported by the device.
mlx.core.set_wired_limit — MLX 0.29.2 documentation +mlx.core.set_wired_limit — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.set_wired_limit#
- -set_wired_limit(limit: int) int# +set_wired_limit(limit: int) int#
Set the wired size limit.
@@ -933,7 +933,7 @@ document.write(`Note
@@ -954,13 +954,13 @@ increase the system wired limit with: ("memory_size").- Parameters: -
limit (int) – The wired limit in bytes.
+limit (int) – The wired limit in bytes.
- Returns:
The previous wired limit in bytes.
- Return type: -
-
+
mlx.core.sigmoid — MLX 0.29.2 documentation +mlx.core.sigmoid — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -141,8 +141,8 @@ -
-
+
+
mlx.core.sigmoid#
- -sigmoid(a: array, /, *, stream: None | Stream | Device = None) array# +sigmoid(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise logistic sigmoid.
The logistic sigmoid function is:
diff --git a/docs/build/html/python/_autosummary/mlx.core.sign.html b/docs/build/html/python/_autosummary/mlx.core.sign.html index f252b3745..3c89cbbef 100644 --- a/docs/build/html/python/_autosummary/mlx.core.sign.html +++ b/docs/build/html/python/_autosummary/mlx.core.sign.html @@ -8,7 +8,7 @@ -@@ -932,7 +932,7 @@ document.write(`mlx.core.sign — MLX 0.29.2 documentation +mlx.core.sign — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.sign#
- -sign(a: array, /, *, stream: None | Stream | Device = None) array# +sign(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise sign.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.sin.html b/docs/build/html/python/_autosummary/mlx.core.sin.html index 7e8990ddf..93905857b 100644 --- a/docs/build/html/python/_autosummary/mlx.core.sin.html +++ b/docs/build/html/python/_autosummary/mlx.core.sin.html @@ -8,7 +8,7 @@ -
- -sin(a: array, /, *, stream: None | Stream | Device = None) array# +sin(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise sine.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.sinh.html b/docs/build/html/python/_autosummary/mlx.core.sinh.html index 9cf4a63f5..fde40d371 100644 --- a/docs/build/html/python/_autosummary/mlx.core.sinh.html +++ b/docs/build/html/python/_autosummary/mlx.core.sinh.html @@ -8,7 +8,7 @@ -
- -sinh(a: array, /, *, stream: None | Stream | Device = None) array# +sinh(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise hyperbolic sine.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.slice.html b/docs/build/html/python/_autosummary/mlx.core.slice.html index 800a693ac..ec4ad5d79 100644 --- a/docs/build/html/python/_autosummary/mlx.core.slice.html +++ b/docs/build/html/python/_autosummary/mlx.core.slice.html @@ -8,7 +8,7 @@ -
- -slice(a: array, start_indices: array, axes: Sequence[int], slice_size: Sequence[int], *, stream: None | Stream | Device = None) array# +slice(a: array, start_indices: array, axes: Sequence[int], slice_size: Sequence[int], *, stream: None | Stream | Device = None) array#
Extract a sub-array from the input array.
- Parameters:
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.slice_update.html b/docs/build/html/python/_autosummary/mlx.core.slice_update.html index c72441367..b321abd5e 100644 --- a/docs/build/html/python/_autosummary/mlx.core.slice_update.html +++ b/docs/build/html/python/_autosummary/mlx.core.slice_update.html @@ -8,7 +8,7 @@ -
- -slice_update(a: array, update: array, start_indices: array, axes: Sequence[int], *, stream: None | Stream | Device = None) array# +slice_update(a: array, update: array, start_indices: array, axes: Sequence[int], *, stream: None | Stream | Device = None) array#
Update a sub-array of the input array.
- Parameters: @@ -940,7 +940,7 @@ document.write(`
a (array) – The input array to update
update (array) – The update array.
start_indices (array) – The index location to start the slice at.
axes (tuple(int)) – The axes corresponding to the indices in
start_indices.axes (tuple(int)) – The axes corresponding to the indices in
start_indices.- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.softmax.html b/docs/build/html/python/_autosummary/mlx.core.softmax.html index b75f45951..aec209710 100644 --- a/docs/build/html/python/_autosummary/mlx.core.softmax.html +++ b/docs/build/html/python/_autosummary/mlx.core.softmax.html @@ -8,7 +8,7 @@ -
- -softmax(a: array, /, axis: None | int | Sequence[int] = None, *, stream: None | Stream | Device = None) array# +softmax(a: array, /, axis: None | int | Sequence[int] = None, *, stream: None | Stream | Device = None) array#
Perform the softmax along the given axis.
This operation is a numerically stable version of:
@@ -932,25 +932,25 @@ document.write(`@@ -932,13 +932,13 @@ document.write(`exp(a) / sum(exp(a), axis, keepdims=True) @@ -942,7 +942,7 @@ document.write(`
- Parameters:
a (array) – Input array.
-axis (int or list(int), optional) – Optional axis or axes to compute +
axis (int or list(int), optional) – Optional axis or axes to compute the softmax over. If unspecified this performs the softmax over the full array.
mlx.core.sort — MLX 0.29.2 documentation +mlx.core.sort — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.sort#
- -sort(a: array, /, axis: None | int = -1, *, stream: None | Stream | Device = None) array# +sort(a: array, /, axis: None | int = -1, *, stream: None | Stream | Device = None) array#
Returns a sorted copy of the array.
- Parameters:
a (array) – Input array.
-axis (int or None, optional) – Optional axis to sort over. +
axis (int or None, optional) – Optional axis to sort over. If
None, this sorts over the flattened array. If unspecified, it defaults to -1 (sorting over the last axis).
mlx.core.split — MLX 0.29.2 documentation +mlx.core.split — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
mlx.core.split#
- -split(a: array, /, indices_or_sections: int | Sequence[int], axis: int = 0, *, stream: None | Stream | Device = None) array# +split(a: array, /, indices_or_sections: int | Sequence[int], axis: int = 0, *, stream: None | Stream | Device = None) array#
Split an array along a given axis.
- Parameters:
a (array) – Input array.
-indices_or_sections (int or list(int)) – If
indices_or_sections+indices_or_sections (int or list(int)) – If
indices_or_sectionsis an integer the array is split into that many sections of equal size. An error is raised if this is not possible. Ifindices_or_sectionsis a list, the list contains the indices of the start of each subarray along the given axis.
-axis (int, optional) – Axis to split along, defaults to 0.
+axis (int, optional) – Axis to split along, defaults to 0.
- Returns:
A list of split arrays.
- Return type: -
-
+
mlx.core.sqrt — MLX 0.29.2 documentation +mlx.core.sqrt — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.sqrt#
- -sqrt(a: array, /, *, stream: None | Stream | Device = None) array# +sqrt(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise square root.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.square.html b/docs/build/html/python/_autosummary/mlx.core.square.html index 8267ba55b..3be0cb188 100644 --- a/docs/build/html/python/_autosummary/mlx.core.square.html +++ b/docs/build/html/python/_autosummary/mlx.core.square.html @@ -8,7 +8,7 @@ -
- -square(a: array, /, *, stream: None | Stream | Device = None) array# +square(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise square.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.squeeze.html b/docs/build/html/python/_autosummary/mlx.core.squeeze.html index d1af02e31..163bf2c11 100644 --- a/docs/build/html/python/_autosummary/mlx.core.squeeze.html +++ b/docs/build/html/python/_autosummary/mlx.core.squeeze.html @@ -8,7 +8,7 @@ -
- -squeeze(a: array, /, axis: None | int | Sequence[int] = None, *, stream: None | Stream | Device = None) array# +squeeze(a: array, /, axis: None | int | Sequence[int] = None, *, stream: None | Stream | Device = None) array#
Remove length one axes from an array.
- Parameters:
- diff --git a/docs/build/html/python/_autosummary/mlx.core.stack.html b/docs/build/html/python/_autosummary/mlx.core.stack.html index 84aae33a7..e639b833c 100644 --- a/docs/build/html/python/_autosummary/mlx.core.stack.html +++ b/docs/build/html/python/_autosummary/mlx.core.stack.html @@ -8,7 +8,7 @@ -
- -stack(arrays: list[array], axis: int | None = 0, *, stream: None | Stream | Device = None) array# +stack(arrays: list[array], axis: int | None = 0, *, stream: None | Stream | Device = None) array#
Stacks the arrays along a new axis.
- Parameters:
-
-
- -
axis (int, optional) – The axis in the result array along which the +
- +
axis (int, optional) – The axis in the result array along which the input arrays are stacked. Defaults to
0.stream (Stream, optional) – Stream or device. Defaults to
None.
mlx.core.std — MLX 0.29.2 documentation +mlx.core.std — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,18 +932,18 @@ document.write(`
mlx.core.std#
- -std(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, ddof: int = 0, *, stream: None | Stream | Device = None) array# +std(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, ddof: int = 0, *, stream: None | Stream | Device = None) array#
Compute the standard deviation(s) over the given axes.
- Parameters:
a (array) – Input array.
-axis (int or list(int), optional) – Optional axis or axes to reduce over. If unspecified this defaults to reducing over the entire array.
-keepdims (bool, optional) – Keep reduced axes as +
keepdims (bool, optional) – Keep reduced axes as singleton dimensions, defaults to False.
-ddof (int, optional) – The divisor to compute the variance +
ddof (int, optional) – The divisor to compute the variance is
N - ddof, defaults to 0.
diff --git a/docs/build/html/python/_autosummary/mlx.core.stop_gradient.html b/docs/build/html/python/_autosummary/mlx.core.stop_gradient.html
index 83434130e..8c066b4e6 100644
--- a/docs/build/html/python/_autosummary/mlx.core.stop_gradient.html
+++ b/docs/build/html/python/_autosummary/mlx.core.stop_gradient.html
@@ -8,7 +8,7 @@
- - -stop_gradient(a: array, /, *, stream: None | Stream | Device = None) array# +stop_gradient(a: array, /, *, stream: None | Stream | Device = None) array#
Stop gradients from being computed.
The operation is the identity but it prevents gradients from flowing through the array.
diff --git a/docs/build/html/python/_autosummary/mlx.core.stream.html b/docs/build/html/python/_autosummary/mlx.core.stream.html index 9c1702490..a4e78e7f7 100644 --- a/docs/build/html/python/_autosummary/mlx.core.stream.html +++ b/docs/build/html/python/_autosummary/mlx.core.stream.html @@ -8,7 +8,7 @@ -mlx.core.stream — MLX 0.29.2 documentation +mlx.core.stream — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.stream#
- -stream(s: Union[Stream, Device]) mlx.core.StreamContext# +stream(s: Union[Stream, Device]) mlx.core.StreamContext#
Create a context manager to set the default device and stream.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.subtract.html b/docs/build/html/python/_autosummary/mlx.core.subtract.html index dd1989bdd..ea9165ded 100644 --- a/docs/build/html/python/_autosummary/mlx.core.subtract.html +++ b/docs/build/html/python/_autosummary/mlx.core.subtract.html @@ -8,7 +8,7 @@ -
- -subtract(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array# +subtract(a: scalar | array, b: scalar | array, stream: None | Stream | Device = None) array#
Element-wise subtraction.
Subtract one array from another with numpy-style broadcasting semantics. Either or both input arrays can also be scalars.
diff --git a/docs/build/html/python/_autosummary/mlx.core.sum.html b/docs/build/html/python/_autosummary/mlx.core.sum.html index fbf3f690a..99eb55839 100644 --- a/docs/build/html/python/_autosummary/mlx.core.sum.html +++ b/docs/build/html/python/_autosummary/mlx.core.sum.html @@ -8,7 +8,7 @@ -mlx.core.sum — MLX 0.29.2 documentation +mlx.core.sum — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,16 +932,16 @@ document.write(`
mlx.core.sum#
- -sum(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array# +sum(a: array, /, axis: None | int | Sequence[int] = None, keepdims: bool = False, *, stream: None | Stream | Device = None) array#
Sum reduce the array over the given axes.
- Parameters:
a (array) – Input array.
-axis (int or list(int), optional) – Optional axis or axes to reduce over. If unspecified this defaults to reducing over the entire array.
-keepdims (bool, optional) – Keep reduced axes as +
keepdims (bool, optional) – Keep reduced axes as singleton dimensions, defaults to False.
diff --git a/docs/build/html/python/_autosummary/mlx.core.swapaxes.html b/docs/build/html/python/_autosummary/mlx.core.swapaxes.html
index 780a37f13..34bac06b1 100644
--- a/docs/build/html/python/_autosummary/mlx.core.swapaxes.html
+++ b/docs/build/html/python/_autosummary/mlx.core.swapaxes.html
@@ -8,7 +8,7 @@
- - -swapaxes(a: array, /, axis1: int, axis2: int, *, stream: None | Stream | Device = None) array# +swapaxes(a: array, /, axis1: int, axis2: int, *, stream: None | Stream | Device = None) array#
Swap two axes of an array.
- Parameters:
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.synchronize.html b/docs/build/html/python/_autosummary/mlx.core.synchronize.html index 45912ada0..63ecc4b3f 100644 --- a/docs/build/html/python/_autosummary/mlx.core.synchronize.html +++ b/docs/build/html/python/_autosummary/mlx.core.synchronize.html @@ -8,7 +8,7 @@ -
- -synchronize(stream: Optional[Stream] = None) None# +synchronize(stream: Optional[Stream] = None) None#
Synchronize with the given stream.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.take.html b/docs/build/html/python/_autosummary/mlx.core.take.html index 6dc55d84a..0bc218625 100644 --- a/docs/build/html/python/_autosummary/mlx.core.take.html +++ b/docs/build/html/python/_autosummary/mlx.core.take.html @@ -8,7 +8,7 @@ -
- -take(a: array, /, indices: int | array, axis: int | None = None, *, stream: None | Stream | Device = None) array# +take(a: array, /, indices: int | array, axis: int | None = None, *, stream: None | Stream | Device = None) array#
Take elements along an axis.
The elements are taken from
indicesalong the specified axis. If the axis is not specified the array is treated as a flattened @@ -942,8 +942,8 @@ If the axis is not specified the array is treated as a flattened- Parameters:
a (array) – Input array.
-indices (int or array) – Integer index or input array with integral type.
-axis (int, optional) – Axis along which to perform the take. If unspecified +
indices (int or array) – Integer index or input array with integral type.
+axis (int, optional) – Axis along which to perform the take. If unspecified the array is treated as a flattened 1-D vector.
diff --git a/docs/build/html/python/_autosummary/mlx.core.take_along_axis.html b/docs/build/html/python/_autosummary/mlx.core.take_along_axis.html
index 9784348f8..01109d071 100644
--- a/docs/build/html/python/_autosummary/mlx.core.take_along_axis.html
+++ b/docs/build/html/python/_autosummary/mlx.core.take_along_axis.html
@@ -8,7 +8,7 @@
- - -take_along_axis(a: array, /, indices: array, axis: int | None = None, *, stream: None | Stream | Device = None) array# +take_along_axis(a: array, /, indices: array, axis: int | None = None, *, stream: None | Stream | Device = None) array#
Take values along an axis at the specified indices.
- Parameters: @@ -940,7 +940,7 @@ document.write(`
a (array) – Input array.
indices (array) – Indices array. These should be broadcastable with the input array excluding the axis dimension.
axis (int or None) – Axis in the input to take the values from. If +
axis (int or None) – Axis in the input to take the values from. If
axis == Nonethe array is flattened to 1D prior to the indexing operation.mlx.core.tan — MLX 0.29.2 documentation +mlx.core.tan — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.tan#
- -tan(a: array, /, *, stream: None | Stream | Device = None) array# +tan(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise tangent.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.tanh.html b/docs/build/html/python/_autosummary/mlx.core.tanh.html index 8dfb359bc..a16185924 100644 --- a/docs/build/html/python/_autosummary/mlx.core.tanh.html +++ b/docs/build/html/python/_autosummary/mlx.core.tanh.html @@ -8,7 +8,7 @@ -
- -tanh(a: array, /, *, stream: None | Stream | Device = None) array# +tanh(a: array, /, *, stream: None | Stream | Device = None) array#
Element-wise hyperbolic tangent.
- Parameters: diff --git a/docs/build/html/python/_autosummary/mlx.core.tensordot.html b/docs/build/html/python/_autosummary/mlx.core.tensordot.html index f07c55d6e..8ff90536f 100644 --- a/docs/build/html/python/_autosummary/mlx.core.tensordot.html +++ b/docs/build/html/python/_autosummary/mlx.core.tensordot.html @@ -8,7 +8,7 @@ -
- -tensordot(a: array, b: array, /, axes: int | list[Sequence[int]] = 2, *, stream: None | Stream | Device = None) array# +tensordot(a: array, b: array, /, axes: int | list[Sequence[int]] = 2, *, stream: None | Stream | Device = None) array#
Compute the tensor dot product along the specified axes.
- Parameters:
a (array) – Input array
b (array) – Input array
-axes (int or list(list(int)), optional) – The number of dimensions to +
axes (int or list(list(int)), optional) – The number of dimensions to sum over. If an integer is provided, then sum over the last
axesdimensions ofaand the firstaxesdimensions ofb. If a list of lists is provided, then sum over the diff --git a/docs/build/html/python/_autosummary/mlx.core.tile.html b/docs/build/html/python/_autosummary/mlx.core.tile.html index 5bd57f9d2..d2d10f37a 100644 --- a/docs/build/html/python/_autosummary/mlx.core.tile.html +++ b/docs/build/html/python/_autosummary/mlx.core.tile.html @@ -8,7 +8,7 @@ -mlx.core.tile — MLX 0.29.2 documentation +mlx.core.tile — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.tile#
- -tile(a: array, reps: int | Sequence[int], /, *, stream: None | Stream | Device = None) array# +tile(a: array, reps: int | Sequence[int], /, *, stream: None | Stream | Device = None) array#
Construct an array by repeating
athe number of times given byreps.- Parameters:
- Returns: diff --git a/docs/build/html/python/_autosummary/mlx.core.topk.html b/docs/build/html/python/_autosummary/mlx.core.topk.html index 4a75f1ad0..0033804cc 100644 --- a/docs/build/html/python/_autosummary/mlx.core.topk.html +++ b/docs/build/html/python/_autosummary/mlx.core.topk.html @@ -8,7 +8,7 @@ -
- -topk(a: array, /, k: int, axis: None | int = -1, *, stream: None | Stream | Device = None) array# +topk(a: array, /, k: int, axis: None | int = -1, *, stream: None | Stream | Device = None) array#
Returns the
klargest elements from the input along a given axis.The elements will not necessarily be in sorted order.
- Parameters:
a (array) – Input array.
-k (int) –
ktop elements to be returned
-axis (int or None, optional) – Optional axis to select over. +
k (int) –
ktop elements to be returned
+axis (int or None, optional) – Optional axis to select over. If
None, this selects the topkelements over the flattened array. If unspecified, it defaults to-1.
mlx.core.trace — MLX 0.29.2 documentation +mlx.core.trace — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,17 +932,17 @@ document.write(`
mlx.core.trace#
- -trace(a: array, /, offset: int = 0, axis1: int = 0, axis2: int = 1, dtype: Dtype | None = None, *, stream: None | Stream | Device = None) array# +trace(a: array, /, offset: int = 0, axis1: int = 0, axis2: int = 1, dtype: Dtype | None = None, *, stream: None | Stream | Device = None) array#
Return the sum along a specified diagonal in the given array.
- Parameters:
a (array) – Input array
-offset (int, optional) – Offset of the diagonal from the main diagonal. +
offset (int, optional) – Offset of the diagonal from the main diagonal. Can be positive or negative. Default:
0.
-axis1 (int, optional) – The first axis of the 2-D sub-arrays from which +
axis1 (int, optional) – The first axis of the 2-D sub-arrays from which the diagonals should be taken. Default:
0.
-axis2 (int, optional) – The second axis of the 2-D sub-arrays from which +
axis2 (int, optional) – The second axis of the 2-D sub-arrays from which the diagonals should be taken. Default:
1.dtype (Dtype, optional) – Data type of the output array. If unspecified the output type is inferred from the input array.
diff --git a/docs/build/html/python/_autosummary/mlx.core.transpose.html b/docs/build/html/python/_autosummary/mlx.core.transpose.html
index b25f19398..67dabb84c 100644
--- a/docs/build/html/python/_autosummary/mlx.core.transpose.html
+++ b/docs/build/html/python/_autosummary/mlx.core.transpose.html
@@ -8,7 +8,7 @@
- - -transpose(a: array, /, axes: Sequence[int] | None = None, *, stream: None | Stream | Device = None) array# +transpose(a: array, /, axes: Sequence[int] | None = None, *, stream: None | Stream | Device = None) array#
Transpose the dimensions of the array.
- Parameters:
- diff --git a/docs/build/html/python/_autosummary/mlx.core.tri.html b/docs/build/html/python/_autosummary/mlx.core.tri.html index e40ab2981..8b21d8d77 100644 --- a/docs/build/html/python/_autosummary/mlx.core.tri.html +++ b/docs/build/html/python/_autosummary/mlx.core.tri.html @@ -8,7 +8,7 @@ -
- -tri(n: int, m: int, k: int, dtype: Dtype | None = None, *, stream: None | Stream | Device = None) array# +tri(n: int, m: int, k: int, dtype: Dtype | None = None, *, stream: None | Stream | Device = None) array#
An array with ones at and below the given diagonal and zeros elsewhere.
- Parameters:
-
-
n (int) – The number of rows in the output.
-m (int, optional) – The number of cols in the output. Defaults to
None.
-k (int, optional) – The diagonal of the 2-D array. Defaults to
0.
+n (int) – The number of rows in the output.
+m (int, optional) – The number of cols in the output. Defaults to
None.
+k (int, optional) – The diagonal of the 2-D array. Defaults to
0.dtype (Dtype, optional) – Data type of the output array. Defaults to
float32.stream (Stream, optional) – Stream or device. Defaults to
None.
mlx.core.tril — MLX 0.29.2 documentation +mlx.core.tril — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.tril#
- -tril(x: array, k: int, *, stream: None | Stream | Device = None) array# +tril(x: array, k: int, *, stream: None | Stream | Device = None) array#
Zeros the array above the given diagonal.
- Parameters:
- diff --git a/docs/build/html/python/_autosummary/mlx.core.triu.html b/docs/build/html/python/_autosummary/mlx.core.triu.html index 591dab501..857e8f67e 100644 --- a/docs/build/html/python/_autosummary/mlx.core.triu.html +++ b/docs/build/html/python/_autosummary/mlx.core.triu.html @@ -8,7 +8,7 @@ -
- -triu(x: array, k: int, *, stream: None | Stream | Device = None) array# +triu(x: array, k: int, *, stream: None | Stream | Device = None) array#
Zeros the array below the given diagonal.
- Parameters:
- diff --git a/docs/build/html/python/_autosummary/mlx.core.unflatten.html b/docs/build/html/python/_autosummary/mlx.core.unflatten.html index c6743947a..e178e2b1d 100644 --- a/docs/build/html/python/_autosummary/mlx.core.unflatten.html +++ b/docs/build/html/python/_autosummary/mlx.core.unflatten.html @@ -8,7 +8,7 @@ -
- -unflatten(a: array, /, axis: int, shape: Sequence[int], *, stream: None | Stream | Device = None) array# +unflatten(a: array, /, axis: int, shape: Sequence[int], *, stream: None | Stream | Device = None) array#
Unflatten an axis of an array to a shape.
- Parameters:
a (array) – Input array.
-axis (int) – The axis to unflatten.
-shape (tuple(int)) – The shape to unflatten to. At most one +
axis (int) – The axis to unflatten.
+shape (tuple(int)) – The shape to unflatten to. At most one entry can be
-1in which case the corresponding size will be inferred.stream (Stream, optional) – Stream or device. Defaults to
Nonediff --git a/docs/build/html/python/_autosummary/mlx.core.value_and_grad.html b/docs/build/html/python/_autosummary/mlx.core.value_and_grad.html index 1c004364c..d0667f4b2 100644 --- a/docs/build/html/python/_autosummary/mlx.core.value_and_grad.html +++ b/docs/build/html/python/_autosummary/mlx.core.value_and_grad.html @@ -8,7 +8,7 @@ -mlx.core.value_and_grad — MLX 0.29.2 documentation +mlx.core.value_and_grad — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.value_and_grad#
- -
mlx.core.unflatten — MLX 0.29.2 documentation +mlx.core.unflatten — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,14 +932,14 @@ document.write(`
mlx.core.unflatten#
mlx.core.triu — MLX 0.29.2 documentation +mlx.core.triu — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.triu#
mlx.core.tri — MLX 0.29.2 documentation +mlx.core.tri — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,14 +932,14 @@ document.write(`
mlx.core.tri#
mlx.core.transpose — MLX 0.29.2 documentation +mlx.core.transpose — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.transpose#
mlx.core.topk — MLX 0.29.2 documentation +mlx.core.topk — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,15 +932,15 @@ document.write(`
mlx.core.topk#
mlx.core.tensordot — MLX 0.29.2 documentation +mlx.core.tensordot — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,14 +932,14 @@ document.write(`
mlx.core.tensordot#
mlx.core.tanh — MLX 0.29.2 documentation +mlx.core.tanh — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.tanh#
mlx.core.take — MLX 0.29.2 documentation +mlx.core.take — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.take#
mlx.core.take_along_axis — MLX 0.29.2 documentation +mlx.core.take_along_axis — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.take_along_axis#
mlx.core.synchronize — MLX 0.29.2 documentation +mlx.core.synchronize — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.synchronize#
mlx.core.swapaxes — MLX 0.29.2 documentation +mlx.core.swapaxes — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,14 +932,14 @@ document.write(`
mlx.core.swapaxes#
mlx.core.subtract — MLX 0.29.2 documentation +mlx.core.subtract — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.subtract#
mlx.core.stop_gradient — MLX 0.29.2 documentation +mlx.core.stop_gradient — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.stop_gradient#
mlx.core.stack — MLX 0.29.2 documentation +mlx.core.stack — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.stack#
mlx.core.squeeze — MLX 0.29.2 documentation +mlx.core.squeeze — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,13 +932,13 @@ document.write(`
mlx.core.squeeze#
mlx.core.square — MLX 0.29.2 documentation +mlx.core.square — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.square#
mlx.core.slice_update — MLX 0.29.2 documentation +mlx.core.slice_update — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.slice_update#
mlx.core.softmax — MLX 0.29.2 documentation +mlx.core.softmax — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.softmax#
mlx.core.slice — MLX 0.29.2 documentation +mlx.core.slice — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,15 +932,15 @@ document.write(`
mlx.core.slice#
mlx.core.sinh — MLX 0.29.2 documentation +mlx.core.sinh — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.sinh#
mlx.core.sin — MLX 0.29.2 documentation +mlx.core.sin — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.sin#
mlx.core.savez — MLX 0.29.2 documentation +mlx.core.savez — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.savez#
mlx.core.random.bernoulli — MLX 0.29.2 documentation +mlx.core.random.bernoulli — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,17 +932,17 @@ document.write(`
mlx.core.random.bernoulli#
mlx.core.put_along_axis — MLX 0.29.2 documentation +mlx.core.put_along_axis — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.put_along_axis#
Notes
diff --git a/docs/build/html/python/_autosummary/mlx.core.quantized_matmul.html b/docs/build/html/python/_autosummary/mlx.core.quantized_matmul.html index f00880ea4..856d0aad8 100644 --- a/docs/build/html/python/_autosummary/mlx.core.quantized_matmul.html +++ b/docs/build/html/python/_autosummary/mlx.core.quantized_matmul.html @@ -8,7 +8,7 @@ -mlx.core.quantized_matmul — MLX 0.29.2 documentation +mlx.core.quantized_matmul — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.quantized_matmul#
mlx.core.radians — MLX 0.29.2 documentation +mlx.core.radians — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.radians#
mlx.core.linalg.solve_triangular — MLX 0.29.2 documentation +mlx.core.linalg.solve_triangular — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,14 +932,14 @@ document.write(`
mlx.core.linalg.solve_triangular#
mlx.core.linalg.pinv — MLX 0.29.2 documentation +mlx.core.linalg.pinv — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.linalg.pinv#
mlx.core.left_shift — MLX 0.29.2 documentation +mlx.core.left_shift — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.left_shift#
mlx.core.isposinf — MLX 0.29.2 documentation +mlx.core.isposinf — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.isposinf#
mlx.core.kron — MLX 0.29.2 documentation +mlx.core.kron — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.kron#
mlx.core.isneginf — MLX 0.29.2 documentation +mlx.core.isneginf — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.isneginf#
mlx.core.isnan — MLX 0.29.2 documentation +mlx.core.isnan — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.isnan#
mlx.core.isinf — MLX 0.29.2 documentation +mlx.core.isinf — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.isinf#
mlx.core.isclose — MLX 0.29.2 documentation +mlx.core.isclose — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.isclose#
mlx.core.import_function — MLX 0.29.2 documentation +mlx.core.import_function — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.import_function#
- The input is expected to be at least 3D with shape
mlx.core.fast.rms_norm — MLX 0.29.2 documentation +mlx.core.fast.rms_norm — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.fast.rms_norm#
mlx.core.fast.rope — MLX 0.29.2 documentation +mlx.core.fast.rope — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.fast.rope#
mlx.core.bitwise_or — MLX 0.29.2 documentation +mlx.core.bitwise_or — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.bitwise_or#
mlx.core.array.at — MLX 0.29.2 documentation +mlx.core.array.at — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.array.conj.html b/docs/build/html/python/_autosummary/mlx.core.array.conj.html
index 09f5dcb41..84a547617 100644
--- a/docs/build/html/python/_autosummary/mlx.core.array.conj.html
+++ b/docs/build/html/python/_autosummary/mlx.core.array.conj.html
@@ -8,7 +8,7 @@
- mlx.core.array.conj — MLX 0.29.2 documentation +mlx.core.array.conj — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.conj#
mlx.core.array.cos — MLX 0.29.2 documentation +mlx.core.array.cos — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.cos#
mlx.core.array.cummax — MLX 0.29.2 documentation +mlx.core.array.cummax — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.cummax#
mlx.core.array.cummin — MLX 0.29.2 documentation +mlx.core.array.cummin — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.cummin#
mlx.core.array.cumprod — MLX 0.29.2 documentation +mlx.core.array.cumprod — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.cumprod#
mlx.core.array.cumsum — MLX 0.29.2 documentation +mlx.core.array.cumsum — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.cumsum#
mlx.core.array.diag — MLX 0.29.2 documentation +mlx.core.array.diag — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.diag#
mlx.core.array.diagonal — MLX 0.29.2 documentation +mlx.core.array.diagonal — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.diagonal#
mlx.core.array.dtype — MLX 0.29.2 documentation +mlx.core.array.dtype — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
diff --git a/docs/build/html/python/_autosummary/mlx.core.array.exp.html b/docs/build/html/python/_autosummary/mlx.core.array.exp.html
index a7590e6e9..ab4981212 100644
--- a/docs/build/html/python/_autosummary/mlx.core.array.exp.html
+++ b/docs/build/html/python/_autosummary/mlx.core.array.exp.html
@@ -8,7 +8,7 @@
- mlx.core.array.exp — MLX 0.29.2 documentation +mlx.core.array.exp — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.exp#
mlx.core.array.flatten — MLX 0.29.2 documentation +mlx.core.array.flatten — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.array.flatten#
mlx.core.array — MLX 0.29.2 documentation +mlx.core.array — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -939,7 +939,7 @@ document.write(`
mlx.core.argpartition — MLX 0.29.2 documentation +mlx.core.argpartition — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.argpartition#
mlx.core.argmin — MLX 0.29.2 documentation +mlx.core.argmin — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,15 +932,15 @@ document.write(`
mlx.core.argmin#
mlx.core.argmax — MLX 0.29.2 documentation +mlx.core.argmax — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,15 +932,15 @@ document.write(`
mlx.core.argmax#
mlx.core.arctanh — MLX 0.29.2 documentation +mlx.core.arctanh — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.arctanh#
mlx.core.arctan2 — MLX 0.29.2 documentation +mlx.core.arctan2 — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.arctan2#
mlx.core.arctan — MLX 0.29.2 documentation +mlx.core.arctan — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.arctan#
mlx.core.arcsinh — MLX 0.29.2 documentation +mlx.core.arcsinh — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.arcsinh#
mlx.core.arcsin — MLX 0.29.2 documentation +mlx.core.arcsin — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.arcsin#
mlx.core.arccosh — MLX 0.29.2 documentation +mlx.core.arccosh — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.arccosh#
mlx.core.arange — MLX 0.29.2 documentation +mlx.core.arange — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,9 +932,9 @@ document.write(`
mlx.core.arange#
mlx.core.allclose — MLX 0.29.2 documentation +mlx.core.allclose — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.allclose#
mlx.core.all — MLX 0.29.2 documentation +mlx.core.all — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,16 +932,16 @@ document.write(`
mlx.core.all#
mlx.core.add — MLX 0.29.2 documentation +mlx.core.add — MLX 0.29.3 documentation @@ -37,7 +37,7 @@ - + @@ -140,8 +140,8 @@ -
-
+
+
@@ -932,7 +932,7 @@ document.write(`
mlx.core.add#