OSSForks/pytorch
1
0
Fork 0
mirror of https://github.com/zebrajr/pytorch.git synced 2025-12-06 12:20:52 +01:00
Code Issues Actions 38 Packages Projects Releases Wiki Activity

finfo eps doc fix (#160502)

Browse Source 
Existing documentation for torch.finfo().eps is as below:
| eps             | float  | The smallest representable number such that ``1.0 + eps != 1.0``.          |

Proposed documentation for torch.finfo().eps is as below:
| eps             | float  | The difference between 1.0 and the next smallest representable float larger than 1.0.	|

Fixes #160397

Pull Request resolved: https://github.com/pytorch/pytorch/pull/160502
Approved by: https://github.com/ngimel
This commit is contained in:
RajeshvShiyal 2025-08-14 01:49:32 +00:00 committed by PyTorch MergeBot
parent 15e49f6164
commit 5ace061254
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/source/type_info.md
View File

@ -20,15 +20,15 @@ This is similar to [numpy.finfo](https://numpy.org/doc/stable/reference/generate
A {class}`torch.finfo` provides the following attributes:
| Name | Type | Description |
| :-------------- | :---- | :------------------------------------------------------------------------- |
| bits | int | The number of bits occupied by the type. |
| eps | float | The smallest representable number such that ``1.0 + eps != 1.0``. |
| max | float | The largest representable number. |
| min | float | The smallest representable number (typically ``-max``). |
| tiny | float | The smallest positive normal number. Equivalent to ``smallest_normal``. |
| smallest_normal | float | The smallest positive normal number. See notes. |
| resolution | float | The approximate decimal resolution of this type, i.e., ``10**-precision``. |
| Name | Type | Description |
| :-------------- | :---- | :------------------------------------------------------------------------------------------ |
| bits | int | The number of bits occupied by the type. |
| eps | float | The difference between 1.0 and the next smallest representable float larger than 1.0. |
| max | float | The largest representable number. |
| min | float | The smallest representable number (typically ``-max``). |
| tiny | float | The smallest positive normal number. Equivalent to ``smallest_normal``. |
| smallest_normal | float | The smallest positive normal number. See notes. |
| resolution | float | The approximate decimal resolution of this type, i.e., ``10**-precision``. |
```{note}
The constructor of {class}`torch.finfo` can be called without argument,