pandas.MultiIndex.to_flat_index

MultiIndex.to_flat_index(self)[source]

Convert a MultiIndex to an Index of Tuples containing the level values.

New in version 0.24.0.

Returns
pd.Index

Index with the MultiIndex data represented in Tuples.

Notes

This method will simply return the caller if called by anything other than a MultiIndex.

Examples

>>> index = pd.MultiIndex.from_product(
...     [['foo', 'bar'], ['baz', 'qux']],
...     names=['a', 'b'])
>>> index.to_flat_index()
Index([('foo', 'baz'), ('foo', 'qux'),
       ('bar', 'baz'), ('bar', 'qux')],
      dtype='object')
Scroll To Top