Remove noindex for docs (#1998)

Lightning-AI · Aug 15, 2023 · 23356d4 · 23356d4
1 parent 3c78fc7
commit 23356d4
Show file tree

Hide file tree

Showing 136 changed files with 5 additions and 372 deletions.
diff --git a/docs/source/aggregation/cat.rst b/docs/source/aggregation/cat.rst
@@ -13,5 +13,4 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.aggregation.CatMetric
-    :noindex:
     :exclude-members: update, compute
diff --git a/docs/source/aggregation/max.rst b/docs/source/aggregation/max.rst
@@ -13,5 +13,4 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.aggregation.MaxMetric
-    :noindex:
     :exclude-members: update, compute
diff --git a/docs/source/aggregation/mean.rst b/docs/source/aggregation/mean.rst
@@ -13,5 +13,4 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.aggregation.MeanMetric
-    :noindex:
     :exclude-members: update, compute
diff --git a/docs/source/aggregation/min.rst b/docs/source/aggregation/min.rst
@@ -13,5 +13,4 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.aggregation.MinMetric
-    :noindex:
     :exclude-members: update, compute
diff --git a/docs/source/aggregation/running_mean.rst b/docs/source/aggregation/running_mean.rst
@@ -13,5 +13,4 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.aggregation.RunningMean
-    :noindex:
     :exclude-members: update, compute
diff --git a/docs/source/aggregation/running_sum.rst b/docs/source/aggregation/running_sum.rst
@@ -13,5 +13,4 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.aggregation.RunningSum
-    :noindex:
     :exclude-members: update, compute
diff --git a/docs/source/aggregation/sum.rst b/docs/source/aggregation/sum.rst
@@ -13,5 +13,4 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.aggregation.SumMetric
-    :noindex:
     :exclude-members: update, compute
diff --git a/docs/source/audio/complex_scale_invariant_signal_noise_ratio.rst b/docs/source/audio/complex_scale_invariant_signal_noise_ratio.rst
@@ -13,11 +13,9 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.audio.ComplexScaleInvariantSignalNoiseRatio
-    :noindex:
     :exclude-members: update, compute
 
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.audio.complex_scale_invariant_signal_noise_ratio
-    :noindex:
diff --git a/docs/source/audio/perceptual_evaluation_speech_quality.rst b/docs/source/audio/perceptual_evaluation_speech_quality.rst
@@ -13,11 +13,9 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.audio.pesq.PerceptualEvaluationSpeechQuality
-    :noindex:
     :exclude-members: update, compute
 
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.audio.pesq.perceptual_evaluation_speech_quality
-    :noindex:
diff --git a/docs/source/audio/permutation_invariant_training.rst b/docs/source/audio/permutation_invariant_training.rst
@@ -13,11 +13,9 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.audio.PermutationInvariantTraining
-    :noindex:
     :exclude-members: update, compute
 
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.audio.permutation_invariant_training
-    :noindex:
diff --git a/docs/source/audio/scale_invariant_signal_distortion_ratio.rst b/docs/source/audio/scale_invariant_signal_distortion_ratio.rst
@@ -13,11 +13,9 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.audio.ScaleInvariantSignalDistortionRatio
-    :noindex:
     :exclude-members: update, compute
 
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.audio.scale_invariant_signal_distortion_ratio
-    :noindex:
diff --git a/docs/source/audio/scale_invariant_signal_noise_ratio.rst b/docs/source/audio/scale_invariant_signal_noise_ratio.rst
@@ -13,11 +13,9 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.audio.ScaleInvariantSignalNoiseRatio
-    :noindex:
     :exclude-members: update, compute
 
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.audio.scale_invariant_signal_noise_ratio
-    :noindex:
diff --git a/docs/source/audio/short_time_objective_intelligibility.rst b/docs/source/audio/short_time_objective_intelligibility.rst
@@ -13,11 +13,8 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.audio.stoi.ShortTimeObjectiveIntelligibility
-    :noindex:
-    :exclude-members: update, compute
 
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.audio.stoi.short_time_objective_intelligibility
-    :noindex:
diff --git a/docs/source/audio/signal_distortion_ratio.rst b/docs/source/audio/signal_distortion_ratio.rst
@@ -13,11 +13,9 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.audio.SignalDistortionRatio
-    :noindex:
     :exclude-members: update, compute
 
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.audio.signal_distortion_ratio
-    :noindex:
diff --git a/docs/source/audio/signal_noise_ratio.rst b/docs/source/audio/signal_noise_ratio.rst
@@ -13,11 +13,9 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.audio.SignalNoiseRatio
-    :noindex:
     :exclude-members: update, compute
 
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.audio.signal_noise_ratio
-    :noindex:
diff --git a/docs/source/audio/source_aggregated_signal_distortion_ratio.rst b/docs/source/audio/source_aggregated_signal_distortion_ratio.rst
@@ -13,11 +13,9 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.audio.sdr.SourceAggregatedSignalDistortionRatio
-    :noindex:
     :exclude-members: update, compute
 
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.audio.sdr.source_aggregated_signal_distortion_ratio
-    :noindex:
diff --git a/docs/source/audio/speech_reverberation_modulation_energy_ratio.rst b/docs/source/audio/speech_reverberation_modulation_energy_ratio.rst
@@ -13,11 +13,9 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.audio.srmr.SpeechReverberationModulationEnergyRatio
-    :noindex:
     :exclude-members: update, compute
 
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.audio.srmr.speech_reverberation_modulation_energy_ratio
-    :noindex:
diff --git a/docs/source/classification/accuracy.rst b/docs/source/classification/accuracy.rst
@@ -13,52 +13,43 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.Accuracy
-    :noindex:
     :exclude-members: update, compute
     :special-members: __new__
 
 BinaryAccuracy
 ^^^^^^^^^^^^^^
 
 .. autoclass:: torchmetrics.classification.BinaryAccuracy
-    :noindex:
     :exclude-members: update, compute
 
 MulticlassAccuracy
 ^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: torchmetrics.classification.MulticlassAccuracy
-    :noindex:
     :exclude-members: update, compute
 
 MultilabelAccuracy
 ^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: torchmetrics.classification.MultilabelAccuracy
-    :noindex:
     :exclude-members: update, compute
 
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.classification.accuracy
-    :noindex:
 
 binary_accuracy
 ^^^^^^^^^^^^^^^
 
 .. autofunction:: torchmetrics.functional.classification.binary_accuracy
-    :noindex:
 
 multiclass_accuracy
 ^^^^^^^^^^^^^^^^^^^
 
 .. autofunction:: torchmetrics.functional.classification.multiclass_accuracy
-    :noindex:
-
 
 multilabel_accuracy
 ^^^^^^^^^^^^^^^^^^^
 
 .. autofunction:: torchmetrics.functional.classification.multilabel_accuracy
-    :noindex:
diff --git a/docs/source/classification/auroc.rst b/docs/source/classification/auroc.rst
@@ -13,51 +13,43 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.AUROC
-    :noindex:
     :exclude-members: update, compute
     :special-members: __new__
 
 BinaryAUROC
 ^^^^^^^^^^^
 
 .. autoclass:: torchmetrics.classification.BinaryAUROC
-    :noindex:
     :exclude-members: update, compute
 
 MulticlassAUROC
 ^^^^^^^^^^^^^^^
 
 .. autoclass:: torchmetrics.classification.MulticlassAUROC
-    :noindex:
     :exclude-members: update, compute
 
 MultilabelAUROC
 ^^^^^^^^^^^^^^^
 
 .. autoclass:: torchmetrics.classification.MultilabelAUROC
-    :noindex:
     :exclude-members: update, compute
 
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.auroc
-    :noindex:
 
 binary_auroc
 ^^^^^^^^^^^^
 
 .. autofunction:: torchmetrics.functional.classification.binary_auroc
-    :noindex:
 
 multiclass_auroc
 ^^^^^^^^^^^^^^^^
 
 .. autofunction:: torchmetrics.functional.classification.multiclass_auroc
-    :noindex:
 
 multilabel_auroc
 ^^^^^^^^^^^^^^^^
 
 .. autofunction:: torchmetrics.functional.classification.multilabel_auroc
-    :noindex:
diff --git a/docs/source/classification/average_precision.rst b/docs/source/classification/average_precision.rst
@@ -13,51 +13,43 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.AveragePrecision
-    :noindex:
     :exclude-members: update, compute
     :special-members: __new__
 
 BinaryAveragePrecision
 ^^^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: torchmetrics.classification.BinaryAveragePrecision
-    :noindex:
     :exclude-members: update, compute
 
 MulticlassAveragePrecision
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: torchmetrics.classification.MulticlassAveragePrecision
-    :noindex:
     :exclude-members: update, compute
 
 MultilabelAveragePrecision
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: torchmetrics.classification.MultilabelAveragePrecision
-    :noindex:
     :exclude-members: update, compute
 
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.average_precision
-    :noindex:
 
 binary_average_precision
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autofunction:: torchmetrics.functional.classification.binary_average_precision
-    :noindex:
 
 multiclass_average_precision
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autofunction:: torchmetrics.functional.classification.multiclass_average_precision
-    :noindex:
 
 multilabel_average_precision
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autofunction:: torchmetrics.functional.classification.multilabel_average_precision
-    :noindex:
diff --git a/docs/source/classification/calibration_error.rst b/docs/source/classification/calibration_error.rst
@@ -21,30 +21,25 @@ BinaryCalibrationError
 ^^^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: torchmetrics.classification.BinaryCalibrationError
-    :noindex:
     :exclude-members: update, compute
 
 MulticlassCalibrationError
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: torchmetrics.classification.MulticlassCalibrationError
-    :noindex:
     :exclude-members: update, compute
 
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.calibration_error
-    :noindex:
 
 binary_calibration_error
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autofunction:: torchmetrics.functional.classification.binary_calibration_error
-    :noindex:
 
 multiclass_calibration_error
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autofunction:: torchmetrics.functional.classification.multiclass_calibration_error
-    :noindex:
diff --git a/docs/source/classification/cohen_kappa.rst b/docs/source/classification/cohen_kappa.rst
@@ -13,22 +13,19 @@ Module Interface
 ________________
 
 .. autoclass:: torchmetrics.CohenKappa
-    :noindex:
     :exclude-members: update, compute
     :special-members: __new__
 
 BinaryCohenKappa
 ^^^^^^^^^^^^^^^^
 
 .. autoclass:: torchmetrics.classification.BinaryCohenKappa
-    :noindex:
     :exclude-members: update, compute
 
 MulticlassCohenKappa
 ^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: torchmetrics.classification.MulticlassCohenKappa
-    :noindex:
     :exclude-members: update, compute
 
 Functional Interface
@@ -38,16 +35,13 @@ cohen_kappa
 ^^^^^^^^^^^
 
 .. autofunction:: torchmetrics.functional.cohen_kappa
-    :noindex:
 
 binary_cohen_kappa
 ^^^^^^^^^^^^^^^^^^
 
 .. autofunction:: torchmetrics.functional.classification.binary_cohen_kappa
-    :noindex:
 
 multiclass_cohen_kappa
 ^^^^^^^^^^^^^^^^^^^^^^
 
 .. autofunction:: torchmetrics.functional.classification.multiclass_cohen_kappa
-    :noindex: