check_scalar

sklearn.utils.check_scalar(x, name, target_type, *, min_val=None, max_val=None, include_boundaries='both')

Validiert den Typ und Wert von Skalarparametern.

Parameter:

xobject

Der zu validierende Skalarparameter.

namestr

Der Name des Parameters, der in Fehlermeldungen ausgegeben wird.

target_typetype oder tuple

Akzeptable Datentypen für den Parameter.

min_valfloat oder int, Standard=None

Der minimale gültige Wert, den der Parameter annehmen kann. Wenn None (Standard) wird impliziert, dass der Parameter keine untere Grenze hat.

max_valfloat oder int, Standard=None

Der maximale gültige Wert, den der Parameter annehmen kann. Wenn None (Standard) wird impliziert, dass der Parameter keine obere Grenze hat.

include_boundaries{„left“, „right“, „both“, „neither“}, Standard=”both”

Ob das durch min_val und max_val definierte Intervall die Grenzen einschließen soll. Mögliche Optionen sind

• "left": Nur min_val ist im gültigen Intervall enthalten. Dies entspricht dem Intervall [ min_val, max_val ).

• "right": Nur max_val ist im gültigen Intervall enthalten. Dies entspricht dem Intervall ( min_val, max_val ].

• "both": min_val und max_val sind im gültigen Intervall enthalten. Dies entspricht dem Intervall [ min_val, max_val ].

• "neither": Weder min_val noch max_val sind im gültigen Intervall enthalten. Dies entspricht dem Intervall ( min_val, max_val ).

Gibt zurück:

xnumbers.Number

Die validierte Zahl.

Löst aus:

TypeError

Wenn der Typ des Parameters nicht dem gewünschten Typ entspricht.

ValueError

Wenn der Wert des Parameters gegen die angegebenen Grenzen verstößt. Wenn min_val, max_val und include_boundaries inkonsistent sind.

Beispiele

>>> from sklearn.utils.validation import check_scalar
>>> check_scalar(10, "x", int, min_val=1, max_val=20)
10