Try the new SDV 1.0 Beta!

We are transitioning to a new version of SDV with improved workflows, new features and an updated documentation site.

# CopulaGAN Model¶

In this guide we will go through a series of steps that will let you
discover functionalities of the `CopulaGAN`

model, including how to:

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.

## What is CopulaGAN?¶

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.

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.

## Quick Usage¶

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.

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.

```
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.Call its

`sample`

method indicating the number of synthetic rows that you want to generate.

```
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.

### Generate synthetic data from the model¶

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.

```
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 17395 F 74.18 83.01 Commerce 67.59 Comm&Mgmt True 0 67.15 Mkt&Fin 51.23 28580.0 True 2020-07-22 NaT NaN
1 17361 F 62.23 42.37 Commerce 64.95 Comm&Mgmt True 0 89.71 Mkt&HR 51.65 25482.0 False NaT 2020-07-26 12.0
2 17327 F 80.21 68.06 Commerce 50.20 Comm&Mgmt True 0 54.44 Mkt&Fin 57.82 NaN False 2020-03-12 2020-06-01 3.0
3 17369 M 70.84 57.73 Science 62.76 Comm&Mgmt False 0 85.57 Mkt&HR 62.48 20002.0 True NaT NaT 6.0
4 17372 M 55.61 60.11 Commerce 70.91 Sci&Tech False 0 58.16 Mkt&Fin 63.74 27930.0 False NaT 2020-08-10 NaN
```

Note

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.

### Save and Load the model¶

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.

#### Load the model and generate new 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:

```
In [10]: loaded = CopulaGAN.load('my_model.pkl')
In [11]: new_data = loaded.sample(num_rows=200)
```

Warning

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.

### Specifying the Primary Key of the table¶

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:

```
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
7 17477 F 45.03 96.07 Commerce 67.34 Comm&Mgmt True 0 93.56 Mkt&Fin 53.36 27578.0 True 2020-01-26 NaT NaN
9 17477 F 42.60 76.11 Science 76.93 Comm&Mgmt True 1 96.64 Mkt&Fin 54.98 25180.0 False 2020-02-27 NaT 3.0
36 17477 M 55.62 74.66 Commerce 56.81 Comm&Mgmt False 0 53.31 Mkt&Fin 51.68 21542.0 False 2020-03-18 NaT NaN
42 17477 M 55.72 94.21 Commerce 72.87 Sci&Tech False 0 69.55 Mkt&HR 61.89 NaN False NaT 2020-12-18 NaN
47 17477 F 42.43 72.38 Science 55.06 Comm&Mgmt False 0 60.48 Mkt&HR 55.14 NaN True 2020-06-23 2020-07-18 5.0
51 17477 M 59.21 48.90 Science 56.88 Sci&Tech False 0 95.63 Mkt&Fin 51.88 25745.0 False NaT NaT 6.0
67 17477 M 48.20 69.31 Commerce 79.79 Sci&Tech False 0 96.96 Mkt&Fin 55.58 NaN False 2020-01-18 NaT 6.0
72 17477 M 63.05 49.75 Commerce 83.15 Comm&Mgmt False 0 78.85 Mkt&Fin 51.21 24449.0 False 2020-07-27 2020-08-04 NaN
129 17477 F 44.27 81.28 Arts 62.18 Comm&Mgmt False 0 92.54 Mkt&HR 54.69 25233.0 False 2020-01-25 2020-10-07 6.0
151 17477 F 59.59 51.91 Commerce 80.56 Comm&Mgmt False 0 97.36 Mkt&HR 57.77 25797.0 True NaT 2020-07-05 7.0
168 17477 M 73.78 60.73 Commerce 50.47 Sci&Tech False 0 67.00 Mkt&HR 54.59 NaN False 2020-07-27 2020-06-06 NaN
171 17477 F 59.82 86.96 Science 83.38 Others False 0 50.00 Mkt&HR 56.08 NaN False 2020-02-02 NaT 5.0
181 17477 F 61.68 64.21 Commerce 65.55 Sci&Tech False 2 88.70 Mkt&HR 51.74 NaN False NaT 2020-04-15 6.0
183 17477 M 87.05 70.07 Science 56.40 Comm&Mgmt False 0 52.02 Mkt&Fin 62.01 21387.0 True NaT 2020-08-08 NaN
193 17477 M 81.38 88.48 Science 58.73 Sci&Tech False 0 89.76 Mkt&Fin 62.95 NaN True NaT 2020-09-26 3.0
194 17477 M 70.77 79.50 Science 57.20 Comm&Mgmt False 1 50.00 Mkt&HR 51.51 33194.0 False 2020-02-12 2021-01-12 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.

```
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 M 47.98 72.00 Commerce 85.72 Comm&Mgmt True 0 50.80 Mkt&Fin 77.56 22167.0 True 2020-03-28 2020-07-21 3.0
1 1 M 84.01 72.20 Commerce 65.96 Comm&Mgmt True 0 51.08 Mkt&Fin 70.20 NaN False 2020-02-09 2020-05-30 3.0
2 2 M 71.10 56.96 Commerce 60.97 Others True 1 51.36 Mkt&Fin 71.05 52857.0 False NaT 2020-09-25 7.0
3 3 M 59.29 55.12 Science 70.13 Sci&Tech True 0 53.92 Mkt&Fin 70.63 27456.0 True NaT NaT NaN
4 4 M 80.74 69.15 Science 55.33 Sci&Tech False 0 59.36 Mkt&Fin 68.57 24630.0 True 2020-01-01 2020-06-16 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
```

### Anonymizing Personally Identifiable Information (PII)¶

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.

Note

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.

```
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 162 Schmidt Harbor Apt. 653\nNew Paula, MI 52655 F 76.03 97.27 Commerce 57.31 Comm&Mgmt False 1 82.17 Mkt&HR 51.78 NaN True 2020-07-26 2020-08-27 7.0
1 1 84670 Nicholas Mall\nWest William, MD 16359 M 65.34 71.61 Science 76.25 Sci&Tech False 0 88.82 Mkt&Fin 52.47 28659.0 False NaT NaT NaN
2 2 53778 Ashley Alley\nSouth William, NM 30130 M 41.30 79.68 Commerce 72.61 Comm&Mgmt False 0 78.11 Mkt&HR 59.36 NaN True NaT 2020-12-08 NaN
3 3 8897 Brandon Ports\nNew Patriciachester, MS 76485 M 45.95 84.41 Commerce 79.78 Comm&Mgmt False 0 90.37 Mkt&HR 51.42 22680.0 True 2020-01-02 2020-09-29 NaN
4 4 4868 Thompson Fall\nJamieview, VT 18347 F 44.63 68.72 Commerce 59.54 Comm&Mgmt False 1 63.96 Mkt&Fin 63.94 NaN True NaT 2020-10-06 6.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:

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

