zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-06-24 17:31:16 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clarify dimension notation in conv1d, conv2d, and conv3d docstrings (#2123)

Browse Source 
* Clarify dimension notation in conv1d, conv2d, and conv3d docstrings

* Updating transposed convs in conv1d, conv2d, and conv3d

---------

Co-authored-by: Sai Charan Arvapally <saicharan@Sais-MacBook-Pro.local>
This commit is contained in:
charan-003 2025-04-25 13:18:30 -06:00 committed by GitHub
parent 6b2d5448f2
commit 99b9868859
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
python/src/ops.cpp
View File

@ -3455,8 +3455,8 @@ void init_ops(nb::module_& m) {
1D convolution over an input with several channels 1D convolution over an input with several channels
Args: Args:
input (array): Input array of shape ``(N, H, C_in)``. input (array): Input array of shape ``(N, L, C_in)``.
weight (array): Weight array of shape ``(C_out, H, C_in)``. weight (array): Weight array of shape ``(C_out, K, C_in)``.
stride (int, optional): Kernel stride. Default: ``1``. stride (int, optional): Kernel stride. Default: ``1``.
padding (int, optional): Input padding. Default: ``0``. padding (int, optional): Input padding. Default: ``0``.
dilation (int, optional): Kernel dilation. Default: ``1``. dilation (int, optional): Kernel dilation. Default: ``1``.
@ -3514,7 +3514,7 @@ void init_ops(nb::module_& m) {
Args: Args:
input (array): Input array of shape ``(N, H, W, C_in)``. input (array): Input array of shape ``(N, H, W, C_in)``.
weight (array): Weight array of shape ``(C_out, H, W, C_in)``. weight (array): Weight array of shape ``(C_out, KH, KW, C_in)``.
stride (int or tuple(int), optional): :obj:`tuple` of size 2 with stride (int or tuple(int), optional): :obj:`tuple` of size 2 with
kernel strides. All spatial dimensions get the same stride if kernel strides. All spatial dimensions get the same stride if
only one number is specified. Default: ``1``. only one number is specified. Default: ``1``.
@ -3586,7 +3586,7 @@ void init_ops(nb::module_& m) {
Args: Args:
input (array): Input array of shape ``(N, D, H, W, C_in)``. input (array): Input array of shape ``(N, D, H, W, C_in)``.
weight (array): Weight array of shape ``(C_out, D, H, W, C_in)``. weight (array): Weight array of shape ``(C_out, KD, KH, KW, C_in)``.
stride (int or tuple(int), optional): :obj:`tuple` of size 3 with stride (int or tuple(int), optional): :obj:`tuple` of size 3 with
kernel strides. All spatial dimensions get the same stride if kernel strides. All spatial dimensions get the same stride if
only one number is specified. Default: ``1``. only one number is specified. Default: ``1``.
@ -3619,8 +3619,8 @@ void init_ops(nb::module_& m) {
1D transposed convolution over an input with several channels 1D transposed convolution over an input with several channels
Args: Args:
input (array): Input array of shape ``(N, H, C_in)``. input (array): Input array of shape ``(N, L, C_in)``.
weight (array): Weight array of shape ``(C_out, H, C_in)``. weight (array): Weight array of shape ``(C_out, K, C_in)``.
stride (int, optional): Kernel stride. Default: ``1``. stride (int, optional): Kernel stride. Default: ``1``.
padding (int, optional): Input padding. Default: ``0``. padding (int, optional): Input padding. Default: ``0``.
dilation (int, optional): Kernel dilation. Default: ``1``. dilation (int, optional): Kernel dilation. Default: ``1``.
@ -3697,7 +3697,7 @@ void init_ops(nb::module_& m) {
Args: Args:
input (array): Input array of shape ``(N, H, W, C_in)``. input (array): Input array of shape ``(N, H, W, C_in)``.
weight (array): Weight array of shape ``(C_out, H, W, C_in)``. weight (array): Weight array of shape ``(C_out, KH, KW, C_in)``.
stride (int or tuple(int), optional): :obj:`tuple` of size 2 with stride (int or tuple(int), optional): :obj:`tuple` of size 2 with
kernel strides. All spatial dimensions get the same stride if kernel strides. All spatial dimensions get the same stride if
only one number is specified. Default: ``1``. only one number is specified. Default: ``1``.
@ -3783,7 +3783,7 @@ void init_ops(nb::module_& m) {
Args: Args:
input (array): Input array of shape ``(N, D, H, W, C_in)``. input (array): Input array of shape ``(N, D, H, W, C_in)``.
weight (array): Weight array of shape ``(C_out, D, H, W, C_in)``. weight (array): Weight array of shape ``(C_out, KD, KH, KW, C_in)``.
stride (int or tuple(int), optional): :obj:`tuple` of size 3 with stride (int or tuple(int), optional): :obj:`tuple` of size 3 with
kernel strides. All spatial dimensions get the same stride if kernel strides. All spatial dimensions get the same stride if
only one number is specified. Default: ``1``. only one number is specified. Default: ``1``.