pandas 1.4.2

NotesParametersReturnsBackRef
sample(self: 'NDFrameT', n: 'int | None' = None, frac: 'float | None' = None, replace: 'bool_t' = False, weights=None, random_state: 'RandomState | None' = None, axis: 'Axis | None' = None, ignore_index: 'bool_t' = False) -> 'NDFrameT'

You can use random_state for reproducibility.

Notes

If frac > 1, :None:None:`replacement` should be set to :None:None:`True`.

Parameters

n : int, optional

Number of items from axis to return. Cannot be used with frac . Default = 1 if frac = None.

frac : float, optional

Fraction of axis items to return. Cannot be used with n.

replace : bool, default False

Allow or disallow sampling of the same row more than once.

weights : str or ndarray-like, optional

Default 'None' results in equal probability weighting. If passed a Series, will align with target object on index. Index values in weights not found in sampled object will be ignored and index values in sampled object not in weights will be assigned weights of zero. If called on a DataFrame, will accept the name of a column when axis = 0. Unless weights are a Series, weights must be same length as axis being sampled. If weights do not sum to 1, they will be normalized to sum to 1. Missing values in the weights column will be treated as zero. Infinite values not allowed.

random_state : int, array-like, BitGenerator, np.random.RandomState, np.random.Generator, optional

If int, array-like, or BitGenerator, seed for random number generator. If np.random.RandomState or np.random.Generator, use as given.

versionchanged

array-like and BitGenerator object now passed to np.random.RandomState() as seed

versionchanged

np.random.Generator objects now accepted

axis : {0 or ‘index’, 1 or ‘columns’, None}, default None

Axis to sample. Accepts axis number or name. Default is stat axis for given data type (0 for Series and DataFrames).

ignore_index : bool, default False

If True, the resulting index will be labeled 0, 1, …, n - 1.

versionadded

Returns

Series or DataFrame

A new object of same type as caller containing n items randomly sampled from the caller object.

Return a random sample of items from an axis of object.

See Also

DataFrameGroupBy.sample

Generates random samples from each group of a DataFrame object.

SeriesGroupBy.sample

Generates random samples from each group of a Series object.

numpy.random.choice

Generates a random sample from a given 1-D numpy array.

Examples

This example is valid syntax, but we were not able to check execution
>>> df = pd.DataFrame({'num_legs': [2, 4, 8, 0],
...  'num_wings': [2, 0, 0, 0],
...  'num_specimen_seen': [10, 2, 1, 8]},
...  index=['falcon', 'dog', 'spider', 'fish'])
... df num_legs num_wings num_specimen_seen falcon 2 2 10 dog 4 0 2 spider 8 0 1 fish 0 0 8

Extract 3 random elements from the Series df['num_legs'] : Note that we use random_state to ensure the reproducibility of the examples.

This example is valid syntax, but we were not able to check execution
>>> df['num_legs'].sample(n=3, random_state=1)
fish      0
spider    8
falcon    2
Name: num_legs, dtype: int64

A random 50% sample of the DataFrame with replacement:

This example is valid syntax, but we were not able to check execution
>>> df.sample(frac=0.5, replace=True, random_state=1)
      num_legs  num_wings  num_specimen_seen
dog          4          0                  2
fish         0          0                  8

An upsample sample of the DataFrame with replacement: Note that :None:None:`replace` parameter has to be :None:None:`True` for frac parameter > 1.

This example is valid syntax, but we were not able to check execution
>>> df.sample(frac=2, replace=True, random_state=1)
        num_legs  num_wings  num_specimen_seen
dog            4          0                  2
fish           0          0                  8
falcon         2          2                 10
falcon         2          2                 10
fish           0          0                  8
dog            4          0                  2
fish           0          0                  8
dog            4          0                  2

Using a DataFrame column as weights. Rows with larger value in the :None:None:`num_specimen_seen` column are more likely to be sampled.

This example is valid syntax, but we were not able to check execution
>>> df.sample(n=2, weights='num_specimen_seen', random_state=1)
        num_legs  num_wings  num_specimen_seen
falcon         2          2                 10
fish           0          0                  8
See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

pandas.core.sample.process_sampling_size pandas.core.sample.preprocess_weights

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/generic.py#5299
type: <class 'function'>
Commit: