Sdv

This release adds support for passing tabular constraints to the HMA1 model, and adds more explicit error handling for
metric evaluation. It also includes a fix for using categorical columns in the PAR model and documentation updates
for metadata and HMA1.

Bugs Fixed

* Categorical column after sequence_index column - Issue [314](https://github.com/sdv-dev/SDV/issues/314) by fealho

New Features

* Support passing tabular constraints to the HMA1 model - Issue [296](https://github.com/sdv-dev/SDV/issues/296) by katxiao
* Metric evaluation error handling metrics - Issue [638](https://github.com/sdv-dev/SDV/issues/638) by katxiao

Documentation Changes

* Make true/false values lowercase in Metadata Schema specification - Issue [664](https://github.com/sdv-dev/SDV/issues/664) by katxiao
* Update docstrings for hma1 methods - Issue [642](https://github.com/sdv-dev/SDV/issues/642) by katxiao

This release makes multiple improvements to different `Constraint` classes. The `Unique` constraint can now
handle columns with the name `index` and no longer crashes on subsets of the original data. The `Between`
constraint can now handle columns with nulls properly. The memory of all constraints was also improved.

Various other features and fixes were added. Conditional sampling no longer crashes when the `num_rows` argument
is not provided. Multiple localizations can now be used for PII fields. Scaffolding for integration tests was added
and the workflows now run `pip check`.

Additionally, this release adds support for Python 3.9!

Bugs Fixed

* Gaussian Copula – Memory Issue in Release 0.10.0 - Issue [459](https://github.com/sdv-dev/SDV/issues/459) by xamm
* Applying Unique Constraint errors when calling model.fit() on a subset of data - Issue [610](https://github.com/sdv-dev/SDV/issues/610) by xamm
* Calling sampling with conditions and without num_rows crashes - Issue [614](https://github.com/sdv-dev/SDV/issues/614) by xamm
* Metadata.visualize with path parameter throws AttributeError - Issue [634](https://github.com/sdv-dev/SDV/issues/634) by xamm
* The Unique constraint crashes when the data contains a column called index - Issue [616](https://github.com/sdv-dev/SDV/issues/616) by xamm
* The Unique constraint cannot handle non-default index - Issue [617](https://github.com/sdv-dev/SDV/issues/617) by xamm
* ConstraintsNotMetError when applying Between constraint on datetime columns containing null values - Issue [632](https://github.com/sdv-dev/SDV/issues/632) by katxiao

New Features

* Adds Multi localisations feature for PII fields defined in 308 - PR [609](https://github.com/sdv-dev/SDV/pull/609) by xamm

Housekeeping Tasks

* Support latest version of Faker - Issue [621](https://github.com/sdv-dev/SDV/issues/621) by katxiao
* Add scaffolding for Metadata integration tests - Issue [624](https://github.com/sdv-dev/SDV/issues/624) by katxiao
* Add support for Python 3.9 - Issue [631](https://github.com/sdv-dev/SDV/issues/631) by amontanez24

Internal Improvements

* Add pip check to CI workflows - Issue [626](https://github.com/sdv-dev/SDV/issues/626) by pvk-developer

Documentation Changes

* Anonymizing PII in single table tutorials states address field as e-mail type - Issue [604](https://github.com/sdv-dev/SDV/issues/604) by xamm

Special thanks to xamm, katxiao, pvk-developer and amontanez24 for all the work that made this release possible!

This release fixes bugs in constraints, metadata behavior, and SDV documentation. Specifically, we added
proper handling of data containing null values for constraints and timeseries data, and updated the
default metadata detection behavior.

Bugs Fixed

* ValueError: The parameter loc has invalid values - Issue [353](https://github.com/sdv-dev/SDV/issues/353) by fealho
* Gaussian Copula is generating different data with metadata and without metadata - Issue [576](https://github.com/sdv-dev/SDV/issues/576) by katxiao
* Make pomegranate an optional dependency - Issue [567](https://github.com/sdv-dev/SDV/issues/567) by katxiao
* Small wording change for Question Issue Template - Issue [571](https://github.com/sdv-dev/SDV/issues/571) by katxiao
* ConstraintsNotMetError when using GreaterThan constraint with datetime - Issue [590](https://github.com/sdv-dev/SDV/issues/590) by katxiao
* GreaterThan constraint crashing with NaN values - Issue [592](https://github.com/sdv-dev/SDV/issues/592) by katxiao
* Null values in GreaterThan constraint raises error - Issue [589](https://github.com/sdv-dev/SDV/issues/589) by katxiao
* ColumnFormula raises ConstraintsNotMetError when checking NaN values - Issue [593](https://github.com/sdv-dev/SDV/issues/593) by katxiao
* GreaterThan constraint raises TypeError when using datetime - Issue [596](https://github.com/sdv-dev/SDV/issues/596) by katxiao
* Fix repository language - Issue [464](https://github.com/sdv-dev/SDV/issues/464) by fealho
* Update __init__.py - Issue [578](https://github.com/sdv-dev/SDV/issues/578) by dyuliu
* IndexingError: Unalignable boolean - Issue [446](https://github.com/sdv-dev/SDV/issues/446) by fealho

This release focuses on improving and expanding upon the existing constraints. More specifically, the users can now
(1) specify multiple columns in `Positive` and `Negative` constraints, (2) use the new `Unique`constraint and
(3) use datetime data with the `Between` constraint. Additionaly, error messages have been added and updated
to provide more useful feedback to the user.

Besides the added features, several bugs regarding the `UniqueCombinations` and `ColumnFormula` constraints have been fixed,
and an error in the metadata.json for the `student_placements` dataset was corrected. The release also added documentation
for the `fit_columns_model` which affects the majority of the available constraints.

New Features

* Change default fit_columns_model to False - Issue [550](https://github.com/sdv-dev/SDV/issues/550) by katxiao
* Support multi-column specification for positive and negative constraint - Issue [545](https://github.com/sdv-dev/SDV/issues/545) by sarahmish
* Raise error when multiple constraints can't be enforced - Issue [541](https://github.com/sdv-dev/SDV/issues/541) by amontanez24
* Create Unique Constraint - Issue [532](https://github.com/sdv-dev/SDV/issues/532) by amontanez24
* Passing invalid conditions when using constraints produces unreadable errors - Issue [511](https://github.com/sdv-dev/SDV/issues/511) by katxiao
* Improve error message for ColumnFormula constraint when constraint column used in formula - Issue [508](https://github.com/sdv-dev/SDV/issues/508) by katxiao
* Add datetime functionality to Between constraint - Issue [504](https://github.com/sdv-dev/SDV/issues/504) by katxiao

Bugs Fixed

* UniqueCombinations constraint with handling_strategy = 'transform' yields synthetic data with nan values - Issue [521](https://github.com/sdv-dev/SDV/issues/521) by katxiao and csala
* UniqueCombinations constraint outputting wrong data type - Issue [510](https://github.com/sdv-dev/SDV/issues/510) by katxiao and csala
* UniqueCombinations constraint on only one column gets stuck in an infinite loop - Issue [509](https://github.com/sdv-dev/SDV/issues/509) by katxiao
* Conditioning on a non-constraint column using the ColumnFormula constraint - Issue [507](https://github.com/sdv-dev/SDV/issues/507) by katxiao
* Conditioning on the constraint column of the ColumnFormula constraint - Issue [506](https://github.com/sdv-dev/SDV/issues/506) by katxiao
* Update metadata.json for duration of student_placements dataset - Issue [503](https://github.com/sdv-dev/SDV/issues/503) by amontanez24
* Unit test for HMA1 when working with a single child row per parent row - Issue [497](https://github.com/sdv-dev/SDV/issues/497) by pvk-developer
* UniqueCombinations constraint for more than 2 columns - Issue [494](https://github.com/sdv-dev/SDV/issues/494) by katxiao and csala

Documentation Changes

* Add explanation of fit_columns_model to API docs - Issue [517](https://github.com/sdv-dev/SDV/issues/517) by katxiao

This release primarily addresses bugs and feature requests related to using constraints for the single-table models.
Users can now enforce scalar comparison with the existing `GreaterThan` constraint and apply 5 new constraints: `OneHotEncoding`, `Positive`, `Negative`, `Between` and `Rounding`.
Additionally, the SDV will now auto-apply constraints for rounding numerical values, and for keeping the data within the observed bounds.
All related user guides are updated with the new functionality.

New Features

* Add OneHotEncoding Constraint - Issue [303](https://github.com/sdv-dev/SDV/issues/303) by fealho
* GreaterThan Constraint should apply to scalars - Issue [410](https://github.com/sdv-dev/SDV/issues/410) by amontanez24
* Improve GreaterThan constraint - Issue [368](https://github.com/sdv-dev/SDV/issues/368) by amontanez24
* Add Non-negative and Positive constraints across multiple columns- Issue [409](https://github.com/sdv-dev/SDV/issues/409) by amontanez24
* Add Between values constraint - Issue [367](https://github.com/sdv-dev/SDV/issues/367) by fealho
* Ensure values fall within the specified range - Issue [423](https://github.com/sdv-dev/SDV/issues/423) by amontanez24
* Add Rounding constraint - Issue [482](https://github.com/sdv-dev/SDV/issues/482) by katxiao
* Add rounding and min/max arguments that are passed down to the NumericalTransformer - Issue [491](https://github.com/sdv-dev/SDV/issues/491) by amontanez24

Bugs Fixed

* GreaterThan constraint between Date columns rasises TypeError - Issue [421](https://github.com/sdv-dev/SDV/issues/421) by amontanez24
* GreaterThan constraint's transform strategy fails on columns that are not float - Issue [448](https://github.com/sdv-dev/SDV/issues/448) by amontanez24
* AttributeError on UniqueCombinations constraint with non-strings - Issue [196](https://github.com/sdv-dev/SDV/issues/196) by katxiao
* Use reject sampling to sample missing columns for constraints - Issue [435](https://github.com/sdv-dev/SDV/issues/435) by amontanez24

Documentation Changes

* Ensure privacy metrics are available in the API docs - Issue [458](https://github.com/sdv-dev/SDV/issues/458) by fealho
* Ensure forumla constraint is called ColumnFormula everywhere in the docs - Issue [449](https://github.com/sdv-dev/SDV/issues/449) by fealho

This release changes the way we sample conditions to not only group by the conditions passed by the user, but also by the transformed conditions that result from them.

Issues resolved

* Conditionally sampling on variable in constraint should have variety for other variables - Issue [440](https://github.com/sdv-dev/SDV/issues/440) by amontanez24