@@ -5,6 +5,9 @@ MAPIE API
55Regression
66=============================
77
8+ Conformalizers
9+ ---------------
10+
811.. autosummary ::
912 :toctree: generated/
1013 :template: class.rst
@@ -15,56 +18,58 @@ Regression
1518 mapie.regression.ConformalizedQuantileRegressor
1619 mapie.regression.TimeSeriesRegressor
1720
18- Classification
19- ==============
21+ Metrics
22+ --------
2023
2124.. autosummary ::
2225 :toctree: generated/
23- :template: class .rst
26+ :template: function .rst
2427
25- mapie.classification.SplitConformalClassifier
26- mapie.classification.CrossConformalClassifier
28+ mapie.metrics.regression.regression_coverage_score
29+ mapie.metrics.regression.regression_mean_width_score
30+ mapie.metrics.regression.regression_ssc
31+ mapie.metrics.regression.regression_ssc_score
32+ mapie.metrics.regression.hsic
33+ mapie.metrics.regression.coverage_width_based
34+ mapie.metrics.regression.regression_mwi_score
2735
28- Multi-Label Classification
29- ==========================
36+ Conformity Scores
37+ -------------------
3038
3139.. autosummary ::
3240 :toctree: generated/
3341 :template: class.rst
3442
35- mapie.risk_control.PrecisionRecallController
43+ mapie.conformity_scores.BaseRegressionScore
44+ mapie.conformity_scores.AbsoluteConformityScore
45+ mapie.conformity_scores.GammaConformityScore
46+ mapie.conformity_scores.ResidualNormalisedScore
3647
37- Calibration
38- ===========
48+ Resampling
49+ -----------
3950
4051.. autosummary ::
4152 :toctree: generated/
4253 :template: class.rst
4354
44- mapie.calibration.TopLabelCalibrator
55+ mapie.subsample.BlockBootstrap
56+ mapie.subsample.Subsample
4557
46- Calibration Metrics
47- ======================================
58+ Classification
59+ ==============
60+
61+ Conformalizers
62+ ---------------
4863
4964.. autosummary ::
5065 :toctree: generated/
51- :template: function .rst
66+ :template: class .rst
5267
53- mapie.metrics.calibration.expected_calibration_error
54- mapie.metrics.calibration.top_label_ece
55- mapie.metrics.calibration.cumulative_differences
56- mapie.metrics.calibration.kolmogorov_smirnov_cdf
57- mapie.metrics.calibration.kolmogorov_smirnov_p_value
58- mapie.metrics.calibration.kolmogorov_smirnov_statistic
59- mapie.metrics.calibration.kuiper_cdf
60- mapie.metrics.calibration.kuiper_p_value
61- mapie.metrics.calibration.kuiper_statistic
62- mapie.metrics.calibration.length_scale
63- mapie.metrics.calibration.spiegelhalter_p_value
64- mapie.metrics.calibration.spiegelhalter_statistic
68+ mapie.classification.SplitConformalClassifier
69+ mapie.classification.CrossConformalClassifier
6570
66- Classification Metrics
67- ========================================
71+ Metrics
72+ --------
6873
6974.. autosummary ::
7075 :toctree: generated/
@@ -75,62 +80,66 @@ Classification Metrics
7580 mapie.metrics.classification.classification_ssc
7681 mapie.metrics.classification.classification_ssc_score
7782
78- Regression Metrics
79- ====================================
83+ Conformity Scores
84+ ------------------
8085
8186.. autosummary ::
8287 :toctree: generated/
83- :template: function .rst
88+ :template: class .rst
8489
85- mapie.metrics.regression.regression_coverage_score
86- mapie.metrics.regression.regression_mean_width_score
87- mapie.metrics.regression.regression_ssc
88- mapie.metrics.regression.regression_ssc_score
89- mapie.metrics.regression.hsic
90- mapie.metrics.regression.coverage_width_based
91- mapie.metrics.regression.regression_mwi_score
90+ mapie.conformity_scores.BaseClassificationScore
91+ mapie.conformity_scores.NaiveConformityScore
92+ mapie.conformity_scores.LACConformityScore
93+ mapie.conformity_scores.APSConformityScore
94+ mapie.conformity_scores.RAPSConformityScore
95+ mapie.conformity_scores.TopKConformityScore
9296
93- Utils
94- ==============================
97+ Risk Control
98+ ==========================
9599
96100.. autosummary ::
97101 :toctree: generated/
98- :template: function .rst
102+ :template: class .rst
99103
100- mapie.utils.train_conformalize_test_split
104+ mapie.risk_control.PrecisionRecallController
101105
102- Conformity Scores (Regression)
103- ==============================
106+ Calibration
107+ ===========
108+
109+ Conformalizer
110+ --------------
104111
105112.. autosummary ::
106113 :toctree: generated/
107114 :template: class.rst
108115
109- mapie.conformity_scores.BaseRegressionScore
110- mapie.conformity_scores.AbsoluteConformityScore
111- mapie.conformity_scores.GammaConformityScore
112- mapie.conformity_scores.ResidualNormalisedScore
116+ mapie.calibration.TopLabelCalibrator
113117
114- Conformity Scores (Classification)
115- ==================================
118+ Metrics
119+ --------
116120
117121.. autosummary ::
118122 :toctree: generated/
119- :template: class .rst
123+ :template: function .rst
120124
121- mapie.conformity_scores.BaseClassificationScore
122- mapie.conformity_scores.NaiveConformityScore
123- mapie.conformity_scores.LACConformityScore
124- mapie.conformity_scores.APSConformityScore
125- mapie.conformity_scores.RAPSConformityScore
126- mapie.conformity_scores.TopKConformityScore
125+ mapie.metrics.calibration.expected_calibration_error
126+ mapie.metrics.calibration.top_label_ece
127+ mapie.metrics.calibration.cumulative_differences
128+ mapie.metrics.calibration.kolmogorov_smirnov_cdf
129+ mapie.metrics.calibration.kolmogorov_smirnov_p_value
130+ mapie.metrics.calibration.kolmogorov_smirnov_statistic
131+ mapie.metrics.calibration.kuiper_cdf
132+ mapie.metrics.calibration.kuiper_p_value
133+ mapie.metrics.calibration.kuiper_statistic
134+ mapie.metrics.calibration.length_scale
135+ mapie.metrics.calibration.spiegelhalter_p_value
136+ mapie.metrics.calibration.spiegelhalter_statistic
127137
128- Resampling
129- ==========
138+ Utils
139+ ==============================
130140
131141.. autosummary ::
132142 :toctree: generated/
133- :template: class .rst
143+ :template: function .rst
134144
135- mapie.subsample.BlockBootstrap
136- mapie.subsample.Subsample
145+ mapie.utils.train_conformalize_test_split
0 commit comments