mars.dataframe.Index.rename

Index.rename(name, inplace=False)

更改索引或多重索引的名称。

能够在没有级别的情况下设置新名称。默认为返回新索引。
名称的长度必须与MultiIndex中的级别数量匹配。

Parameters

• name (标签 或 列表 的 标签) – 要设置的名称。

• inplace (bool, default False) – 直接修改对象，而不是创建一个新的 Index 或 MultiIndex。

Returns

如果 inplace 为真，则与调用者相同的类型或 None。

Return type

索引

另请参阅

Index.set_names

能够按层级部分设置新名称。

示例

>>> import mars.dataframe as md
>>> idx = md.Index(['A', 'C', 'A', 'B'], name='score')
>>> idx.rename('grade').execute()
Index(['A', 'C', 'A', 'B'], dtype='object', name='grade')

>>> idx = md.Index([('python', 2018),
...                 ('python', 2019),
...                 ('cobra', 2018),
...                 ('cobra', 2019)],
...                names=['kind', 'year'])
>>> idx.execute()
MultiIndex([('python', 2018),
            ('python', 2019),
            ( 'cobra', 2018),
            ( 'cobra', 2019)],
           names=['kind', 'year'])
>>> idx.rename(['species', 'year']).execute()
MultiIndex([('python', 2018),
            ('python', 2019),
            ( 'cobra', 2018),
            ( 'cobra', 2019)],
           names=['species', 'year'])
>>> idx.rename('species').execute()
Traceback (most recent call last):
TypeError: Must pass list-like as `names`.