mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-24 17:31:16 +08:00
Fix docstring for correctly rendering (#820)
This commit is contained in:
parent
8b7532b9ab
commit
ffb19df3c0
@ -125,7 +125,7 @@ void init_ops(py::module_& m) {
|
|||||||
Args:
|
Args:
|
||||||
a (array): Input array.
|
a (array): Input array.
|
||||||
axis (int or tuple(int), optional): Axes to remove. Defaults
|
axis (int or tuple(int), optional): Axes to remove. Defaults
|
||||||
to ``None`` in which case all size one axes are removed.
|
to ``None`` in which case all size one axes are removed.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
array: The output array with size one axes removed.
|
array: The output array with size one axes removed.
|
||||||
@ -1324,7 +1324,7 @@ void init_ops(py::module_& m) {
|
|||||||
stop (scalar): Stopping 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,
|
dtype (Dtype, optional): Specifies the data type of the output,
|
||||||
default to ``float32``.
|
default to ``float32``.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
array: The range of values.
|
array: The range of values.
|
||||||
@ -1622,15 +1622,15 @@ void init_ops(py::module_& m) {
|
|||||||
R"pbdoc(
|
R"pbdoc(
|
||||||
tril(x: array, k: int, *, stream: Union[None, Stream, Device] = None) -> array
|
tril(x: array, k: int, *, stream: Union[None, Stream, Device] = None) -> array
|
||||||
|
|
||||||
Zeros the array above the given diagonal.
|
Zeros the array above the given diagonal.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
x (array): input array.
|
x (array): input array.
|
||||||
k (int, optional): The diagonal of the 2-D array. Defaults to ``0``.
|
k (int, optional): The diagonal of the 2-D array. Defaults to ``0``.
|
||||||
stream (Stream, optional): Stream or device. Defaults to ``None``.
|
stream (Stream, optional): Stream or device. Defaults to ``None``.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
array: Array zeroed above the given diagonal
|
array: Array zeroed above the given diagonal
|
||||||
)pbdoc");
|
)pbdoc");
|
||||||
m.def(
|
m.def(
|
||||||
"triu",
|
"triu",
|
||||||
|
Loading…
Reference in New Issue
Block a user