!23741 fix fft3d/ifft3d doc api

Merge pull request !23741 from 杨林枫/code_docs_fix_ops_api
This commit is contained in:
i-robot 2021-09-22 03:08:35 +00:00 committed by Gitee
commit 85384ae51b
1 changed files with 10 additions and 6 deletions

View File

@ -2966,11 +2966,12 @@ class FFT3D(PrimitiveWithInfer):
This is an experimental prototype that is subject to change and/or deletion.
Inputs:
- **input_tensor** (Tensor, float32) - [fftx, ffty, fftz]
- **input_tensor** (Tensor) - Three dimensional tensor, supported
data type is float32.
Outputs:
- **output_tensor** (complex64) - The real part of the output tensor after
undergoing fast Fourier transform.
- **output_tensor** (Tensor) - The tensor after undergoing fast Fourier
transform, the data type is complex64.
Supported Platforms:
``GPU``
@ -2992,6 +2993,7 @@ class FFT3D(PrimitiveWithInfer):
validator.check_tensor_dtype_valid('input_tensor', input_dtype, [mstype.float32], self.name)
return mstype.complex64
class IFFT3D(PrimitiveWithInfer):
"""
Inverse FFT with Three-Dimensional Input.
@ -3000,11 +3002,12 @@ class IFFT3D(PrimitiveWithInfer):
This is an experimental prototype that is subject to change and/or deletion.
Inputs:
- **input_tensor** (Tensor, complex64) - [fftx, ffty, fftz]
- **input_tensor** (Tensor) - Three dimensional input tensor, supported data
type is complex64.
Outputs:
- **output_tensor** (float32) - returns the tensor after undergoing
inverse Fourier transform.
- **output_tensor** (Tensor) - Returns the tensor after undergoing
inverse Fourier transform, the data type is float32.
Supported Platforms:
``GPU``
@ -3026,6 +3029,7 @@ class IFFT3D(PrimitiveWithInfer):
validator.check_tensor_dtype_valid('input_tensor', input_dtype, [mstype.complex64], self.name)
return mstype.float32
class NeighborListUpdate(PrimitiveWithInfer):
"""
Update (or construct if first time) the Verlet neighbor list for the