Class SamplingOptions (2.25.0)

SamplingOptions(
 max_download_size: typing.Optional[int] = 500,
 enable_downsampling: bool = False,
 sampling_method: typing.Literal["head", "uniform"] = "uniform",
 random_state: typing.Optional[int] = None,
)

Encapsulates the configuration for data sampling.

Attributes
Name	Description
`max_download_size`	`int, default 500` Download size threshold in MB. If value set to None, the download size won't be checked.
`enable_downsampling`	`bool, default False` Whether to enable downsampling, If max_download_size is exceeded when downloading data (e.g., to_pandas()), the data will be downsampled if enable_downsampling is True, otherwise, an error will be raised.
`sampling_method`	`str, default "uniform"` Downsampling algorithms to be chosen from, the choices are: "head": This algorithm returns a portion of the data from the beginning. It is fast and requires minimal computations to perform the downsampling.; "uniform": This algorithm returns uniform random samples of the data.
`random_state`	`int, default None` The seed for the uniform downsampling algorithm. If provided, the uniform method may take longer to execute and require more computation.

Methods

with_disabled

with_disabled() -> bigframes._config.sampling_options.SamplingOptions

Configures whether to disable downsampling

Returns
Type	Description
`bigframes._config.sampling_options.SamplingOptions`	The configuration for data sampling.

with_max_download_size

with_max_download_size(
 max_rows: typing.Optional[int],
) -> bigframes._config.sampling_options.SamplingOptions

Configures the maximum download size for data sampling in MB

Parameter
Name	Description
`max_rows`	`None or int` An int value for the maximum row size.

Returns
Type	Description
`bigframes._config.sampling_options.SamplingOptions`	The configuration for data sampling.

with_method

with_method(
 method: typing.Literal["head", "uniform"],
) -> bigframes._config.sampling_options.SamplingOptions

Configures the downsampling algorithms to be chosen from

Parameter
Name	Description
`method`	`None or Literal` A literal string value of either head or uniform data sampling method.

Returns
Type	Description
`bigframes._config.sampling_options.SamplingOptions`	The configuration for data sampling.

with_random_state

with_random_state(
 state: typing.Optional[int],
) -> bigframes._config.sampling_options.SamplingOptions

Configures the seed for the uniform downsampling algorithm

Parameter
Name	Description
`state`	`None or int` An int value for the data sampling random state

Returns
Type	Description
`bigframes._config.sampling_options.SamplingOptions`	The configuration for data sampling.

Class SamplingOptions (2.25.0) Stay organized with collections Save and categorize content based on your preferences.

Attributes