check_array#

sklearn.utils.check_array(array, accept_sparse=False, *, accept_large_sparse=True, dtype='numeric', order=None, copy=False, force_writeable=False, ensure_all_finite=True, ensure_non_negative=False, ensure_2d=True, allow_nd=False, ensure_min_samples=1, ensure_min_features=1, estimator=None, input_name='')[Quelle]#

Eingabevalidierung für ein Array, eine Liste, eine spärliche Matrix oder ähnliches.

Standardmäßig wird die Eingabe auf ein nicht-leeres 2D-Array mit ausschließlich endlichen Werten überprüft. Wenn der dtype des Arrays object ist, wird versucht, in float zu konvertieren, wobei bei Fehlschlag ein Fehler ausgelöst wird.

Parameter:
arrayobject

Zu überprüfendes / zu konvertierendes Eingabeobjekt.

accept_sparsestr, bool oder list/tuple von str, default=False

Zeichenkette(n), die erlaubte sparse Matrix-Formate darstellen, wie z.B. ‘csc’, ‘csr’ usw. Wenn die Eingabe sparse, aber nicht im erlaubten Format ist, wird sie in das erste gelistete Format konvertiert. True erlaubt, dass die Eingabe jedes Format hat. False bedeutet, dass eine sparse Matrix-Eingabe einen Fehler auslöst.

accept_large_sparsebool, default=True

Wenn eine CSR-, CSC-, COO- oder BSR-sparse Matrix bereitgestellt und von accept_sparse akzeptiert wird, führt accept_large_sparse=False dazu, dass sie nur akzeptiert wird, wenn ihre Indizes mit einem 32-Bit-dtype gespeichert sind.

Hinzugefügt in Version 0.20.

dtype‘numeric’, type, list von type oder None, default=’numeric’

Datentyp des Ergebnisses. Wenn None, wird der dtype der Eingabe beibehalten. Wenn “numeric”, wird der dtype beibehalten, es sei denn, array.dtype ist object. Wenn dtype eine Liste von Typen ist, wird die Konvertierung auf den ersten Typ nur dann durchgeführt, wenn der dtype der Eingabe nicht in der Liste enthalten ist.

order{‘F’, ‘C’} oder None, default=None

Ob ein Array zu fortran- oder c-style gezwungen wird. Wenn order None (Standard) ist, dann wird bei copy=False nichts über das Speicherlayout des Ausgabearrays sichergestellt; andernfalls (copy=True) wird das Speicherlayout des zurückgegebenen Arrays so nah wie möglich am ursprünglichen Array gehalten.

copybool, default=False

Ob eine erzwungene Kopie ausgelöst wird. Wenn copy=False, kann eine Konvertierung eine Kopie auslösen.

force_writeablebool, default=False

Ob das Ausgabearray schreibbar erzwungen werden soll. Wenn True, wird garantiert, dass das zurückgegebene Array schreibbar ist, was möglicherweise eine Kopie erfordert. Andernfalls wird die Schreibbarkeit des Eingabearrays beibehalten.

Hinzugefügt in Version 1.6.

ensure_all_finitebool oder ‘allow-nan’, Standard=True

Ob ein Fehler bei np.inf, np.nan, pd.NA im Array ausgelöst werden soll. Die Möglichkeiten sind

  • True: Alle Werte des Arrays werden zu endlichen Werten gezwungen.

  • False: Akzeptiert np.inf, np.nan, pd.NA im Array.

  • ‘allow-nan’: Akzeptiert nur np.nan und pd.NA Werte im Array. Werte dürfen nicht unendlich sein.

Hinzugefügt in Version 1.6: force_all_finite wurde in ensure_all_finite umbenannt.

ensure_non_negativebool, default=False

Stellen Sie sicher, dass das Array nur nicht-negative Werte enthält. Wenn True, löst ein Array, das negative Werte enthält, einen ValueError aus.

Hinzugefügt in Version 1.6.

ensure_2dbool, default=True

Ob ein ValueError ausgelöst werden soll, wenn das Array nicht 2D ist.

allow_ndbool, default=False

Ob array.ndim > 2 zugelassen werden soll.

ensure_min_samplesint, default=1

Stellen Sie sicher, dass das Array eine minimale Anzahl von Samples in seiner ersten Achse hat (Zeilen für ein 2D-Array). Die Einstellung auf 0 deaktiviert diese Überprüfung.

ensure_min_featuresint, default=1

Stellen Sie sicher, dass das 2D-Array eine minimale Anzahl von Merkmalen (Spalten) hat. Der Standardwert von 1 lehnt leere Datensätze ab. Diese Überprüfung wird nur dann durchgesetzt, wenn die Eingabedaten effektiv 2 Dimensionen haben oder ursprünglich 1D sind und ensure_2d True ist. Die Einstellung auf 0 deaktiviert diese Überprüfung.

estimatorstr oder Estimator-Instanz, default=None

Wenn übergeben, schließen Sie den Namen des Estimators in Warnmeldungen ein.

input_namestr, Standard=””

Der Datenname, der zur Erstellung der Fehlermeldung verwendet wird. Insbesondere wenn input_name "X" ist und die Daten NaN-Werte enthalten und allow_nan False ist, verweist die Fehlermeldung auf die Dokumentation des Imputers.

Hinzugefügt in Version 1.1.0.

Gibt zurück:
array_convertedobject

Das konvertierte und validierte Array.

Beispiele

>>> from sklearn.utils.validation import check_array
>>> X = [[1, 2, 3], [4, 5, 6]]
>>> X_checked = check_array(X)
>>> X_checked
array([[1, 2, 3], [4, 5, 6]])
Auf dieser Seite

Diese Seite