docarray.array.mixins.sample module

class docarray.array.mixins.sample.SampleMixin

Bases: object

A mixin that provides search functionality to DocumentArrays

sample(k, seed=None)

random sample k elements from DocumentArray without replacement.

Parameters:

• k (int) – Number of elements to sample from the document array.

• seed (Optional[int]) – initialize the random number generator, by default is None. If set will save the state of the random function to produce certain outputs.

Return type:

DocumentArray

Returns:

A sampled list of Document represented as DocumentArray.

shuffle(seed=None)

Randomly shuffle documents within the DocumentArray.

Parameters:

seed (Optional[int]) – initialize the random number generator, by default is None. If set will save the state of the random function to produce certain outputs.

Return type:

DocumentArray

Returns:

The shuffled list of Document represented as DocumentArray.