pandas 1.4.2

NotesParametersReturns
nlargest(self, n: 'int' = 5, keep: 'str' = 'first')

Notes

Faster than .sort_values(ascending=False).head(n) for small n relative to the size of the Series object.

Parameters

n : int, default 5

Return this many descending sorted values.

keep : {'first', 'last', 'all'}, default 'first'

When there are duplicate values that cannot all fit in a Series of n elements:

Returns

Series

The n largest values in the Series, sorted in decreasing order.

Return the largest n elements.

See Also

Series.head

Return the first :None:None:`n` rows.

Series.nsmallest

Get the :None:None:`n` smallest elements.

Series.sort_values

Sort Series by values.

Examples

This example is valid syntax, but we were not able to check execution
>>> countries_population = {"Italy": 59000000, "France": 65000000,
...  "Malta": 434000, "Maldives": 434000,
...  "Brunei": 434000, "Iceland": 337000,
...  "Nauru": 11300, "Tuvalu": 11300,
...  "Anguilla": 11300, "Montserrat": 5200}
... s = pd.Series(countries_population)
... s Italy 59000000 France 65000000 Malta 434000 Maldives 434000 Brunei 434000 Iceland 337000 Nauru 11300 Tuvalu 11300 Anguilla 11300 Montserrat 5200 dtype: int64

The n largest elements where n=5 by default.

This example is valid syntax, but we were not able to check execution
>>> s.nlargest()
France      65000000
Italy       59000000
Malta         434000
Maldives      434000
Brunei        434000
dtype: int64

The n largest elements where n=3 . Default :None:None:`keep` value is 'first' so Malta will be kept.

This example is valid syntax, but we were not able to check execution
>>> s.nlargest(3)
France    65000000
Italy     59000000
Malta       434000
dtype: int64

The n largest elements where n=3 and keeping the last duplicates. Brunei will be kept since it is the last with value 434000 based on the index order.

This example is valid syntax, but we were not able to check execution
>>> s.nlargest(3, keep='last')
France      65000000
Italy       59000000
Brunei        434000
dtype: int64

The n largest elements where n=3 with all duplicates kept. Note that the returned Series has five elements due to the three duplicates.

This example is valid syntax, but we were not able to check execution
>>> s.nlargest(3, keep='all')
France      65000000
Italy       59000000
Malta         434000
Maldives      434000
Brunei        434000
dtype: int64
See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /pandas/core/groupby/generic.py#744
type: <class 'function'>
Commit: