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='')[исходный код]

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

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

Параметры:

arrayobject

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

accept_sparsestr, bool или список/кортеж str, по умолчанию=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.dtype не равен 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.

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

Определяет, разрешено ли array.ndim > 2.

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

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

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

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

estimatorstr или экземпляр оценивателя, по умолчанию=None

Если параметр задан, имя оценивателя будет включено в предупреждающие сообщения.

input_namestr, по умолчанию=””

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

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

Возвращает:

array_convertedobject

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

Примеры

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