未验证 提交 ac03d353 编写于 作者: 陈沧夜 提交者: GitHub

修改docs对应的英文注释synchronize函数等 (#49428)

* 修改英文注释synchronize

* 修改英文注释synchronize;test=document_fix

* test=document_fix

* test=document_fix

* test=document_fix

* 修改hfftn的注释错误;test=document_fix

* test=document_fix
上级 e647ac00
...@@ -48,12 +48,12 @@ def current_stream(device=None): ...@@ -48,12 +48,12 @@ def current_stream(device=None):
''' '''
Return the current CUDA stream by the device. Return the current CUDA stream by the device.
Parameters: Args:
device(paddle.CUDAPlace()|int, optional): The device or the ID of the device which want to get stream from. device(paddle.CUDAPlace()|int, optional): The device or the ID of the device which want to get stream from.
If device is None, the device is the current device. Default: None. If device is None, the device is the current device. Default: None.
Returns: Returns:
CUDAStream: the stream to the device. CUDAStream: the stream to the device.
Examples: Examples:
.. code-block:: python .. code-block:: python
...@@ -92,9 +92,9 @@ def synchronize(device=None): ...@@ -92,9 +92,9 @@ def synchronize(device=None):
''' '''
Wait for the compute on the given CUDA device to finish. Wait for the compute on the given CUDA device to finish.
Parameters: Args:
device(paddle.CUDAPlace()|int, optional): The device or the ID of the device. device(paddle.CUDAPlace()|int, optional): The device or the ID of the device.
If device is None, the device is the current device. Default: None. If device is None, the device is the current device. Default: None.
Examples: Examples:
.. code-block:: python .. code-block:: python
...@@ -287,7 +287,7 @@ def memory_allocated(device=None): ...@@ -287,7 +287,7 @@ def memory_allocated(device=None):
For instance, a float32 tensor with shape [1] in GPU will take up 256 bytes memory, even though storing a float32 data requires only 4 bytes. For instance, a float32 tensor with shape [1] in GPU will take up 256 bytes memory, even though storing a float32 data requires only 4 bytes.
Args: Args:
device(paddle.CUDAPlace or int or str): The device, the id of the device or device(paddle.CUDAPlace or int or str, optional): The device, the id of the device or
the string name of device like 'gpu:x'. If device is None, the device is the current device. the string name of device like 'gpu:x'. If device is None, the device is the current device.
Default: None. Default: None.
...@@ -318,7 +318,7 @@ def memory_reserved(device=None): ...@@ -318,7 +318,7 @@ def memory_reserved(device=None):
Return the current size of GPU memory that is held by the allocator of the given device. Return the current size of GPU memory that is held by the allocator of the given device.
Args: Args:
device(paddle.CUDAPlace or int or str): The device, the id of the device or device(paddle.CUDAPlace or int or str, optional): The device, the id of the device or
the string name of device like 'gpu:x'. If device is None, the device is the current device. the string name of device like 'gpu:x'. If device is None, the device is the current device.
Default: None. Default: None.
......
...@@ -786,9 +786,9 @@ def hfftn(x, s=None, axes=None, norm="backward", name=None): ...@@ -786,9 +786,9 @@ def hfftn(x, s=None, axes=None, norm="backward", name=None):
This function calculates the n-D discrete Fourier transform of Hermite symmetric This function calculates the n-D discrete Fourier transform of Hermite symmetric
complex input on any axis in M-D array by fast Fourier transform (FFT). complex input on any axis in M-D array by fast Fourier transform (FFT).
In other words, ``ihfftn(hfftn(x, s)) == x is within the numerical accuracy range. In other words, ``ihfftn(hfftn(x, s)) == x`` is within the numerical accuracy range.
(``s`` here are ``x.shape`` and ``s[-1] = x.shape[- 1] * 2 - 1``. This is necessary (``s`` here are ``x.shape`` and ``s[-1] = x.shape[- 1] * 2 - 1``. This is necessary
for the same reason that ``irfft` requires ``x.shape``.) for the same reason that ``irfft`` requires ``x.shape``.)
Args: Args:
x (Tensor): The input data. It's a Tensor type. x (Tensor): The input data. It's a Tensor type.
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册