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
215 stars 47 forks source link

Auto Update Docs #118

Closed bobakfb closed 1 year ago

bobakfb commented 1 year ago

Summary: This diff adds a python script update_docs.py which automatically generates torcheval.metrics.rst and torcheval.metrics.functional.rst, ensuring the API docs will always be in sync.

I also fixed several errors with the docstrings and missing imports which I found while writing this code.

Reviewed By: ananthsub

Differential Revision: D42404082

facebook-github-bot commented 1 year ago

This pull request was exported from Phabricator. Differential Revision: D42404082

codecov[bot] commented 1 year ago

Codecov Report

Merging #118 (65fcff2) into main (94e018d) will increase coverage by 0.00%. The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #118   +/-   ##
=======================================
  Coverage   95.63%   95.64%           
=======================================
  Files         156      156           
  Lines        8783     8794   +11     
=======================================
+ Hits         8400     8411   +11     
  Misses        383      383           
Impacted Files Coverage Δ
torcheval/metrics/__init__.py 100.00% <ø> (ø)
torcheval/metrics/classification/auprc.py 100.00% <ø> (ø)
torcheval/metrics/classification/auroc.py 98.79% <ø> (ø)
torcheval/metrics/classification/binned_auroc.py 100.00% <ø> (ø)
torcheval/metrics/functional/__init__.py 100.00% <ø> (ø)
...rcheval/metrics/functional/classification/auprc.py 100.00% <ø> (ø)
torcheval/metrics/functional/text/perplexity.py 100.00% <ø> (ø)
torcheval/metrics/text/word_information_lost.py 100.00% <ø> (ø)
torcheval/metrics/window/mean_squared_error.py 96.47% <ø> (ø)
torcheval/metrics/aggregation/__init__.py 100.00% <100.00%> (ø)
... and 10 more

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

facebook-github-bot commented 1 year ago

This pull request was exported from Phabricator. Differential Revision: D42404082

facebook-github-bot commented 1 year ago

This pull request was exported from Phabricator. Differential Revision: D42404082

facebook-github-bot commented 1 year ago

This pull request was exported from Phabricator. Differential Revision: D42404082

facebook-github-bot commented 1 year ago

This pull request was exported from Phabricator. Differential Revision: D42404082