Unverified Commit 1290bdd1 authored by Jintao Lin's avatar Jintao Lin Committed by GitHub
Browse files

update docstring (#651)

parent c390e327
...@@ -26,13 +26,20 @@ class ConvModule(nn.Module): ...@@ -26,13 +26,20 @@ class ConvModule(nn.Module):
supports zero and circular padding, and we add "reflect" padding mode. supports zero and circular padding, and we add "reflect" padding mode.
Args: Args:
in_channels (int): Same as nn.Conv2d. in_channels (int): Number of channels in the input feature map.
out_channels (int): Same as nn.Conv2d. Same as that in ``nn._ConvNd``.
kernel_size (int | tuple[int]): Same as nn.Conv2d. out_channels (int): Number of channels produced by the convolution.
stride (int | tuple[int]): Same as nn.Conv2d. Same as that in ``nn._ConvNd``.
padding (int | tuple[int]): Same as nn.Conv2d. kernel_size (int | tuple[int]): Size of the convolving kernel.
dilation (int | tuple[int]): Same as nn.Conv2d. Same as that in ``nn._ConvNd``.
groups (int): Same as nn.Conv2d. stride (int | tuple[int]): Stride of the convolution.
Same as that in ``nn._ConvNd``.
padding (int | tuple[int]): Zero-padding added to both sides of
the input. Same as that in ``nn._ConvNd``.
dilation (int | tuple[int]): Spacing between kernel elements.
Same as that in ``nn._ConvNd``.
groups (int): Number of blocked connections from input channels to
output channels. Same as that in ``nn._ConvNd``.
bias (bool | str): If specified as `auto`, it will be decided by the bias (bool | str): If specified as `auto`, it will be decided by the
norm_cfg. Bias will be set as True if `norm_cfg` is None, otherwise norm_cfg. Bias will be set as True if `norm_cfg` is None, otherwise
False. Default: "auto". False. Default: "auto".
......
...@@ -16,12 +16,18 @@ class DepthwiseSeparableConvModule(nn.Module): ...@@ -16,12 +16,18 @@ class DepthwiseSeparableConvModule(nn.Module):
if `norm_cfg` and `act_cfg` are specified. if `norm_cfg` and `act_cfg` are specified.
Args: Args:
in_channels (int): Same as nn.Conv2d. in_channels (int): Number of channels in the input feature map.
out_channels (int): Same as nn.Conv2d. Same as that in ``nn._ConvNd``.
kernel_size (int or tuple[int]): Same as nn.Conv2d. out_channels (int): Number of channels produced by the convolution.
stride (int or tuple[int]): Same as nn.Conv2d. Default: 1. Same as that in ``nn._ConvNd``.
padding (int or tuple[int]): Same as nn.Conv2d. Default: 0. kernel_size (int | tuple[int]): Size of the convolving kernel.
dilation (int or tuple[int]): Same as nn.Conv2d. Default: 1. Same as that in ``nn._ConvNd``.
stride (int | tuple[int]): Stride of the convolution.
Same as that in ``nn._ConvNd``. Default: 1.
padding (int | tuple[int]): Zero-padding added to both sides of
the input. Same as that in ``nn._ConvNd``. Default: 0.
dilation (int | tuple[int]): Spacing between kernel elements.
Same as that in ``nn._ConvNd``. Default: 1.
norm_cfg (dict): Default norm config for both depthwise ConvModule and norm_cfg (dict): Default norm config for both depthwise ConvModule and
pointwise ConvModule. Default: None. pointwise ConvModule. Default: None.
act_cfg (dict): Default activation config for both depthwise ConvModule act_cfg (dict): Default activation config for both depthwise ConvModule
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment