提交 dab7a1ed authored 作者: Mathieu Germain's avatar Mathieu Germain

Fix docstring in old backend

上级 42a4e9ef
...@@ -295,10 +295,8 @@ class GpuDnnConv(DnnBase, COp): ...@@ -295,10 +295,8 @@ class GpuDnnConv(DnnBase, COp):
The convolution descriptor. The convolution descriptor.
workmem workmem
*deprecated*, use parameter algo instead. *deprecated*, use parameter algo instead.
algo algo : {'none', 'small', 'large', 'fft', 'fft_tiling', 'guess_once', 'winograd',
['none', 'small', 'large', 'fft', 'fft_tiling', 'guess_once', 'winograd', 'guess_on_shape_change', 'time_once', 'time_on_shape_change'}
'guess_on_shape_change', 'time_once', 'time_on_shape_change']
Default is the value of :attr:`config.dnn.conv.algo_fwd`. Default is the value of :attr:`config.dnn.conv.algo_fwd`.
""" """
...@@ -481,17 +479,20 @@ class GpuDnnConv3d(GpuDnnConv): ...@@ -481,17 +479,20 @@ class GpuDnnConv3d(GpuDnnConv):
""" """
The forward convolution. The forward convolution.
:param image: Parameters
:param kernel: ----------
:param descr: the convolution descriptor image
:param workmem: kernel
descr
The convolution descriptor
workmem
*deprecated*, use parameter algo instead. *deprecated*, use parameter algo instead.
:param algo: ['none', 'small', 'fft_tiling', 'winograd', algo : {'none', 'small', 'fft_tiling', 'winograd', 'guess_once',
'guess_once', 'guess_on_shape_change', 'guess_on_shape_change', 'time_once', 'time_on_shape_change'}
'time_once', 'time_on_shape_change']
Default is the value of :attr:`config.dnn.conv.algo_fwd`. Default is the value of :attr:`config.dnn.conv.algo_fwd`.
""" """
__props__ = ('algo', 'inplace') __props__ = ('algo', 'inplace')
__input_name__ = ('image', 'kernel', 'output', __input_name__ = ('image', 'kernel', 'output',
'descriptor', 'alpha', 'beta') 'descriptor', 'alpha', 'beta')
...@@ -584,7 +585,8 @@ class GpuDnnConvGradW(DnnBase, COp): ...@@ -584,7 +585,8 @@ class GpuDnnConvGradW(DnnBase, COp):
The convolution descriptor. The convolution descriptor.
workmem workmem
*deprecated*, use parameter algo instead. *deprecated*, use parameter algo instead.
algo : {'none', 'deterministic', 'fft', 'small', 'guess_once', 'guess_on_shape_change', 'time_once', 'time_on_shape_change'} algo : {'none', 'deterministic', 'fft', 'small', 'guess_once',
'guess_on_shape_change', 'time_once', 'time_on_shape_change'}
Default is the value of :attr:`config.dnn.conv.algo_bwd_filter`. Default is the value of :attr:`config.dnn.conv.algo_bwd_filter`.
""" """
...@@ -719,17 +721,20 @@ class GpuDnnConv3dGradW(GpuDnnConvGradW): ...@@ -719,17 +721,20 @@ class GpuDnnConv3dGradW(GpuDnnConvGradW):
""" """
The convolution gradient with respect to the weights. The convolution gradient with respect to the weights.
:param image: Parameters
:param kernel: ----------
:param descr: the convolution descriptor image
:param workmem: kernel
descr
The convolution descriptor
workmem
*deprecated*, use parameter algo instead. *deprecated*, use parameter algo instead.
:param algo: ['none', 'small', algo : {'none', 'small', 'guess_once', 'guess_on_shape_change',
'guess_once', 'guess_on_shape_change', 'time_once', 'time_on_shape_change'}
'time_once', 'time_on_shape_change']
Default is the value of :attr:`config.dnn.conv.algo_bwd_filter`. Default is the value of :attr:`config.dnn.conv.algo_bwd_filter`.
""" """
__props__ = ('algo', 'inplace',) __props__ = ('algo', 'inplace',)
__input_name__ = ('image', 'grad', 'output', 'descriptor', 'alpha', 'beta') __input_name__ = ('image', 'grad', 'output', 'descriptor', 'alpha', 'beta')
...@@ -801,10 +806,8 @@ class GpuDnnConvGradI(DnnBase, COp): ...@@ -801,10 +806,8 @@ class GpuDnnConvGradI(DnnBase, COp):
The convolution descriptor. The convolution descriptor.
workmem workmem
*deprecated*, use parameter algo instead. *deprecated*, use parameter algo instead.
algo algo : {'none', 'deterministic', 'fft', 'fft_tiling', 'winograd', 'guess_once',
['none', 'deterministic', 'fft', 'fft_tiling', 'winograd', 'guess_once', 'guess_on_shape_change', 'time_once', 'time_on_shape_change'}
'guess_on_shape_change', 'time_once', 'time_on_shape_change']
Default is the value of :attr:`config.dnn.conv.algo_bwd_data`. Default is the value of :attr:`config.dnn.conv.algo_bwd_data`.
""" """
...@@ -956,17 +959,20 @@ class GpuDnnConv3dGradI(GpuDnnConvGradI): ...@@ -956,17 +959,20 @@ class GpuDnnConv3dGradI(GpuDnnConvGradI):
""" """
The convolution gradient with respect to the inputs. The convolution gradient with respect to the inputs.
:param image: Parameters
:param kernel: ----------
:param descr: the convolution descriptor image
:param workmem: kernel
descr
The convolution descriptor
workmem
*deprecated*, use parameter algo instead. *deprecated*, use parameter algo instead.
:param algo: ['none', 'deterministic, 'fft_tiling', 'winograd', 'guess_once', algo : {'none', 'deterministic, 'fft_tiling', 'winograd', 'guess_once',
'guess_on_shape_change', 'time_once', 'time_on_shape_change'] 'guess_on_shape_change', 'time_once', 'time_on_shape_change'}
Default is the value of :attr:`config.dnn.conv.algo_bwd_data`. Default is the value of :attr:`config.dnn.conv.algo_bwd_data`.
""" """
__props__ = ('algo', 'inplace',) __props__ = ('algo', 'inplace',)
__input_name__ = ('kernel', 'grad', 'output', 'descriptor', 'alpha', __input_name__ = ('kernel', 'grad', 'output', 'descriptor', 'alpha',
'beta') 'beta')
...@@ -1455,6 +1461,7 @@ class GpuDnnPool(DnnBase): ...@@ -1455,6 +1461,7 @@ class GpuDnnPool(DnnBase):
(padX, padY) padding information. (padX, padY) padding information.
padX is the size of the left and right borders, padX is the size of the left and right borders,
padY is the size of the top and bottom borders. padY is the size of the top and bottom borders.
""" """
__props__ = ("mode",) __props__ = ("mode",)
...@@ -1974,14 +1981,12 @@ class GpuDnnSoftmaxBase(DnnBase): ...@@ -1974,14 +1981,12 @@ class GpuDnnSoftmaxBase(DnnBase):
---------- ----------
tensor_format tensor_format
Always set this to 'bc01'. Always set this to 'bc01'.
algo algo : {'fast', 'accurate', 'log'}
'fast', 'accurate' or 'log' indicating whether, respectively, computations Indicating whether, respectively, computations should be optimized for
should be optimized for speed, for accuracy, or if CuDNN should rather speed, for accuracy, or if CuDNN should rather compute the log-softmax instead.
compute the log-softmax instead. mode : {'instance', 'channel'}
mode Indicating whether the softmax should be computed per image across 'c01'
'instance' or 'channel' indicating whether the softmax should or per spatial location '01' per image across 'c'.
be computed per image across 'c01' or per spatial location '01' per
image across 'c'.
""" """
...@@ -2137,13 +2142,12 @@ class GpuDnnSoftmax(GpuDnnSoftmaxBase): ...@@ -2137,13 +2142,12 @@ class GpuDnnSoftmax(GpuDnnSoftmaxBase):
---------- ----------
tensor_format tensor_format
Always set to 'bc01'. Always set to 'bc01'.
algo algo : {'fast', 'accurate'}
'fast' or 'accurate' indicating whether computations should be Indicating whether computations should be
optimized for speed or accuracy respectively. optimized for speed or accuracy respectively.
mode mode : {'instance', 'channel'}
'instance' or 'channel' indicating whether the softmax should Indicating whether the softmax should be computed per image across 'c01'
be computed per image across 'c01' or per spatial location '01' per or per spatial location '01' per image across 'c'.
image across 'c'.
""" """
...@@ -2205,13 +2209,12 @@ class GpuDnnSoftmaxGrad(GpuDnnSoftmaxBase): ...@@ -2205,13 +2209,12 @@ class GpuDnnSoftmaxGrad(GpuDnnSoftmaxBase):
---------- ----------
tensor_format tensor_format
Always set to 'bc01'. Always set to 'bc01'.
algo algo : {'fast', 'accurate'}
'fast' or 'accurate' indicating whether computations should be Indicating whether computations should be
optimized for speed or accuracy respectively. optimized for speed or accuracy respectively.
mode mode : {'instance', 'channel'}
'instance' or 'channel' indicating whether the softmax should Indicating whether the softmax should be computed per image across 'c01'
be computed per image across 'c01' or per spatial location '01' per or per spatial location '01' per image across 'c'.
image across 'c'.
""" """
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论