Fixes needed for docs

[lantiga]

📚 Documentation

• All the links originating from this page lead to 404: https://torchmetrics--1956.org.readthedocs.build/en/1956/pages/all-metrics.html

• Plots (eg for mean, but it's also for all the others) are preceded by a (,,,) string that is unclear
  Fixed by docs: remove empty (,,,) from plots docstrings #1965

• Missing line break before last pip install: https://torchmetrics--1956.org.readthedocs.build/en/1956/audio/speech_reverberation_modulation_energy_ratio.html

• AUROC docstring has formatting issues (way too many spaces between square brackets etc (this is also true for a number of other pages, like Average Precision):
  Fixed by Convert classification wrapper to metrics #1963

Broken links to assets:

samples

• https://torchmetrics--1956.org.readthedocs.build/en/1956/audio/signal_noise_ratio.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/accuracy.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/cosine_similarity.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/auroc.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/average_precision.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/calibration_error.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/cohen_kappa.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/dice.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/f1_score.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/fbeta_score.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/hamming_distance.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/hinge_loss.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/jaccard_index.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/precision.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/precision_at_fixed_recall.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/precision_recall_curve.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/recall.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/recall_at_fixed_precision.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/roc.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/specificity.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/classification/specificity_at_sensitivity.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/detection/mean_average_precision.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/detection/modified_panoptic_quality.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/detection/panoptic_quality.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/image/frechet_inception_distance.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/image/inception_score.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/image/kernel_inception_distance.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/image/mifid.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/image/peak_signal_noise_ratio.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/image/peak_signal_to_noise_with_block.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/multimodal/clip_score.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/nominal/cramers_v.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/nominal/fleiss_kappa.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/nominal/pearsons_contingency_coefficient.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/nominal/theils_u.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/nominal/tschuprows_t.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/pairwise/cosine_similarity.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/pairwise/euclidean_distance.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/pairwise/linear_similarity.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/pairwise/manhattan_distance.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/pairwise/minkowski_distance.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/concordance_corr_coef.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/cosine_similarity.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/explained_variance.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/kendall_rank_corr_coef.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/kl_divergence.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/log_cosh_error.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/mean_absolute_error.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/mean_absolute_percentage_error.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/mean_squared_error.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/mean_squared_log_error.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/minkowski_distance.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/pearson_corr_coef.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/r2_score.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/rse.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/spearman_corr_coef.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/symmetric_mean_absolute_percentage_error.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/tweedie_deviance_score.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/regression/weighted_mean_absolute_percentage_error.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/text/match_error_rate.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/text/word_error_rate.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/text/word_info_lost.html
• https://torchmetrics--1956.org.readthedocs.build/en/1956/text/word_info_preserved.html

[github-actions]

Hi! thanks for your contribution!, great first issue!

[Borda]

broken links in https://torchmetrics.readthedocs.io/en/latest/pages/all-metrics.html are related to #1930 need to find way to update gallery :( or eventually, work on some redirect...

[Borda]

• Plots (eg for mean, but it's also for all the others) are preceded by a (,,,) string that is unclear

@SkafteNicki mind checking this one? 🐰

[Borda]

Broken links to assets:

this seems to be just PR rendering issue with latex as on the latest as well as old 0.11.0 are fine

[Borda]

• AUROC docstring has formatting issues (way too many spaces between square brackets etc (this is also true for a number of other pages, like Average Precision):

this seems to be an annotation issue as some from the typing package are missing, so could be resolved in #1916

[lantiga]

@Borda @SkafteNicki checked all links, looks good!

Nit: can you check the formula for the Minkowski distance? It breaks up for me https://lightning.ai/docs/torchmetrics/stable/regression/minkowski_distance.html

[SkafteNicki]

@Borda @SkafteNicki checked all links, looks good!

Nit: can you check the formula for the Minkowski distance? It breaks up for me https://lightning.ai/docs/torchmetrics/stable/regression/minkowski_distance.html

Yes let me figure out what is wrong with that. @lantiga could you also be more specific about the missing line break regarding the pip install mentioned above, because it looks fine on my end.

[lantiga]

Thank you @SkafteNicki , this is what I get on my browser

[lantiga]

@SkafteNicki looks like it's a Safari thing

[lantiga]

looks good on Chrome, probably not worth getting too crazy about it
let's only fix the Minkowski formula and we're good @Borda