Commita64b6b2

authored

DOC Fixpos_label docstring in Display classes (#31696)

1 parenta048a40 commita64b6b2Copy full SHA for a64b6b2

File tree

+15

-14

lines changed

+15

-14

lines changed

Lines changed: 4 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -1102,9 +1102,8 @@ class CalibrationDisplay(_BinaryClassifierCurveDisplayMixin):`
`1102`	`1102`	`Name of estimator. If None, the estimator name is not shown.`
`1103`	`1103`
`1104`	`1104`	`pos_label : int, float, bool or str, default=None`
`1105`		`- The positive class when computing the calibration curve.`
`1106`		- By default, `pos_label` is set to `estimators.classes_[1]` when using
`1107`		- `from_estimator` and set to 1 when using `from_predictions`.
	`1105`	`+ The positive class when calibration curve computed.`
	`1106`	+ If not `None`, this value is displayed in the x- and y-axes labels.
`1108`	`1107`
`1109`	`1108`	`.. versionadded:: 1.1`
`1110`	`1109`
`@@ -1385,7 +1384,8 @@ def from_predictions(`
`1385`	`1384`
`1386`	`1385`	`pos_label : int, float, bool or str, default=None`
`1387`	`1386`	`The positive class when computing the calibration curve.`
`1388`		- By default `pos_label` is set to 1.
	`1387`	+ When `pos_label=None`, if `y_true` is in {-1, 1} or {0, 1},
	`1388`	+ `pos_label` is set to 1, otherwise an error will be raised.
`1389`	`1389`
`1390`	`1390`	`.. versionadded:: 1.1`
`1391`	`1391`

Lines changed: 4 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,8 @@ class DetCurveDisplay(_BinaryClassifierCurveDisplayMixin):`
`34`	`34`	`Name of estimator. If None, the estimator name is not shown.`
`35`	`35`
`36`	`36`	`pos_label : int, float, bool or str, default=None`
`37`		`- The label of the positive class.`
	`37`	+ The label of the positive class. If not `None`, this value is displayed in
	`38`	`+ the x- and y-axes labels.`
`38`	`39`
`39`	`40`	`Attributes`
`40`	`41`	`----------`
`@@ -136,9 +137,8 @@ def from_estimator(`
`136`	`137`	exist :term:`decision_function` is tried next.
`137`	`138`
`138`	`139`	`pos_label : int, float, bool or str, default=None`
`139`		- The label of the positive class. When `pos_label=None`, if `y_true`
`140`		- is in {-1, 1} or {0, 1}, `pos_label` is set to 1, otherwise an
`141`		`- error will be raised.`
	`140`	+ The label of the positive class. By default, `estimators.classes_[1]`
	`141`	`+ is considered as the positive class.`
`142`	`142`
`143`	`143`	`name : str, default=None`
`144`	`144`	Name of DET curve for labeling. If `None`, use the name of the

Lines changed: 5 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -40,8 +40,8 @@ class PrecisionRecallDisplay(_BinaryClassifierCurveDisplayMixin):`
`40`	`40`	`Name of estimator. If None, then the estimator name is not shown.`
`41`	`41`
`42`	`42`	`pos_label : int, float, bool or str, default=None`
`43`		`- The class consideredasthe positive class. If None, the class will not`
`44`		`-be shownin thelegend.`
	`43`	`+ The class considered the positive class when precision and recall metrics`
	`44`	+computed. If not `None`, this value is displayedin thex- and y-axes labels.
`45`	`45`
`46`	`46`	`.. versionadded:: 0.24`
`47`	`47`
`@@ -449,7 +449,9 @@ def from_predictions(`
`449`	`449`
`450`	`450`	`pos_label : int, float, bool or str, default=None`
`451`	`451`	`The class considered as the positive class when computing the`
`452`		`- precision and recall metrics.`
	`452`	+ precision and recall metrics. When `pos_label=None`, if `y_true` is
	`453`	+ in {-1, 1} or {0, 1}, `pos_label` is set to 1, otherwise an error
	`454`	`+ will be raised.`
`453`	`455`
`454`	`456`	`name : str, default=None`
`455`	`457`	Name for labeling curve. If `None`, name will be set to

Lines changed: 2 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -71,9 +71,8 @@ class RocCurveDisplay(_BinaryClassifierCurveDisplayMixin):`
`71`	`71`	`.. versionadded:: 1.7`
`72`	`72`
`73`	`73`	`pos_label : int, float, bool or str, default=None`
`74`		`- The class considered as the positive class when computing the roc auc`
`75`		- metrics. By default, `estimators.classes_[1]` is considered
`76`		`- as the positive class.`
	`74`	`+ The class considered the positive class when ROC AUC metrics computed.`
	`75`	+ If not `None`, this value is displayed in the x- and y-axes labels.
`77`	`76`
`78`	`77`	`.. versionadded:: 0.24`
`79`	`78`

Comments

(0)