check_X_y

sklearn.utils.check_X_y(X, y, accept_sparse=False, *, accept_large_sparse=True, dtype='numeric', order=None, copy=False, force_writeable=False, ensure_all_finite=True, ensure_2d=True, allow_nd=False, multi_output=False, ensure_min_samples=1, ensure_min_features=1, y_numeric=False, estimator=None)[исходный код]

Проверка входных данных для стандартных оценивателей.

Проверяет согласованность длины X и y, требует, чтобы X был двумерным, а y — одномерным. По умолчанию проверяется, что X не пуст и содержит только конечные значения. Для y также выполняются стандартные проверки входных данных, например проверка на отсутствие целевых значений np.nan или np.inf. Для y с несколькими метками задайте multi_output=True, чтобы разрешить двумерный и разреженный y. Если dtype массива X — object, предпринимается попытка преобразовать его в float; в случае неудачи возникает ошибка.

Параметры:

X{ndarray, list, sparse matrix}

Входные данные.

y{ndarray, list, sparse matrix}

Метки.

accept_sparsestr, bool or list of str, default=False

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

accept_large_sparsebool, default=True

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

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

dtype‘numeric’, type, list of type or None, default=’numeric’

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

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

Определяет, будет ли массив принудительно приведён к формату Fortran или C. Если указано None, порядок входных данных по возможности сохраняется.

copybool, default=False

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

force_writeablebool, default=False

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

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

ensure_all_finitebool or ‘allow-nan’, default=True

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

• True: требовать, чтобы все значения X были конечными.
• False: разрешать значения np.inf, np.nan и pd.NA в X.
• ‘allow-nan’: разрешать в X только значения np.nan или pd.NA. Бесконечные значения недопустимы.

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

ensure_2dbool, default=True

Определяет, нужно ли вызывать ошибку значения, если X не является двумерным.

allow_ndbool, default=False

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

multi_outputbool, default=False

Определяет, разрешён ли двумерный y (массив или разреженная матрица). Если значение False, y будет проверен как вектор. Если multi_output=True, y не может содержать значения np.nan или np.inf.

ensure_min_samplesint, default=1

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

ensure_min_featuresint, default=1

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

y_numericbool, default=False

Определяет, нужно ли проверять, что y имеет числовой тип. Если тип данных y — object, он преобразуется в float64. Следует использовать только для алгоритмов регрессии.

estimatorstr or estimator instance, default=None

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

Возвращает:

X_convertedobject

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

y_convertedobject

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

Примеры

>>> from sklearn.utils.validation import check_X_y
>>> X = [[1, 2], [3, 4], [5, 6]]
>>> y = [1, 2, 3]
>>> X, y = check_X_y(X, y)
>>> X
array([[1, 2],
      [3, 4],
      [5, 6]])
>>> y
array([1, 2, 3])