address

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 7154 Jones Shoal Apt. 083\nStricklandmouth, SD... F 64.91 58.67 Commerce 84.49 Comm&Mgmt False 0 70.67 Mkt&HR 54.52 38738.0 True NaT NaT 4.0
1 1 PSC 5883, Box 5330\nAPO AP 40153 M 83.01 62.14 Science 69.67 Comm&Mgmt True 0 78.40 Mkt&Fin 54.27 26321.0 False NaT NaT NaN
2 2 PSC 4769, Box 1143\nAPO AA 79605 M 56.52 51.46 Commerce 61.53 Comm&Mgmt False 0 86.83 Mkt&Fin 64.48 30914.0 False 2020-02-27 2021-01-27 9.0
3 3 71377 Catherine Ville\nLake James, WV 00709 M 81.65 53.38 Science 56.75 Comm&Mgmt False 0 81.75 Mkt&Fin 51.51 21016.0 True 2020-07-27 2020-08-06 NaN
4 4 5320 Alice Forge Apt. 981\nLake Robertton, KS ... F 82.66 77.45 Science 55.14 Comm&Mgmt False 0 77.53 Mkt&Fin 72.68 NaN True NaT 2020-04-18 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
```

## Advanced Usage¶

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.

### Exploring the Probability Distributions¶

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:

```
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:

```
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'}
```

Note

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:

```
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 178
1 17
2 5
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.

### Setting distributions for indvidual variables¶

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.

Possible values for the distribution argument are:

`gaussian`

: Use a Gaussian distribution.`gamma`

: Use a Gamma distribution.`beta`

: Use a Beta distribution.`student_t`

: Use a Student T distribution.`gaussian_kde`

: Use a GaussianKDE distribution. This model is non-parametric, so using this will make`get_parameters`

unusable.`truncated_gaussian`

: Use a Truncated Gaussian distribution.

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 191
1 10
2 7
3 6
4 1
Name: experience_years, dtype: int64
In [45]: new_data.experience_years.hist();
```

Note

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.

### How to modify the CopulaGAN Hyperparameters?¶

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`

.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.`embedding_dim`

(int): Size of the random sample passed to the Generator. Defaults to 128.`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).`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).`generator_lr`

(float): Learning rate for the generator. Defaults to 2e-4.`generator_decay`

(float): Generator weight decay for the Adam Optimizer. Defaults to 1e-6.`discriminator_lr`

(float): Learning rate for the discriminator. Defaults to 2e-4.`discriminator_decay`

(float): Discriminator weight decay for the Adam Optimizer. Defaults to 1e-6.`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.`verbose`

