Danger

You are looking at the documentation for an older version of the SDV! We are no longer supporting or maintaining this version of the software

Click here to go to the new docs pages.

sdv.tabular.ctgan.TVAE.sample_conditions

TVAE.sample_conditions(conditions, max_tries_per_batch=100, batch_size=None, randomize_samples=True, output_file_path=None)

Sample rows from this table with the given conditions.

Parameters

  • conditions (list[sdv.sampling.Condition]) – A list of sdv.sampling.Condition objects, which specify the column values in a condition, along with the number of rows for that condition.

  • max_tries_per_batch (int) – Number of times to retry sampling until the batch size is met. Defaults to 100.

  • batch_size (int) – The batch size to use per sampling call.

  • randomize_samples (bool) – Whether or not to use a fixed seed when sampling. Defaults to True.

  • output_file_path (str or None) – The file to periodically write sampled rows to. Defaults to a temporary file, if None.

Returns

Sampled data.

Return type

pandas.DataFrame

Raises

  • ConstraintsNotMetError – If the conditions are not valid for the given constraints.

  • ValueError – If any of the following happens: * any of the conditions’ columns are not valid. * no rows could be generated.

sdv.tabular.ctgan.TVAE.sample sdv.tabular.ctgan.TVAE.sample_remaining_columns