mars.dataframe.DataFrame.rename_axis#

DataFrame.rename_axis(mapper=None, index=None, columns=None, axis=0, copy=True, inplace=False)#

设置索引或列的轴名称。

Parameters

mapper (标量, 类似列表, 可选) – 用于设置轴名称属性的值。
index (标量, 列表型, 字典型 或函数, 可选) –
一个标量、列表型、字典型或函数变换，用于应用于该轴的值。请注意，如果对象是Series，则不允许使用columns参数。此参数仅适用于DataFrame类型的对象。

使用mapper和axis来指定要使用mapper的目标轴，或index和/或columns。
columns (标量, 类列表, 类字典 或函数, 可选) –
一个标量、类列表、类字典或函数变换，用于应用于该轴的值。请注意，如果对象是一个 Series，则不允许使用 columns 参数。此参数仅适用于 DataFrame 类型的对象。

使用 mapper 和 axis 指定要针对的轴，或者使用 index 和/或 columns。
axis ({0 或 'index', 1 或 'columns'}, 默认 0) – 要重命名的轴。
copy (bool, 默认值为 True) – 还会复制基础数据。
inplace (bool, default False) – 直接修改对象，而不是创建一个新的 Series 或 DataFrame。

Returns

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

Return type

系列, 数据框, 或者无

另请参阅

Series.rename: 更改系列索引标签或名称。
DataFrame.rename: 更改 DataFrame 的索引标签或名称。
Index.rename: 为索引设置新名称。

备注

DataFrame.rename_axis 支持两种调用方式

(index=index_mapper, columns=columns_mapper, ...)
(mapper, axis={'index', 'columns'}, ...)

第一个调用约定将仅修改索引的名称和/或作为列的索引对象的名称。在这种情况下，参数 copy 被忽略。

第二种调用约定将修改对应索引的名称，如果映射器是列表或标量。然而，如果映射器是类似字典或函数，它将使用已弃用的行为来修改轴标签。

我们强烈推荐使用关键字参数来明确您的意图。

示例

系列

>>> import mars.dataframe as md
>>> s = md.Series(["dog", "cat", "monkey"])
>>> s.execute()
0       dog
1       cat
2    monkey
dtype: object
>>> s.rename_axis("animal").execute()
animal
0    dog
1    cat
2    monkey
dtype: object

数据框

>>> df = md.DataFrame({"num_legs": [4, 4, 2],
...                    "num_arms": [0, 0, 2]},
...                   ["dog", "cat", "monkey"])
>>> df.execute()
        num_legs  num_arms
dog            4         0
cat            4         0
monkey         2         2
>>> df = df.rename_axis("animal")
>>> df.execute()
        num_legs  num_arms
animal
dog            4         0
cat            4         0
monkey         2         2
>>> df = df.rename_axis("limbs", axis="columns")
>>> df.execute()
limbs   num_legs  num_arms
animal
dog            4         0
cat            4         0
monkey         2         2