check_array

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

Валидация входного массива, списка, разреженной матрицы или аналогичного.

По умолчанию вход проверяется на то, является ли он непустым двумерным массивом, содержащим только конечные значения. Если тип данных массива object, то выполняется попытка преобразования к типу float, при ошибке генерируется исключение.

Параметры:

arrayобъект

Входной объект для проверки/преобразования.

accept_sparseстрока, булево значение или список/кортеж строк, по умолчанию False

Строка[и], представляющая разрешенные форматы разреженных матриц, такие как ‘csc’, ‘csr’ и т. д. Если вход разреженный, но не в разрешенном формате, он будет преобразован в первый перечисленный формат. True означает, что вход может быть любого формата. False означает, что разреженный вход будет вызывать ошибку.

accept_large_sparsebool, по умолчанию True

Если в качестве входного значения используется разреженная матрица CSR, CSC, COO или BSR и она принимается accept_sparse, accept_large_sparse=False приведет к ее принятию только в том случае, если ее индексы хранятся с целочисленным типом данных 32 бита.

Добавлена в версии 0.20.

dtype‘numeric’, тип, список типов или None, по умолчанию ‘numeric’

Тип данных результата. Если None, сохраняется тип данных входных данных. Если “numeric”, тип данных сохраняется, если только тип данных array не является object. Если dtype является списком типов, преобразование первого типа выполняется только в том случае, если тип данных входных данных не содержится в списке.

order{‘F’, ‘C’} или None, по умолчанию None

Определяет, будет ли массив принудительно преобразован в формат Fortran или C. Когда order равен None (по умолчанию), если copy=False, ничего не гарантируется относительно расположения памяти выходного массива; в противном случае (copy=True) расположение памяти возвращаемого массива сохраняется как можно ближе к исходному массиву.

copybool, по умолчанию False

Определяет, будет ли вызвана принудительная копия. Если copy=False, копия может быть вызвана преобразованием.

force_writeablebool, по умолчанию False

Определяет, необходимо ли принудительно сделать выходной массив доступным для записи. Если True, возвращаемый массив гарантированно будет доступным для записи, что может потребовать копирования. В противном случае сохраняется доступность входного массива для записи.

Добавлена в версии 1.6.

force_all_finitebool или ‘allow-nan’, по умолчанию True

Определяет, следует ли генерировать ошибку при наличии np.inf, np.nan, pd.NA в массиве. Возможные варианты:

• True: Все значения в массиве должны быть конечными.
• False: Принимает np.inf, np.nan, pd.NA в массиве.
• ‘allow-nan’: Принимает только np.nan и pd.NA значения в массиве. Значения не могут быть бесконечными.

Добавлена в версии 0.20: force_all_finite принимает строку 'allow-nan'.

Изменено в версии 0.23: Принимает pd.NA и преобразует его в np.nan

Устарело начиная с версии 1.6: force_all_finite было переименовано в ensure_all_finite и будет удалено в версии 1.8.

ensure_all_finitebool или ‘allow-nan’, по умолчанию True

Определяет, следует ли генерировать ошибку при наличии np.inf, np.nan, pd.NA в массиве. Возможные варианты:

• True: Все значения в массиве должны быть конечными.
• False: Принимает np.inf, np.nan, pd.NA в массиве.
• ‘allow-nan’: Принимает только np.nan и pd.NA значения в массиве. Значения не могут быть бесконечными.

Добавлена в версии 1.6: force_all_finite было переименовано в ensure_all_finite.

ensure_non_negativebool, по умолчанию False

Убедитесь, что массив содержит только неотрицательные значения. Если True, массив, содержащий отрицательные значения, вызовет ValueError.

Добавлена в версии 1.6.

ensure_2dbool, по умолчанию True

Указывает, следует ли генерировать ошибку, если массив не двумерный.

allow_ndbool, по умолчанию False

Разрешает ли массив иметь ndim > 2.

ensure_min_samplesint, по умолчанию 1

Убедитесь, что массив имеет минимальное количество образцов в первой оси (строки для двумерного массива). Установка в 0 отключает эту проверку.

ensure_min_featuresint, по умолчанию 1

Убедитесь, что двумерный массив имеет минимальное количество признаков (столбцов). Значение по умолчанию 1 отбрасывает пустые наборы данных. Эта проверка выполняется только тогда, когда входные данные имеют эффективно 2 измерения или изначально являются одномерными и ensure_2d равно True. Установка в 0 отключает эту проверку.

estimatorстрока или экземпляр оценщика, по умолчанию None

Если указано, включите имя оценщика в сообщения об ошибках.

input_nameстрока, по умолчанию “”

Имя данных, используемое для создания сообщения об ошибке. В частности, если input_name равно “X”, а данные содержат значения NaN и allow_nan равно False, сообщение об ошибке будет ссылаться на документацию по обработчику пропусков.

Добавлена в версии 1.1.0.

Возвращаемое значение:

array_convertedобъект

Преобразованный и проверенный массив.

Примеры

>>> 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]])

Примеры галереи

Основные моменты выпуска scikit-learn 1.6