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.
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.
In this guide we will go through a series of steps that will let you discover functionalities of the CopulaGAN model, including how to:
CopulaGAN
Create an instance of CopulaGAN.
Fit the instance to your data.
Generate synthetic versions of your data.
Use CopulaGAN to anonymize PII information.
Specify the column distributions to improve the output quality.
Specify hyperparameters to improve the output quality.
The sdv.tabular.CopulaGAN model is a variation of the CTGAN Model which takes advantage of the CDF based transformation that the GaussianCopulas apply to make the underlying CTGAN model task of learning the data easier.
sdv.tabular.CopulaGAN
Let’s now discover how to learn a dataset and later on generate synthetic data with the same format and statistical properties by using the CopulaGAN class from SDV.
We will start by loading one of our demo datasets, the student_placements, which contains information about MBA students that applied for placements during the year 2020.
student_placements
Warning
In order to follow this guide you need to have ctgan installed on your system. If you have not done it yet, please install ctgan now by executing the command pip install sdv in a terminal.
ctgan
pip install sdv
In [1]: from sdv.demo import load_tabular_demo In [2]: data = load_tabular_demo('student_placements') In [3]: data.head() Out[3]: student_id gender second_perc high_perc high_spec degree_perc degree_type work_experience experience_years employability_perc mba_spec mba_perc salary placed start_date end_date duration 0 17264 M 67.00 91.00 Commerce 58.00 Sci&Tech False 0 55.0 Mkt&HR 58.80 27000.0 True 2020-07-23 2020-10-12 3.0 1 17265 M 79.33 78.33 Science 77.48 Sci&Tech True 1 86.5 Mkt&Fin 66.28 20000.0 True 2020-01-11 2020-04-09 3.0 2 17266 M 65.00 68.00 Arts 64.00 Comm&Mgmt False 0 75.0 Mkt&Fin 57.80 25000.0 True 2020-01-26 2020-07-13 6.0 3 17267 M 56.00 52.00 Science 52.00 Sci&Tech False 0 66.0 Mkt&HR 59.43 NaN False NaT NaT NaN 4 17268 M 85.80 73.60 Commerce 73.30 Comm&Mgmt False 0 96.8 Mkt&Fin 55.50 42500.0 True 2020-07-04 2020-09-27 3.0
As you can see, this table contains information about students which includes, among other things:
Their id and gender
Their grades and specializations
Their work experience
The salary that they were offered
The duration and dates of their placement
You will notice that there is data with the following characteristics:
There are float, integer, boolean, categorical and datetime values.
There are some variables that have missing data. In particular, all the data related to the placement details is missing in the rows where the student was not placed.
Let us use CopulaGAN to learn this data and then sample synthetic data about new students to see how well the model captures the characteristics indicated above. In order to do this you will need to:
Import the sdv.tabular.CopulaGAN class and create an instance of it.
Call its fit method passing our table.
fit
Call its sample method indicating the number of synthetic rows that you want to generate.
sample
In [4]: from sdv.tabular import CopulaGAN In [5]: model = CopulaGAN() In [6]: model.fit(data)
Note
Notice that the model fitting process took care of transforming the different fields using the appropriate Reversible Data Transforms to ensure that the data has a format that the underlying CTGAN class can handle.
fitting
Once the modeling has finished you are ready to generate new synthetic data by calling the sample method from your model passing the number of rows that we want to generate. The number of rows (num_rows) is a required parameter.
num_rows
In [7]: new_data = model.sample(num_rows=200)
This will return a table identical to the one which the model was fitted on, but filled with new data which resembles the original one.
In [8]: new_data.head() Out[8]: student_id gender second_perc high_perc high_spec degree_perc degree_type work_experience experience_years employability_perc mba_spec mba_perc salary placed start_date end_date duration 0 17266 F 79.54 64.74 Science 54.65 Comm&Mgmt False 0 71.11 Mkt&Fin 54.60 NaN False 2020-03-12 NaT NaN 1 17471 M 75.74 91.20 Commerce 80.08 Sci&Tech False 2 59.51 Mkt&Fin 75.52 NaN True NaT 2020-11-21 6.0 2 17393 F 55.46 74.45 Science 82.48 Others False 0 60.65 Mkt&HR 68.65 34022.0 True NaT NaT NaN 3 17404 M 86.21 83.06 Commerce 58.89 Others False 2 51.48 Mkt&HR 68.87 NaN True 2020-07-26 NaT NaN 4 17477 F 60.03 66.86 Science 65.29 Sci&Tech False 0 96.52 Mkt&HR 77.89 31009.0 False NaT NaT NaN
There are a number of other parameters in this method that you can use to optimize the process of generating synthetic data. Use output_file_path to directly write results to a CSV file, batch_size to break up sampling into smaller pieces & track their progress and randomize_samples to determine whether to generate the same synthetic data every time. See the API section for more details.
output_file_path
batch_size
randomize_samples
In many scenarios it will be convenient to generate synthetic versions of your data directly in systems that do not have access to the original data source. For example, if you may want to generate testing data on the fly inside a testing environment that does not have access to your production database. In these scenarios, fitting the model with real data every time that you need to generate new data is feasible, so you will need to fit a model in your production environment, save the fitted model into a file, send this file to the testing environment and then load it there to be able to sample from it.
Let’s see how this process works.
Once you have fitted the model, all you need to do is call its save method passing the name of the file in which you want to save the model. Note that the extension of the filename is not relevant, but we will be using the .pkl extension to highlight that the serialization protocol used is cloudpickle.
save
.pkl
In [9]: model.save('my_model.pkl')
This will have created a file called my_model.pkl in the same directory in which you are running SDV.
my_model.pkl
Important
If you inspect the generated file you will notice that its size is much smaller than the size of the data that you used to generate it. This is because the serialized model contains no information about the original data, other than the parameters it needs to generate synthetic versions of it. This means that you can safely share this my_model.pkl file without the risc of disclosing any of your real data!
The file you just generated can be sent over to the system where the synthetic data will be generated. Once it is there, you can load it using the CopulaGAN.load method, and then you are ready to sample new data from the loaded instance:
CopulaGAN.load
In [10]: loaded = CopulaGAN.load('my_model.pkl') In [11]: new_data = loaded.sample(num_rows=200)
Notice that the system where the model is loaded needs to also have sdv and ctgan installed, otherwise it will not be able to load the model and use it.
sdv
One of the first things that you may have noticed when looking at the demo data is that there is a student_id column which acts as the primary key of the table, and which is supposed to have unique values. Indeed, if we look at the number of times that each value appears, we see that all of them appear at most once:
student_id
In [12]: data.student_id.value_counts().max() Out[12]: 1
However, if we look at the synthetic data that we generated, we observe that there are some values that appear more than once:
In [13]: new_data[new_data.student_id == new_data.student_id.value_counts().index[0]] Out[13]: student_id gender second_perc high_perc high_spec degree_perc degree_type work_experience experience_years employability_perc mba_spec mba_perc salary placed start_date end_date duration 5 17325 M 83.04 82.46 Commerce 59.64 Comm&Mgmt False 2 50.88 Mkt&Fin 67.43 29972.0 True NaT 2021-01-27 NaN 7 17325 M 84.86 57.61 Arts 79.13 Comm&Mgmt False 2 60.30 Mkt&Fin 67.40 28502.0 False NaT NaT 3.0 11 17325 F 87.10 75.96 Commerce 53.39 Others False 0 75.31 Mkt&HR 66.57 33334.0 True 2020-07-27 2020-07-04 5.0 83 17325 F 58.93 97.14 Science 72.79 Comm&Mgmt False 1 72.52 Mkt&Fin 54.81 27084.0 False 2020-02-25 2020-07-30 NaN 104 17325 M 62.35 80.61 Arts 62.57 Sci&Tech False 0 58.45 Mkt&HR 59.93 29277.0 True NaT 2020-04-11 NaN 166 17325 F 73.88 64.21 Science 78.98 Comm&Mgmt False 0 51.24 Mkt&HR 57.72 NaN False 2020-01-04 NaT NaN
This happens because the model was not notified at any point about the fact that the student_id had to be unique, so when it generates new data it will provoke collisions sooner or later. In order to solve this, we can pass the argument primary_key to our model when we create it, indicating the name of the column that is the index of the table.
primary_key
In [14]: model = CopulaGAN( ....: primary_key='student_id' ....: ) ....: In [15]: model.fit(data) In [16]: new_data = model.sample(200) In [17]: new_data.head() Out[17]: student_id gender second_perc high_perc high_spec degree_perc degree_type work_experience experience_years employability_perc mba_spec mba_perc salary placed start_date end_date duration 0 0 F 86.77 45.35 Commerce 68.43 Sci&Tech False 0 97.79 Mkt&HR 76.07 NaN True NaT 2020-08-12 NaN 1 1 M 75.25 37.66 Science 50.05 Sci&Tech True 0 78.90 Mkt&Fin 68.14 28112.0 True 2020-02-27 NaT 3.0 2 2 M 82.42 71.24 Commerce 73.11 Sci&Tech True 0 98.00 Mkt&Fin 66.12 27458.0 False NaT NaT 7.0 3 3 F 60.76 91.41 Commerce 75.83 Comm&Mgmt False 1 97.93 Mkt&Fin 67.39 20638.0 True 2020-01-05 2020-06-20 5.0 4 4 M 66.30 39.23 Science 53.70 Comm&Mgmt False 0 96.08 Mkt&HR 61.09 23469.0 False 2020-01-17 2021-01-27 3.0
As a result, the model will learn that this column must be unique and generate a unique sequence of values for the column:
In [18]: new_data.student_id.value_counts().max() Out[18]: 1
There will be many cases where the data will contain Personally Identifiable Information which we cannot disclose. In these cases, we will want our Tabular Models to replace the information within these fields with fake, simulated data that looks similar to the real one but does not contain any of the original values.
Let’s load a new dataset that contains a PII field, the student_placements_pii demo, and try to generate synthetic versions of it that do not contain any of the PII fields.
student_placements_pii
The student_placements_pii dataset is a modified version of the student_placements dataset with one new field, address, which contains PII information about the students. Notice that this additional address field has been simulated and does not correspond to data from the real users.
address
In [19]: data_pii = load_tabular_demo('student_placements_pii') In [20]: data_pii.head() Out[20]: student_id address gender second_perc high_perc high_spec degree_perc degree_type work_experience experience_years employability_perc mba_spec mba_perc salary placed start_date end_date duration 0 17264 70304 Baker Turnpike\nEricborough, MS 15086 M 67.00 91.00 Commerce 58.00 Sci&Tech False 0 55.0 Mkt&HR 58.80 27000.0 True 2020-07-23 2020-10-12 3.0 1 17265 805 Herrera Avenue Apt. 134\nMaryview, NJ 36510 M 79.33 78.33 Science 77.48 Sci&Tech True 1 86.5 Mkt&Fin 66.28 20000.0 True 2020-01-11 2020-04-09 3.0 2 17266 3702 Bradley Island\nNorth Victor, FL 12268 M 65.00 68.00 Arts 64.00 Comm&Mgmt False 0 75.0 Mkt&Fin 57.80 25000.0 True 2020-01-26 2020-07-13 6.0 3 17267 Unit 0879 Box 3878\nDPO AP 42663 M 56.00 52.00 Science 52.00 Sci&Tech False 0 66.0 Mkt&HR 59.43 NaN False NaT NaT NaN 4 17268 96493 Kelly Canyon Apt. 145\nEast Steven, NC 3... M 85.80 73.60 Commerce 73.30 Comm&Mgmt False 0 96.8 Mkt&Fin 55.50 42500.0 True 2020-07-04 2020-09-27 3.0
If we use our tabular model on this new data we will see how the synthetic data that it generates discloses the addresses from the real students:
In [21]: model = CopulaGAN( ....: primary_key='student_id', ....: ) ....: In [22]: model.fit(data_pii) In [23]: new_data_pii = model.sample(200) In [24]: new_data_pii.head() Out[24]: student_id address gender second_perc high_perc high_spec degree_perc degree_type work_experience experience_years employability_perc mba_spec mba_perc salary placed start_date end_date duration 0 0 Unit 9984 Box 1462\nDPO AA 02334 F 59.00 84.93 Science 50.38 Comm&Mgmt False 0 91.48 Mkt&Fin 51.21 27243.0 False 2020-03-03 2020-07-06 NaN 1 1 731 Valenzuela Knoll\nNew Maria, SD 66256 F 85.61 77.37 Commerce 56.53 Comm&Mgmt False 0 85.00 Mkt&Fin 59.29 25528.0 True 2020-07-28 NaT NaN 2 2 24346 Chris Stream Apt. 376\nNew Tinachester, ... F 66.47 65.60 Arts 51.30 Comm&Mgmt True 0 57.04 Mkt&Fin 56.74 27151.0 False 2020-03-09 NaT 5.0 3 3 46660 Patrick Stravenue Suite 393\nPort Davidt... M 86.45 70.41 Science 53.04 Comm&Mgmt False 0 97.81 Mkt&Fin 56.47 29657.0 False 2020-03-21 2020-11-10 NaN 4 4 530 Katrina Wall Suite 443\nJimmouth, WV 05020 F 87.07 86.28 Science 55.50 Comm&Mgmt False 0 58.90 Mkt&HR 56.73 29669.0 True 2020-04-01 2020-07-30 3.0
More specifically, we can see how all the addresses that have been generated actually come from the original dataset:
In [25]: new_data_pii.address.isin(data_pii.address).sum() Out[25]: 200
In order to solve this, we can pass an additional argument anonymize_fields to our model when we create the instance. This anonymize_fields argument will need to be a dictionary that contains:
anonymize_fields
The name of the field that we want to anonymize.
The category of the field that we want to use when we generate fake values for it.
The list complete list of possible categories can be seen in the Faker Providers page, and it contains a huge list of concepts such as:
name
country
city
ssn
credit_card_number
credit_card_expire
credit_card_security_code
email
telephone
…
In this case, since the field is an address, we will pass a dictionary indicating the category address
In [26]: model = CopulaGAN( ....: primary_key='student_id', ....: anonymize_fields={ ....: 'address': 'address' ....: } ....: ) ....: In [27]: model.fit(data_pii)
As a result, we can see how the real address values have been replaced by other fake addresses that were not taken from the real data that we learned.
In [28]: new_data_pii = model.sample(200) In [29]: new_data_pii.head() Out[29]: student_id address gender second_perc high_perc high_spec degree_perc degree_type work_experience experience_years employability_perc mba_spec mba_perc salary placed start_date end_date duration 0 0 3083 Jason Union\nStevenschester, OR 99080 M 69.56 37.63 Commerce 83.72 Sci&Tech True 0 96.84 Mkt&Fin 52.99 27071.0 False 2020-07-26 NaT 3.0 1 1 75071 Shepherd Forges\nMooreside, CO 64334 M 42.47 68.10 Commerce 85.06 Comm&Mgmt True 0 94.79 Mkt&HR 54.40 25888.0 True NaT 2020-09-10 3.0 2 2 9276 David Point\nLake Julie, MA 07588 M 47.30 62.57 Science 66.99 Comm&Mgmt False 0 64.96 Mkt&HR 51.56 21983.0 False 2020-03-27 NaT NaN 3 3 92493 Jeremy Court\nEast Teresamouth, MD 77021 F 58.84 61.94 Science 54.49 Sci&Tech False 0 50.84 Mkt&Fin 51.98 NaN False 2020-01-05 2020-08-09 7.0 4 4 7241 Melissa Row\nMichaelside, MT 12592 F 52.90 49.33 Science 70.15 Comm&Mgmt True 1 62.53 Mkt&HR 51.41 NaN True NaT 2020-09-24 NaN
Which means that none of the original addresses can be found in the sampled data:
In [30]: data_pii.address.isin(new_data_pii.address).sum() Out[30]: 0
Now that we have discovered the basics, let’s go over a few more advanced usage examples and see the different arguments that we can pass to our CopulaGAN Model in order to customize it to our needs.
During the previous steps, every time we fitted the CopulaGAN it performed the following operations:
Learn the format and data types of the passed data
Transform the non-numerical and null data using Reversible Data Transforms to obtain a fully numerical representation of the data from which we can learn the probability distributions.
Learn the probability distribution of each column from the table
Transform the values of each numerical column by converting them to their marginal distribution CDF values and then applying an inverse CDF transformation of a standard normal on them.
Fit a CTGAN model on the transformed data, which learns how each column is correlated to the others.
After this, when we used the model to generate new data for our table using the sample method, it did:
Sample rows from the CTGAN model.
Revert the sampled values by computing their standard normal CDF and then applying the inverse CDF of their marginal distributions.
Revert the RDT transformations to go back to the original data format.
As you can see, during these steps the Marginal Probability Distributions have a very important role, since the CopulaGAN had to learn and reproduce the individual distributions of each column in our table. We can explore the distributions which the CopulaGAN used to model each column using its get_distributions method:
get_distributions
In [31]: model = CopulaGAN( ....: primary_key='student_id', ....: enforce_min_max_values=False ....: ) ....: In [32]: model.fit(data) In [33]: distributions = model.get_distributions()
This will return us a dict which contains the name of the distribution class used for each column:
dict
In [34]: distributions Out[34]: {'second_perc': 'copulas.univariate.truncated_gaussian.TruncatedGaussian', 'high_perc': 'copulas.univariate.truncated_gaussian.TruncatedGaussian', 'degree_perc': 'copulas.univariate.truncated_gaussian.TruncatedGaussian', 'work_experience': 'copulas.univariate.truncated_gaussian.TruncatedGaussian', 'experience_years': 'copulas.univariate.truncated_gaussian.TruncatedGaussian', 'employability_perc': 'copulas.univariate.truncated_gaussian.TruncatedGaussian', 'mba_perc': 'copulas.univariate.truncated_gaussian.TruncatedGaussian', 'salary': 'copulas.univariate.truncated_gaussian.TruncatedGaussian', 'placed': 'copulas.univariate.truncated_gaussian.TruncatedGaussian', 'start_date': 'copulas.univariate.truncated_gaussian.TruncatedGaussian', 'end_date': 'copulas.univariate.truncated_gaussian.TruncatedGaussian', 'duration': 'copulas.univariate.truncated_gaussian.TruncatedGaussian'}
In this list we will see multiple distributions for each one of the columns that we have in our data. This is because the RDT transformations used to encode the data numerically often use more than one column to represent each one of the input variables.
Let’s explore the individual distribution of one of the columns in our data to better understand how the CopulaGAN processed them and see if we can improve the results by manually specifying a different distribution. For example, let’s explore the experience_years column by looking at the frequency of its values within the original data:
experience_years
In [35]: data.experience_years.value_counts() Out[35]: 0 141 1 65 2 8 3 1 Name: experience_years, dtype: int64 In [36]: data.experience_years.hist();
By observing the data we can see that the behavior of the values in this column is very similar to a Gamma or even some types of Beta distribution, where the majority of the values are 0 and the frequency decreases as the values increase.
Was the CopulaGAN able to capture this distribution on its own?
In [37]: distributions['experience_years'] Out[37]: 'copulas.univariate.truncated_gaussian.TruncatedGaussian'
It seems that the it was not, as it rather thought that the behavior was closer to a Gaussian distribution. And, as a result, we can see how the generated values now contain negative values which are invalid for this column:
In [38]: new_data.experience_years.value_counts() Out[38]: 0 168 1 28 2 4 Name: experience_years, dtype: int64 In [39]: new_data.experience_years.hist();
Let’s see how we can improve this situation by passing the CopulaGAN the exact distribution that we want it to use for this column.
The CopulaGAN class offers the possibility to indicate which distribution to use for each one of the columns in the table, in order to solve situations like the one that we just described. In order to do this, we need to pass a field_distributions argument with dict that indicates, the distribution that we want to use for each column.
field_distributions
Possible values for the distribution argument are:
gaussian: Use a Gaussian distribution.
gaussian
gamma: Use a Gamma distribution.
gamma
beta: Use a Beta distribution.
beta
student_t: Use a Student T distribution.
student_t
gaussian_kde: Use a GaussianKDE distribution. This model is non-parametric, so using this will make get_parameters unusable.
gaussian_kde
get_parameters
truncated_gaussian: Use a Truncated Gaussian distribution.
truncated_gaussian
Let’s see what happens if we make the CopulaGAN use the gamma distribution for our column.
In [40]: model = CopulaGAN( ....: primary_key='student_id', ....: field_distributions={ ....: 'experience_years': 'gamma' ....: }, ....: enforce_min_max_values=False ....: ) ....: In [41]: model.fit(data)
After this, we can see how the CopulaGAN used the indicated distribution for the experience_years column
In [42]: model.get_distributions()['experience_years'] Out[42]: 'copulas.univariate.gamma.GammaUnivariate'
And, as a result, now we can see how the generated data now have a behavior which is closer to the original data and always stays within the valid values range.
In [43]: new_data = model.sample(len(data)) In [44]: new_data.experience_years.value_counts() Out[44]: 0 181 3 11 1 10 2 9 4 4 Name: experience_years, dtype: int64 In [45]: new_data.experience_years.hist();
Even though there are situations like the one show above where manually choosing a distribution seems to give better results, in most cases the CopulaGAN will be able to find the optimal distribution on its own, making this manual search of the marginal distributions necessary on very little occasions.
A part from the arguments explained above, CopulaGAN has a number of additional hyperparameters that control its learning behavior and can impact on the performance of the model, both in terms of quality of the generated data and computational time:
epochs and batch_size: these arguments control the number of iterations that the model will perform to optimize its parameters, as well as the number of samples used in each step. Its default values are 300 and 500 respectively, and batch_size needs to always be a value which is multiple of 10.
epochs
300
500
10
These hyperparameters have a very direct effect in time the training process lasts but also on the performance of the data, so for new datasets, you might want to start by setting a low value on both of them to see how long the training process takes on your data and later on increase the number to acceptable values in order to improve the performance.
log_frequency: Whether to use log frequency of categorical levels in conditional sampling. It defaults to True. This argument affects how the model processes the frequencies of the categorical values that are used to condition the rest of the values. In some cases, changing it to False could lead to better performance.
log_frequency
True
False
embedding_dim (int): Size of the random sample passed to the Generator. Defaults to 128.
embedding_dim
generator_dim (tuple or list of ints): Size of the output samples for each one of the Residuals. A Resiudal Layer will be created for each one of the values provided. Defaults to (256, 256).
generator_dim
discriminator_dim (tuple or list of ints): Size of the output samples for each one of the Discriminator Layers. A Linear Layer will be created for each one of the values provided. Defaults to (256, 256).
discriminator_dim
generator_lr (float): Learning rate for the generator. Defaults to 2e-4.
generator_lr
generator_decay (float): Generator weight decay for the Adam Optimizer. Defaults to 1e-6.
generator_decay
discriminator_lr (float): Learning rate for the discriminator. Defaults to 2e-4.
discriminator_lr
discriminator_decay (float): Discriminator weight decay for the Adam Optimizer. Defaults to 1e-6.
discriminator_decay
discriminator_steps (int): Number of discriminator updates to do for each generator update. From the WGAN paper: https://arxiv.org/abs/1701.07875. WGAN paper default is 5. Default used is 1 to match original CTGAN implementation.
discriminator_steps
verbose: Whether to print fit progress on stdout. Defaults to False.
verbose
Notice that the value that you set on the batch_size argument must always be a multiple of 10!
As an example, we will try to fit the CopulaGAN model slightly increasing the number of epochs, reducing the batch_size, adding one additional layer to the models involved and using a smaller wright decay.
Before we start, we will evaluate the quality of the previously generated data using the sdv.evaluation.evaluate function
sdv.evaluation.evaluate
In [46]: from sdv.evaluation import evaluate In [47]: evaluate(new_data, data) Out[47]: 0.7642412155856405
Afterwards, we create a new instance of the CopulaGAN model with the hyperparameter values that we want to use
In [48]: model = CopulaGAN( ....: primary_key='student_id', ....: epochs=500, ....: batch_size=100, ....: generator_dim=(256, 256, 256), ....: discriminator_dim=(256, 256, 256) ....: ) ....:
And fit to our data.
In [49]: model.fit(data)
Finally, we are ready to generate new data and evaluate the results.
In [50]: new_data = model.sample(len(data)) In [51]: evaluate(new_data, data) Out[51]: 0.7403149762413108
As we can see, in this case these modifications changed the obtained results slightly, but they did neither introduce dramatic changes in the performance.
As the name implies, conditional sampling allows us to sample from a conditional distribution using the CopulaGAN model, which means we can generate only values that satisfy certain conditions. These conditional values can be passed to the sample_conditions method as a list of sdv.sampling.Condition objects or to the sample_remaining_columns method as a dataframe.
sample_conditions
sdv.sampling.Condition
sample_remaining_columns
When specifying a sdv.sampling.Condition object, we can pass in the desired conditions as a dictionary, as well as specify the number of desired rows for that condition.
In [52]: from sdv.sampling import Condition In [53]: condition = Condition({ ....: 'gender': 'M' ....: }, num_rows=5) ....: In [54]: model.sample_conditions(conditions=[condition]) Out[54]: student_id gender second_perc high_perc high_spec degree_perc degree_type work_experience experience_years employability_perc mba_spec mba_perc salary placed start_date end_date duration 0 0 M 73.64 72.65 Commerce 72.34 Comm&Mgmt False 0 58.71 Mkt&Fin 65.87 82671.0 True NaT NaT 7.0 1 1 M 57.58 83.83 Science 61.79 Comm&Mgmt False 0 52.67 Mkt&Fin 67.61 35109.0 True NaT 2020-11-16 8.0 2 2 M 75.93 77.83 Science 67.04 Sci&Tech False 1 50.92 Mkt&HR 71.18 33264.0 True 2020-01-11 2020-06-21 12.0 3 3 M 78.29 78.47 Science 90.05 Sci&Tech False 0 50.56 Mkt&Fin 77.23 34851.0 True 2020-01-04 2020-07-01 3.0 4 4 M 83.99 85.43 Commerce 88.98 Sci&Tech True 1 50.41 Mkt&Fin 76.08 25222.0 False NaT 2020-10-28 12.0
It’s also possible to condition on multiple columns, such as gender = M, 'experience_years': 0.
gender = M, 'experience_years': 0
In [55]: condition = Condition({ ....: 'gender': 'M', ....: 'experience_years': 0 ....: }, num_rows=5) ....: In [56]: model.sample_conditions(conditions=[condition]) Out[56]: student_id gender second_perc high_perc high_spec degree_perc degree_type work_experience experience_years employability_perc mba_spec mba_perc salary placed start_date end_date duration 0 0 M 60.83 37.41 Commerce 54.12 Comm&Mgmt False 0 57.06 Mkt&Fin 53.76 NaN True NaT 2021-01-27 NaN 1 1 M 62.20 63.35 Science 82.62 Others True 0 73.61 Mkt&Fin 77.79 52957.0 True 2020-01-20 2020-07-22 8.0 2 2 M 48.77 74.37 Science 73.66 Sci&Tech True 0 57.03 Mkt&HR 73.68 30449.0 True 2020-01-06 2020-06-28 3.0 3 3 M 40.94 46.28 Science 50.03 Sci&Tech False 0 50.47 Mkt&HR 69.20 NaN True NaT NaT NaN 4 4 M 69.87 74.06 Commerce 67.83 Comm&Mgmt True 0 55.85 Mkt&HR 66.08 NaN True 2020-02-27 NaT 3.0
In the sample_remaining_columns method, conditions is passed as a dataframe. In that case, the model will generate one sample for each row of the dataframe, sorted in the same order. Since the model already knows how many samples to generate, passing it as a parameter is unnecessary. For example, if we want to generate three samples where gender = M and three samples with gender = F, we can do the following:
conditions
gender = M
gender = F
In [57]: import pandas as pd In [58]: conditions = pd.DataFrame({ ....: 'gender': ['M', 'M', 'M', 'F', 'F', 'F'], ....: }) ....: In [59]: model.sample_remaining_columns(conditions) Out[59]: student_id gender second_perc high_perc high_spec degree_perc degree_type work_experience experience_years employability_perc mba_spec mba_perc salary placed start_date end_date duration 0 0 M 74.19 78.10 Commerce 90.49 Comm&Mgmt False 1 77.58 Mkt&Fin 77.69 32453.0 True 2020-06-05 2020-08-28 3.0 1 1 M 40.93 37.03 Commerce 50.30 Others False 0 52.64 Mkt&HR 52.44 NaN False NaT NaT NaN 2 2 M 45.38 48.31 Science 50.03 Comm&Mgmt False 0 54.67 Mkt&HR 52.82 NaN False NaT NaT NaN 3 3 F 40.93 37.34 Commerce 54.87 Comm&Mgmt False 0 51.06 Mkt&HR 61.56 NaN False NaT NaT NaN 4 4 F 87.89 79.40 Science 88.92 Comm&Mgmt False 0 50.50 Mkt&Fin 74.62 30544.0 True 2020-01-01 2020-07-10 3.0 5 5 F 80.98 72.40 Science 60.96 Comm&Mgmt False 0 51.76 Mkt&Fin 60.45 30959.0 False NaT NaT NaN
CopulaGAN also supports conditioning on continuous values, as long as the values are within the range of seen numbers. For example, if all the values of the dataset are within 0 and 1, CopulaGAN will not be able to set this value to 1000.
In [60]: condition = Condition({ ....: 'degree_perc': 70.0 ....: }, num_rows=5) ....: In [61]: model.sample_conditions(conditions=[condition]) Out[61]: student_id gender second_perc high_perc high_spec degree_perc degree_type work_experience experience_years employability_perc mba_spec mba_perc salary placed start_date end_date duration 0 0 F 71.23 45.48 Science 70.0 Others False 0 58.20 Mkt&HR 74.58 NaN True NaT NaT NaN 1 1 F 41.44 50.09 Commerce 70.0 Comm&Mgmt True 0 54.79 Mkt&HR 68.50 NaN False NaT NaT 6.0 2 2 F 85.58 91.17 Science 70.0 Comm&Mgmt True 0 56.84 Mkt&Fin 77.48 60572.0 False 2020-02-01 2020-10-01 8.0 3 3 F 44.45 61.18 Science 70.0 Sci&Tech True 0 62.92 Mkt&HR 55.31 NaN False NaT 2020-09-20 NaN 4 4 M 46.41 70.14 Science 70.0 Sci&Tech False 0 55.53 Mkt&Fin 77.46 NaN True 2020-02-08 NaT NaN
Conditional sampling works through a rejection sampling process, where rows are sampled repeatedly until one that satisfies the conditions is found. In case you are not able to sample enough valid rows, try increasing max_tries_per_batch. More information about this parameter can be found in the API section
max_tries_per_batch
If you have many conditions that cannot easily be satisified, consider switching to the GaussianCopula model, which is able to handle conditional sampling more efficiently.
If you look closely at the data you may notice that some properties were not completely captured by the model. For example, you may have seen that sometimes the model produces an experience_years number greater than 0 while also indicating that work_experience is False. These types of properties are what we call Constraints and can also be handled using SDV. For further details about them please visit the Constraints guide.
0
work_experience
Constraints
SDV
After creating synthetic data, you may be wondering how you can evaluate it against the original data. You can use the SDMetrics library to get more insights, generate reports and visualize the data. This library is automatically installed with SDV.
To get started, visit: https://docs.sdv.dev/sdmetrics/