: Whether to print fit progress on stdout. Defaults to`False`

.

Warning

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

```
In [46]: from sdv.evaluation import evaluate
In [47]: evaluate(new_data, data)
Out[47]: 0.7948990406821703
```

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.7341885794092907
```

As we can see, in this case these modifications changed the obtained results slightly, but they did neither introduce dramatic changes in the performance.

### Conditional Sampling¶

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.

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 88.17 71.05 Science 89.55 Comm&Mgmt True 0 56.06 Mkt&HR 67.33 20000.0 True 2020-07-27 NaT 3.0
1 1 M 60.45 67.71 Science 52.78 Sci&Tech False 0 50.28 Mkt&Fin 51.23 NaN False 2020-01-18 NaT NaN
2 2 M 89.10 92.17 Commerce 78.19 Comm&Mgmt True 0 58.25 Mkt&Fin 60.44 29026.0 False 2020-01-02 2020-07-21 3.0
3 3 M 89.24 67.07 Science 74.21 Comm&Mgmt True 0 52.07 Mkt&Fin 51.24 25082.0 False NaT NaT NaN
4 4 M 73.56 37.16 Science 61.97 Others True 0 57.05 Mkt&Fin 51.66 NaN False NaT 2020-08-16 6.0
```

It’s also possible to condition on multiple columns, such as
`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 89.39 80.07 Science 50.32 Others True 0 55.93 Mkt&Fin 60.92 36827.0 True NaT NaT 12.0
1 1 M 89.19 92.23 Science 57.54 Sci&Tech False 0 52.10 Mkt&Fin 51.27 26121.0 True 2020-01-14 2020-08-26 3.0
2 2 M 86.58 97.42 Commerce 83.65 Comm&Mgmt True 0 61.34 Mkt&Fin 52.52 32580.0 True 2020-04-04 2020-03-25 8.0
3 3 M 89.39 82.11 Science 79.50 Comm&Mgmt True 0 52.92 Mkt&Fin 60.73 31711.0 True 2020-01-24 2020-03-25 3.0
4 4 M 88.91 86.64 Commerce 62.03 Comm&Mgmt True 0 51.71 Mkt&Fin 55.68 41797.0 True 2020-07-25 2020-03-31 NaN
```

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:

```
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 70.25 63.95 Commerce 63.80 Comm&Mgmt False 0 76.68 Mkt&HR 51.25 NaN True NaT NaT NaN
1 1 M 88.24 84.15 Science 76.66 Comm&Mgmt True 0 60.20 Mkt&Fin 61.34 28049.0 True 2020-07-27 2020-10-31 8.0
2 2 M 89.29 76.81 Science 74.01 Sci&Tech True 0 54.66 Mkt&HR 51.39 42587.0 True 2020-03-14 2020-10-11 12.0
3 3 F 88.13 40.67 Science 65.91 Comm&Mgmt True 0 52.67 Mkt&Fin 52.27 29582.0 True 2020-07-27 NaT NaN
4 4 F 84.63 63.98 Science 59.53 Comm&Mgmt True 0 70.33 Mkt&Fin 52.75 NaN False NaT 2020-08-30 11.0
5 5 F 62.72 51.94 Science 64.72 Sci&Tech True 0 56.09 Mkt&HR 53.61 NaN True NaT 2020-10-03 3.0
```

`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 87.11 55.25 Arts 70.0 Comm&Mgmt False 0 80.93 Mkt&HR 51.95 31453.0 False NaT NaT NaN
1 1 F 86.65 76.05 Commerce 70.0 Comm&Mgmt False 0 57.01 Mkt&Fin 52.13 33199.0 True 2020-01-26 2020-08-13 3.0
2 2 M 80.30 52.91 Arts 70.0 Comm&Mgmt False 0 52.23 Mkt&HR 59.52 NaN False 2020-01-12 NaT 8.0
3 3 M 89.39 65.63 Science 70.0 Others True 1 50.27 Mkt&Fin 51.25 22503.0 True 2020-02-04 2020-10-24 3.0
4 4 F 86.54 84.41 Science 70.0 Comm&Mgmt True 0 64.51 Mkt&Fin 67.30 NaN True 2020-01-25 NaT 3.0
```

Note

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

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.

### How do I specify constraints?¶

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.

### Can I evaluate the Synthetic Data?¶

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/