Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix comments for metrics_to_scalars (#8782) 

metrics_to_scalars can return non-float values, such as int or complex, depending on the dtype of the tensor.
This commit is contained in:
edward-io 2021-08-07 03:03:36 -07:00 committed by GitHub
parent e541803636
commit f3442db3f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pytorch_lightning/utilities/metrics.py
View File

@ -27,13 +27,13 @@ def metrics_to_scalars(metrics: Any) -> Any:
Raises: Raises:
MisconfigurationException: MisconfigurationException:
If ``value`` contains multiple elements, hence preventing conversion to ``float`` If tensors inside ``metrics`` contains multiple elements, hence preventing conversion to a scalar.
""" """
def to_item(value: torch.Tensor) -> numbers.Number: def to_item(value: torch.Tensor) -> numbers.Number:
if value.numel() != 1: if value.numel() != 1:
raise MisconfigurationException( raise MisconfigurationException(
f"The metric `{value}` does not contain a single element" f" thus it cannot be converted to float." f"The metric `{value}` does not contain a single element, thus it cannot be converted to a scalar."
) )
return value.item() return value.item()