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.constraints.ScalarInequality

class sdv.constraints.ScalarInequality(column_name, relation, value)[source]

Ensure an inequality between the column_name column and a scalar value.

The transformation works by creating a column with the difference between the column_name and value and storing it in the column_name’s place. The reverse transform adds the difference column and the value to reconstruct the column_name.

Parameters
  • column_name (str) – Name of the column to compare.

  • relation (str) – Describes the relation between column_name and value. Choose one among '>', '>=', '<', '<='.

  • value (float or datetime) – Scalar value to compare.

__init__(column_name, relation, value)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(column_name, relation, value)

Initialize self.

filter_valid(table_data)

Get only the rows that are valid.

fit(table_data)

Fit Constraint class to data.

fit_transform(table_data)

Fit this Constraint to the data and then transform it.

from_dict(constraint_dict)

Build a Constraint object from a dict.

is_valid(table_data)

Say whether high is greater than low in each row.

reverse_transform(table_data)

Handle logic around reverse transforming constraints.

to_dict()

Return a dict representation of this Constraint.

transform(table_data)

Perform necessary transformations needed by constraint.

Attributes

constraint_columns