pandas.Index.factorize

Index.factorize(sort=False, use_na_sentinel=True)[source]

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

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

Параметры:

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

Сортировка uniques и перестановка codes для поддержания связи.

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

Если True, то sentinel -1 будет использоваться для значений NaN. Если 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

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

Примечания

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

Примеры

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

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

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

>>> codes, uniques = pd.factorize(np.array(['b', 'b', 'a', 'c', 'b'], dtype="O"),
...                               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(np.array(['b', None, 'a', 'c', 'b'], dtype="O"))
>>> 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])