maxframe.dataframe.DataFrame.reset_index#

DataFrame.reset_index(level=None, drop=False, inplace=False, col_level=0, col_fill='', names=None, default_index_type: DefaultIndexType | str = None, **kwargs)#

重置索引，或索引的某个层级。

重置 DataFrame 的索引，并使用默认索引。如果 DataFrame 具有 MultiIndex，此方法可以移除一个或多个层级。

参数:

level (int, str, tuple, or list, default None) -- 仅从索引中移除指定的层级。默认移除所有层级。
drop (bool, default False) -- 不要尝试将索引插入到 DataFrame 的列中。此操作将索引重置为默认的整数索引。
inplace (bool, default False) -- 就地修改 DataFrame（不创建新对象）。
col_level (int or str, default 0) -- 如果列具有多个层级，则确定标签插入到哪一层级。默认插入到第一层级。
col_fill (object, default '') -- 如果列具有多个层级，则确定其他层级的命名方式。如果为 None，则重复使用索引名称。

返回:

具有新索引的 DataFrame，如果 inplace=True 则返回 None。

返回类型:

DataFrame or None

参见

DataFrame.set_index: reset_index 的反向操作。
DataFrame.reindex: 更改索引或扩展索引。
DataFrame.reindex_like: 将索引更改为与其他 DataFrame 相同。

示例

>>> import maxframe.tensor as mt
>>> import maxframe.dataframe as md
>>> df = md.DataFrame([('bird', 389.0),
...                    ('bird', 24.0),
...                    ('mammal', 80.5),
...                    ('mammal', mt.nan)],
...                   index=['falcon', 'parrot', 'lion', 'monkey'],
...                   columns=('class', 'max_speed'))
>>> df.execute()
         class  max_speed
falcon    bird      389.0
parrot    bird       24.0
lion    mammal       80.5
monkey  mammal        NaN

当我们重置索引时，旧索引将作为一列添加，同时使用新的顺序索引：

>>> df.reset_index().execute()
    index   class  max_speed
0  falcon    bird      389.0
1  parrot    bird       24.0
2    lion  mammal       80.5
3  monkey  mammal        NaN

我们可以使用 drop 参数来避免旧索引作为列添加：

>>> df.reset_index(drop=True).execute()
    class  max_speed
0    bird      389.0
1    bird       24.0
2  mammal       80.5
3  mammal        NaN

您也可以在 MultiIndex 上使用 reset_index。

>>> import pandas as pd
>>> index = pd.MultiIndex.from_tuples([('bird', 'falcon'),
...                                    ('bird', 'parrot'),
...                                    ('mammal', 'lion'),
...                                    ('mammal', 'monkey')],
...                                   names=['class', 'name'])
>>> columns = pd.MultiIndex.from_tuples([('speed', 'max'),
...                                      ('species', 'type')])
>>> df = md.DataFrame([(389.0, 'fly'),
...                    ( 24.0, 'fly'),
...                    ( 80.5, 'run'),
...                    (mt.nan, 'jump')],
...                   index=index,
...                   columns=columns)
>>> df.execute()
               speed species
                 max    type
class  name
bird   falcon  389.0     fly
       parrot   24.0     fly
mammal lion     80.5     run
       monkey    NaN    jump

如果索引具有多个层级，我们可以重置其中的一部分：

>>> df.reset_index(level='class').execute()
         class  speed species
                  max    type
name
falcon    bird  389.0     fly
parrot    bird   24.0     fly
lion    mammal   80.5     run
monkey  mammal    NaN    jump

如果我们不删除索引，默认情况下它会被放置在顶层。我们可以将其放置在其他层级：

>>> df.reset_index(level='class', col_level=1).execute()
                speed species
         class    max    type
name
falcon    bird  389.0     fly
parrot    bird   24.0     fly
lion    mammal   80.5     run
monkey  mammal    NaN    jump

当索引插入到另一个层级之下时，可以通过 col_fill 参数指定具体层级：

>>> df.reset_index(level='class', col_level=1, col_fill='species').execute()
              species  speed species
                class    max    type
name
falcon           bird  389.0     fly
parrot           bird   24.0     fly
lion           mammal   80.5     run
monkey         mammal    NaN    jump

如果我们为 col_fill 指定一个不存在的层级，则会创建该层级：

>>> df.reset_index(level='class', col_level=1, col_fill='genus').execute()
                genus  speed species
                class    max    type
name
falcon           bird  389.0     fly
parrot           bird   24.0     fly
lion           mammal   80.5     run
monkey         mammal    NaN    jump