Skip to content

DOC: Improved the docstring of pandas.Series.sample #20109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 15, 2018
Merged

DOC: Improved the docstring of pandas.Series.sample #20109

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
837c263
DOC: Improved the docstring of pandas.Series.sample
Mar 10, 2018
170eabf
remove see also (they are pointing to themselves)
jorisvandenbossche Mar 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3718,7 +3718,9 @@ def tail(self, n=5):
def sample(self, n=None, frac=None, replace=False, weights=None,
random_state=None, axis=None):
"""
Returns a random sample of items from an axis of object.
Return a random sample of items from an axis of object.

You can use `random_state` for reproducibility.

Parameters
----------
Expand Down Expand Up @@ -3755,7 +3757,6 @@ def sample(self, n=None, frac=None, replace=False, weights=None,

Examples
--------

Generate an example ``Series`` and ``DataFrame``:

>>> s = pd.Series(np.random.randn(50))
Expand Down Expand Up @@ -3794,6 +3795,16 @@ def sample(self, n=None, frac=None, replace=False, weights=None,
40 0.823173 -0.078816 1.009536 1.015108
15 1.421154 -0.055301 -1.922594 -0.019696
6 -0.148339 0.832938 1.787600 -1.383767

You can use `random state` for reproducibility:

>>> df.sample(random_state=1)
A B C D
37 -2.027662 0.103611 0.237496 -0.165867
43 -0.259323 -0.583426 1.516140 -0.479118
12 -1.686325 -0.579510 0.985195 -0.460286
8 1.167946 0.429082 1.215742 -1.636041
9 1.197475 -0.864188 1.554031 -1.505264
"""

if axis is None:
Expand Down