Skip to content

Commit 70e7e8a

Browse files
DOC: update binary classification documentation according to the v1 API (#692)
1 parent 1cfd73f commit 70e7e8a

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

doc/theoretical_description_binary_classification.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@ calibration (see :doc:`theoretical_description_calibration`), confidence interva
1919
These 3 notions are tightly related for score-based classifier, as it is shown in [1].
2020

2121
Prediction sets can be computed in the same way for multiclass and binary classification with
22-
:class:`~mapie.classification._MapieClassifier`, and there are the same theoretical guarantees.
23-
Nevertheless, prediction sets are often much less informative in the binary case than in the multiclass case.
22+
:class:`~mapie.classification.SplitConformalClassifier` or :class:`~mapie.classification.CrossConformalClassifier`,
23+
and there are the same theoretical guarantees. Nevertheless, prediction sets are often much less informative in the
24+
binary case than in the multiclass case.
2425

2526
From Gupta et al [1]:
2627

@@ -53,7 +54,8 @@ Definition 1 (Prediction Set (PS) w.r.t :math:`f`) [1].
5354
PSs are typically studied for larger output sets, such as :math:`\mathcal{Y}_{regression}=\mathbb{R}` or
5455
:math:`\mathcal{Y}_{multiclass}=\{1, 2, ..., L > 2\}`.
5556

56-
See :class:`~mapie.classification._MapieClassifier` to use a set predictor.
57+
See :class:`~mapie.classification.SplitConformalClassifier` and :class:`~mapie.classification.CrossConformalClassifier`
58+
to use a set predictor.
5759

5860

5961
2. Probabilistic Prediction

0 commit comments

Comments
 (0)