Method sample

src/danfojs-base/core/series.ts:212–226

* Returns specified number of random rows in a Series * @param num The number of rows to return * @param options.seed An integer specifying the random seed that will be used to create the distribution. * @example * ``` * const df = new Series([1, 2, 3, 4]) * const df2 =

(num = 5, options?: { seed?: number })

     * ```   
    */
    async sample(num = 5, options?: { seed?: number }): Promise<Series> {
        const { seed } = { seed: 1, ...options }

        if (num > this.shape[0]) {
            throw new Error("Sample size n cannot be bigger than size of dataset");
        }
        if (num < -1 || num == 0) {
            throw new Error("Sample size cannot be less than -1 or be equal to 0");
        }
        num = num === -1 ? this.shape[0] : num;

        const shuffledIndex = await tensorflow.data.array(this.index).shuffle(num, `${seed}`).take(num).toArray();
        const sf = this.iloc(shuffledIndex);
        return sf;
    }

    /**
      * Return Addition of series and other, element-wise (binary operator add).