Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adamjstewart committed Aug 14, 2024
1 parent 3159257 commit b860c95
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions torchgeo/trainers/classification.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,13 +127,13 @@ def configure_losses(self) -> None:
def configure_metrics(self) -> None:
"""Initialize the performance metrics.
* :class:`~torchmetrics.classification.Accuracy`: The number of
* :class:`~torchmetrics.Accuracy`: The number of
true positives divided by the dataset size. Both overall accuracy (OA)
using 'micro' averaging and average accuracy (AA) using 'macro' averaging
are reported. Higher values are better.
* :class:`~torchmetrics.classification.JaccardIndex`: Intersection
* :class:`~torchmetrics.JaccardIndex`: Intersection
over union (IoU). Uses 'macro' averaging. Higher valuers are better.
* :class:`~torchmetrics.classification.FBetaScore`: F1 score.
* :class:`~torchmetrics.FBetaScore`: F1 score.
The harmonic mean of precision and recall. Uses 'micro' averaging.
Higher values are better.
Expand Down
4 changes: 2 additions & 2 deletions torchgeo/trainers/segmentation.py
Original file line number Diff line number Diff line change
Expand Up @@ -189,10 +189,10 @@ def configure_losses(self) -> None:
def configure_metrics(self) -> None:
"""Initialize the performance metrics.
* :class:`~torchmetrics.classification.Accuracy`: Overall accuracy
* :class:`~torchmetrics.Accuracy`: Overall accuracy
(OA) using 'micro' averaging. The number of true positives divided by the
dataset size. Higher values are better.
* :class:`~torchmetrics.classification.JaccardIndex`: Intersection
* :class:`~torchmetrics.JaccardIndex`: Intersection
over union (IoU). Uses 'micro' averaging. Higher valuers are better.
.. note::
Expand Down

0 comments on commit b860c95

Please sign in to comment.