pandas.Index.factorize

Index.factorize(sort=False, na_sentinel=_NoDefault.no_default, use_na_sentinel=_NoDefault.no_default)[source]

Кодирование объекта как перечислимого типа или категориальной переменной.

Этот метод полезен для получения числового представления массива, когда важны только идентификация различных значений. factorize доступен как функция верхнего уровня pandas.factorize(), и как метод Series.factorize() и Index.factorize().

Параметры

sort:bool, по умолчанию False

Сортировка uniques и переупорядочивание codes для сохранения взаимосвязи.

na_sentinel:int или None, по умолчанию -1

Значение для обозначения «не найдено». Если None, NaN из значений не будет исключаться из уникальных значений.

Устарело начиная с версии 1.5.0: Аргумент na_sentinel устарел и будет удален в будущей версии pandas. Укажите use_na_sentinel как True или False.

Изменено в версии 1.1.2.

use_na_sentinel:bool, по умолчанию True

Если True, для значений NaN будет использоваться sentinel -1. Если False, значения NaN будут закодированы как неотрицательные целые числа, и NaN не будет исключаться из уникальных значений.

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

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

codes:ndarray

Целочисленный массив ndarray, который является индексатором в uniques. uniques.take(codes) будет иметь те же значения, что и values.

uniques:ndarray, Index или Categorical

Уникальные допустимые значения. Когда values — Categorical, uniques — Categorical. Когда values — другой объект pandas, возвращается Index. В противном случае возвращается одномерный массив ndarray.

Примечание

Даже если в values есть пропущенное значение, uniques его не будет содержать.

См. также

cut

Дискретизация массива с непрерывными значениями.

unique

Нахождение уникального значения в массиве.

Примечания

Для получения дополнительных примеров обратитесь к руководству пользователя.

Примеры

В этих примерах факторизация показана как метод верхнего уровня, например, pd.factorize(values). Результаты идентичны для методов, таких как Series.factorize().

>>> codes, uniques = pd.factorize(['b', 'b', 'a', 'c', 'b'])
>>> codes
array([0, 0, 1, 2, 0]...)
>>> uniques
array(['b', 'a', 'c'], dtype=object)

При sort=True, uniques будет отсортирован, а codes будет переупорядочен, чтобы сохранить взаимосвязь.

>>> codes, uniques = pd.factorize(['b', 'b', 'a', 'c', 'b'], sort=True)
>>> codes
array([1, 1, 0, 2, 1]...)
>>> uniques
array(['a', 'b', 'c'], dtype=object)

Когда use_na_sentinel=True, (по умолчанию), пропущенные значения обозначаются в codes sentinel-значением -1, а пропущенные значения не включаются в uniques.

>>> codes, uniques = pd.factorize(['b', None, 'a', 'c', 'b'])
>>> codes
array([ 0, -1,  1,  2,  0]...)
>>> uniques
array(['b', 'a', 'c'], dtype=object)

До сих пор мы факторизовали только списки (которые внутренне преобразуются в массивы NumPy). При факторизации объектов pandas тип uniques будет отличаться. Для Categorical возвращается Categorical.

>>> cat = pd.Categorical(['a', 'a', 'c'], categories=['a', 'b', 'c'])
>>> codes, uniques = pd.factorize(cat)
>>> codes
array([0, 0, 1]...)
>>> uniques
['a', 'c']
Categories (3, object): ['a', 'b', 'c']

Обратите внимание, что 'b' находится в uniques.categories, несмотря на то, что его нет в cat.values.

Для всех других объектов pandas возвращается индекс соответствующего типа.

>>> cat = pd.Series(['a', 'a', 'c'])
>>> codes, uniques = pd.factorize(cat)
>>> codes
array([0, 0, 1]...)
>>> uniques
Index(['a', 'c'], dtype='object')

Если NaN находится в значениях, и мы хотим включить NaN в уникальных значениях, это можно сделать, установив use_na_sentinel=False.

>>> values = np.array([1, 2, 1, np.nan])
>>> codes, uniques = pd.factorize(values)  # default: use_na_sentinel=True
>>> codes
array([ 0,  1,  0, -1])
>>> uniques
array([1., 2.])

>>> codes, uniques = pd.factorize(values, use_na_sentinel=False)
>>> codes
array([0, 1, 0, 2])
>>> uniques
array([ 1.,  2., nan])