Commit 99303143 authored by Sean Kim's avatar Sean Kim Committed by Facebook GitHub Bot
Browse files

Docstring change for Hybrid Demucs (#2542)

Summary:
Small edit to docstring for kernel

Pull Request resolved: https://github.com/pytorch/audio/pull/2542

Reviewed By: carolineechen

Differential Revision: D37797937

Pulled By: skim0514

fbshipit-source-id: 4bdd1e3ddb49cbdf2bd5367edb03cf9603d4ec6e
parent 4ba56323
...@@ -84,7 +84,7 @@ class _HEncLayer(torch.nn.Module): ...@@ -84,7 +84,7 @@ class _HEncLayer(torch.nn.Module):
freq (bool, optional): boolean for whether conv layer is for frequency domain (Default: ``True``) freq (bool, optional): boolean for whether conv layer is for frequency domain (Default: ``True``)
norm_type (string, optional): Norm type, either ``group_norm `` or ``none`` (Default: ``group_norm``) norm_type (string, optional): Norm type, either ``group_norm `` or ``none`` (Default: ``group_norm``)
context (int, optional): context size for the 1x1 conv. (Default: 0) context (int, optional): context size for the 1x1 conv. (Default: 0)
dconv_kw (Dict[str, Any] , optional): dictionary of kwargs for the DConv class. (Default: ``None``) dconv_kw (Dict[str, Any] or None, optional): dictionary of kwargs for the DConv class. (Default: ``None``)
pad (bool, optional): true to pad the input. Padding is done so that the output size is pad (bool, optional): true to pad the input. Padding is done so that the output size is
always the input size / stride. (Default: ``True``) always the input size / stride. (Default: ``True``)
""" """
...@@ -100,7 +100,7 @@ class _HEncLayer(torch.nn.Module): ...@@ -100,7 +100,7 @@ class _HEncLayer(torch.nn.Module):
freq: bool = True, freq: bool = True,
norm_type: str = "group_norm", norm_type: str = "group_norm",
context: int = 0, context: int = 0,
dconv_kw: Dict[str, Any] = None, dconv_kw: Optional[Dict[str, Any]] = None,
pad: bool = True, pad: bool = True,
): ):
super().__init__() super().__init__()
...@@ -193,7 +193,7 @@ class _HDecLayer(torch.nn.Module): ...@@ -193,7 +193,7 @@ class _HDecLayer(torch.nn.Module):
freq (bool, optional): boolean for whether conv layer is for frequency (Default: ``True``) freq (bool, optional): boolean for whether conv layer is for frequency (Default: ``True``)
norm_type (str, optional): Norm type, either ``group_norm `` or ``none`` (Default: ``group_norm``) norm_type (str, optional): Norm type, either ``group_norm `` or ``none`` (Default: ``group_norm``)
context (int, optional): context size for the 1x1 conv. (Default: 1) context (int, optional): context size for the 1x1 conv. (Default: 1)
dconv_kw (Dict[str, Any] , optional): dictionary of kwargs for the DConv class. (Default: ``None``) dconv_kw (Dict[str, Any] or None, optional): dictionary of kwargs for the DConv class. (Default: ``None``)
pad (bool, optional): true to pad the input. Padding is done so that the output size is pad (bool, optional): true to pad the input. Padding is done so that the output size is
always the input size / stride. (Default: ``True``) always the input size / stride. (Default: ``True``)
""" """
...@@ -210,7 +210,7 @@ class _HDecLayer(torch.nn.Module): ...@@ -210,7 +210,7 @@ class _HDecLayer(torch.nn.Module):
freq: bool = True, freq: bool = True,
norm_type: str = "group_norm", norm_type: str = "group_norm",
context: int = 1, context: int = 1,
dconv_kw: Dict[str, Any] = None, dconv_kw: Optional[Dict[str, Any]] = None,
pad: bool = True, pad: bool = True,
): ):
super().__init__() super().__init__()
......
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