DOC: reorganize API page (#703)

Author: FaustinPulveric

doc/api.rst

@@ -5,6 +5,9 @@ MAPIE API
 Regression
 =============================
 
+Conformalizers
+---------------
+
 .. autosummary::
    :toctree: generated/
    :template: class.rst
@@ -15,56 +18,58 @@ Regression
    mapie.regression.ConformalizedQuantileRegressor
    mapie.regression.TimeSeriesRegressor
 
-Classification
-==============
+Metrics
+--------
 
 .. autosummary::
    :toctree: generated/
-   :template: class.rst
+   :template: function.rst
 
-   mapie.classification.SplitConformalClassifier
-   mapie.classification.CrossConformalClassifier
+   mapie.metrics.regression.regression_coverage_score
+   mapie.metrics.regression.regression_mean_width_score
+   mapie.metrics.regression.regression_ssc
+   mapie.metrics.regression.regression_ssc_score
+   mapie.metrics.regression.hsic
+   mapie.metrics.regression.coverage_width_based
+   mapie.metrics.regression.regression_mwi_score
 
-Multi-Label Classification
-==========================
+Conformity Scores
+-------------------
 
 .. autosummary::
    :toctree: generated/
    :template: class.rst
 
-   mapie.risk_control.PrecisionRecallController
+   mapie.conformity_scores.BaseRegressionScore
+   mapie.conformity_scores.AbsoluteConformityScore
+   mapie.conformity_scores.GammaConformityScore
+   mapie.conformity_scores.ResidualNormalisedScore
 
-Calibration
-===========
+Resampling
+-----------
 
 .. autosummary::
    :toctree: generated/
    :template: class.rst
 
-   mapie.calibration.TopLabelCalibrator
+   mapie.subsample.BlockBootstrap
+   mapie.subsample.Subsample
 
-Calibration Metrics
-======================================
+Classification
+==============
+
+Conformalizers
+---------------
 
 .. autosummary::
    :toctree: generated/
-   :template: function.rst
+   :template: class.rst
 
-   mapie.metrics.calibration.expected_calibration_error
-   mapie.metrics.calibration.top_label_ece
-   mapie.metrics.calibration.cumulative_differences
-   mapie.metrics.calibration.kolmogorov_smirnov_cdf
-   mapie.metrics.calibration.kolmogorov_smirnov_p_value
-   mapie.metrics.calibration.kolmogorov_smirnov_statistic
-   mapie.metrics.calibration.kuiper_cdf
-   mapie.metrics.calibration.kuiper_p_value
-   mapie.metrics.calibration.kuiper_statistic
-   mapie.metrics.calibration.length_scale
-   mapie.metrics.calibration.spiegelhalter_p_value
-   mapie.metrics.calibration.spiegelhalter_statistic
+   mapie.classification.SplitConformalClassifier
+   mapie.classification.CrossConformalClassifier
 
-Classification Metrics
-========================================
+Metrics
+--------
 
 .. autosummary::
    :toctree: generated/
@@ -75,62 +80,66 @@ Classification Metrics
    mapie.metrics.classification.classification_ssc
    mapie.metrics.classification.classification_ssc_score
 
-Regression Metrics
-====================================
+Conformity Scores
+------------------
 
 .. autosummary::
    :toctree: generated/
-   :template: function.rst
+   :template: class.rst
 
-   mapie.metrics.regression.regression_coverage_score
-   mapie.metrics.regression.regression_mean_width_score
-   mapie.metrics.regression.regression_ssc
-   mapie.metrics.regression.regression_ssc_score
-   mapie.metrics.regression.hsic
-   mapie.metrics.regression.coverage_width_based
-   mapie.metrics.regression.regression_mwi_score
+   mapie.conformity_scores.BaseClassificationScore
+   mapie.conformity_scores.NaiveConformityScore
+   mapie.conformity_scores.LACConformityScore
+   mapie.conformity_scores.APSConformityScore
+   mapie.conformity_scores.RAPSConformityScore
+   mapie.conformity_scores.TopKConformityScore
 
-Utils
-==============================
+Risk Control
+==========================
 
 .. autosummary::
    :toctree: generated/
-   :template: function.rst
+   :template: class.rst
 
-   mapie.utils.train_conformalize_test_split
+   mapie.risk_control.PrecisionRecallController
 
-Conformity Scores (Regression)
-==============================
+Calibration
+===========
+
+Conformalizer
+--------------
 
 .. autosummary::
    :toctree: generated/
    :template: class.rst
 
-   mapie.conformity_scores.BaseRegressionScore
-   mapie.conformity_scores.AbsoluteConformityScore
-   mapie.conformity_scores.GammaConformityScore
-   mapie.conformity_scores.ResidualNormalisedScore
+   mapie.calibration.TopLabelCalibrator
 
-Conformity Scores (Classification)
-==================================
+Metrics
+--------
 
 .. autosummary::
    :toctree: generated/
-   :template: class.rst
+   :template: function.rst
 
-   mapie.conformity_scores.BaseClassificationScore
-   mapie.conformity_scores.NaiveConformityScore
-   mapie.conformity_scores.LACConformityScore
-   mapie.conformity_scores.APSConformityScore
-   mapie.conformity_scores.RAPSConformityScore
-   mapie.conformity_scores.TopKConformityScore
+   mapie.metrics.calibration.expected_calibration_error
+   mapie.metrics.calibration.top_label_ece
+   mapie.metrics.calibration.cumulative_differences
+   mapie.metrics.calibration.kolmogorov_smirnov_cdf
+   mapie.metrics.calibration.kolmogorov_smirnov_p_value
+   mapie.metrics.calibration.kolmogorov_smirnov_statistic
+   mapie.metrics.calibration.kuiper_cdf
+   mapie.metrics.calibration.kuiper_p_value
+   mapie.metrics.calibration.kuiper_statistic
+   mapie.metrics.calibration.length_scale
+   mapie.metrics.calibration.spiegelhalter_p_value
+   mapie.metrics.calibration.spiegelhalter_statistic
 
-Resampling
-==========
+Utils
+==============================
 
 .. autosummary::
    :toctree: generated/
-   :template: class.rst
+   :template: function.rst
 
-   mapie.subsample.BlockBootstrap
-   mapie.subsample.Subsample
+   mapie.utils.train_conformalize_test_split