Interface Sample<T>

sample

• sample(
      n?: number,
      frac?: number,
      withReplacement?: boolean,
      seed?: number | bigint,
      shuffle?: boolean,
  ): T

  Sample from this DataFrame by setting either n or frac.

  Parameters

  • Optionaln: number

    Number of samples < self.len() .

  • Optionalfrac: number

    Fraction between 0.0 and 1.0 .

  • OptionalwithReplacement: boolean

    Sample with replacement.

  • Optionalseed: number | bigint

    Seed initialization. If not provided, a random seed will be used

  • Optionalshuffle: boolean

    Shuffle the order of sampled data points.

  Returns T

  Example

  > df = pl.DataFrame({
  >   "foo": [1, 2, 3],
  >   "bar": [6, 7, 8],
  >   "ham": ['a', 'b', 'c']
  > })
  > df.sample({n: 2})
  shape: (2, 3)
  ╭─────┬─────┬─────╮
  │ foo ┆ bar ┆ ham │
  │ --- ┆ --- ┆ --- │
  │ i64 ┆ i64 ┆ str │
  ╞═════╪═════╪═════╡
  │ 1   ┆ 6   ┆ "a" │
  ├╌╌╌╌╌┼╌╌╌╌╌┼╌╌╌╌╌┤
  │ 3   ┆ 8   ┆ "c" │
  ╰─────┴─────┴─────╯
  Copy

• sample(
      opts?: {
          n: number;
          seed?: number | bigint;
          shuffle?: boolean;
          withReplacement?: boolean;
      },
  ): T

  Parameters

  • Optionalopts: {
        n: number;
        seed?: number | bigint;
        shuffle?: boolean;
        withReplacement?: boolean;
    }

  Returns T

• sample(
      opts?: {
          frac: number;
          seed?: number | bigint;
          shuffle?: boolean;
          withReplacement?: boolean;
      },
  ): T

  Parameters

  • Optionalopts: {
        frac: number;
        seed?: number | bigint;
        shuffle?: boolean;
        withReplacement?: boolean;
    }

  Returns T