search

pytorch / torcheval

A library that contains a rich collection of performant PyTorch model metrics, a simple interface to create new metrics, a toolkit to facilitate metric computation in distributed training and tools for PyTorch model evaluations.
https://pytorch.org/torcheval
Other
211 stars 46 forks source link

doc: Fix Misleading Error Message for multiclass_precision #199

Open adrianjoshua-strutt opened 1 month ago

adrianjoshua-strutt commented 1 month ago

Old message was somewhat misleading. It implies that there are always zero instances for classes in both predictions and ground truth labels.

Summary: To make error more clear change message from

classes have zero instances in both the predictions and the ground truth labels. Precision is still logged as zero.

to

classes have zero instances in either the predictions or the ground truth labels. Precision is still logged as zero.

Fixes #{198} Issue

facebook-github-bot commented 1 month ago

Hi @adrianjoshua-strutt!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

facebook-github-bot commented 1 month ago

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!