Positive

Compatibility: A single, numerical column

The Positive class enforces that all the values in a given column are >0.

Some synthesizers already learn the min and max values of every column in the real dataset and enforce the bounds in the synthetic dataset. For such synthesizers, you do not need to add this constraint.

Parameters

(required) column_name: The name of the column that must follow the constraint

strict_boundaries: Whether the column must be strictly positive, or whether 0 is allowed

True	All values in the column are >0
(default) False	All values in the column are ≥0

Example

Define your constraint using the parameters and then add it to a synthesizer.

my_constraint = {
    'constraint_class': 'Positive',
    'table_name': 'guests', # for multi table synthesizers
    'constraint_parameters': {
        'column_name': 'room_rate',
        'strict_boundaries': True
    }
}

my_synthesizer.add_constraints(constraints=[
    my_constraint
])

FAQs

What happens to missing values?

This constraint ignores missing values. The constraint considered is valid as long as the numerical values (non-missing values) follow the logic.