|
1 | 1 | # Release Notes
|
2 | 2 |
|
| 3 | +## 0.16.0 - 2022-07-21 |
| 4 | + |
| 5 | +This release brings user friendly improvements and bug fixes on the `SDV` constraints, to help |
| 6 | +users generate their synthetic data easily. |
| 7 | + |
| 8 | +Some predefined constraints have been renamed and redefined to be more user friendly & consistent. |
| 9 | +The custom constraint API has also been updated for usability. The SDV now automatically determines |
| 10 | +the best `handling_strategy` to use for each constraint, attempting `transform` by default and |
| 11 | +falling back to `reject_sampling` otherwise. The `handling_strategy` parameters are no longer |
| 12 | +included in the API. |
| 13 | + |
| 14 | +Finally, this version of `SDV` also unifies the parameters for all sampling related methods for |
| 15 | +all models (including TabularPreset). |
| 16 | + |
| 17 | +### Changes to Constraints |
| 18 | + |
| 19 | +* `GreatherThan` constraint is now separated in two new constraints: `Inequality`, which is |
| 20 | + intended to be used between two columns, and `ScalarInequality`, which is intended to be used |
| 21 | + between a column and a scalar. |
| 22 | + |
| 23 | +* `Between` constraint is now separated in two new constraints: `Range`, which is intended to |
| 24 | + be used between three columns, and `ScalarRange`, which is intended to be used between a column |
| 25 | + and low and high scalar values. |
| 26 | + |
| 27 | +* `FixedIncrements` a new constraint that makes the data increment by a certain value. |
| 28 | +* New `create_custom_constraint` function available to create custom constraints. |
| 29 | + |
| 30 | +### Removed Constraints |
| 31 | +* `Rounding` Rounding is automatically being handled by the ``rdt.HyperTransformer``. |
| 32 | +* `ColumnFormula` the `create_custom_constraint` takes place over this one and allows more |
| 33 | + advanced usage for the end users. |
| 34 | + |
| 35 | +### New Features |
| 36 | + |
| 37 | +* Improve error message for invalid constraints - Issue [#801](https://github.com/sdv-dev/SDV/issues/801) by @fealho |
| 38 | +* Numerical Instability in Constrained GaussianCopula - Issue [#806](https://github.com/sdv-dev/SDV/issues/806) by @fealho |
| 39 | +* Unify sampling params for reject sampling - Issue [#809](https://github.com/sdv-dev/SDV/issues/809) by @amontanez24 |
| 40 | +* Split `GreaterThan` constraint into `Inequality` and `ScalarInequality` - Issue [#814](https://github.com/sdv-dev/SDV/issues/814) by @fealho |
| 41 | +* Split `Between` constraint into `Range` and `ScalarRange` - Issue [#815](https://github.com/sdv-dev/SDV/issues/815) @pvk-developer |
| 42 | +* Change `columns` to `column_names` in `OneHotEncoding` and `Unique` constraints - Issue [#816](https://github.com/sdv-dev/SDV/issues/816) by @amontanez24 |
| 43 | +* Update columns parameter in `Positive` and `Negative` constraint - Issue [#817](https://github.com/sdv-dev/SDV/issues/817) by @fealho |
| 44 | +* Create `FixedIncrements` constraint - Issue [#818](https://github.com/sdv-dev/SDV/issues/818) by @amontanez24 |
| 45 | +* Improve datetime handling in `ScalarInequality` and `ScalarRange` constraints - Issue [#819](https://github.com/sdv-dev/SDV/issues/819) by @pvk-developer |
| 46 | +* Support strict boundaries even when transform strategy is used - Issue [#820](https://github.com/sdv-dev/SDV/issues/820) by @fealho |
| 47 | +* Add `create_custom_constraint` factory method - Issue [#836](https://github.com/sdv-dev/SDV/issues/836) by @fealho |
| 48 | + |
| 49 | +### Internal Improvements |
| 50 | +* Remove `handling_strategy` parameter - Issue [#833](https://github.com/sdv-dev/SDV/issues/833) by @amontanez24 |
| 51 | +* Remove `fit_columns_model` parameter - Issue [#834](https://github.com/sdv-dev/SDV/issues/834) by @pvk-developer |
| 52 | +* Remove the `ColumnFormula` constraint - Issue [#837](https://github.com/sdv-dev/SDV/issues/837) by @amontanez24 |
| 53 | +* Move `table_data.copy` to base class of constraints - Issue [#845](https://github.com/sdv-dev/SDV/issues/845) by @fealho |
| 54 | + |
| 55 | +### Bugs Fixed |
| 56 | +* Numerical Instability in Constrained GaussianCopula - Issue [#801](https://github.com/sdv-dev/SDV/issues/801) by @tlranda and @fealho |
| 57 | +* Fix error message for `FixedIncrements` - Issue [#865](https://github.com/sdv-dev/SDV/issues/865) by @pvk-developer |
| 58 | +* Fix constraints with conditional sampling - Issue [#866](https://github.com/sdv-dev/SDV/issues/866) by @amontanez24 |
| 59 | +* Fix error message in `ScalarInequality` - Issue [#868](https://github.com/sdv-dev/SDV/issues/868) by @pvk-developer |
| 60 | +* Cannot use `max_tries_per_batch` on sample: `TypeError: sample() got an unexpected keyword argument 'max_tries_per_batch'` - Issue [#885](https://github.com/sdv-dev/SDV/issues/885) by @amontanez24 |
| 61 | +* Conditional sampling + batch size: `ValueError: Length of values (1) does not match length of index (5)` - Issue [#886](https://github.com/sdv-dev/SDV/issues/886) by @amontanez24 |
| 62 | +* `TabularPreset` doesn't support new sampling parameters - Issue [#887](https://github.com/sdv-dev/SDV/issues/887) by @fealho |
| 63 | +* Conditional Sampling: `batch_size` is being set to `None` by default? - Issue [#889](https://github.com/sdv-dev/SDV/issues/889) by @amontanez24 |
| 64 | +* Conditional sampling using GaussianCopula inefficient when categories are noised - Issue [#910](https://github.com/sdv-dev/SDV/issues/910) by @amontanez24 |
| 65 | + |
| 66 | +### Documentation Changes |
| 67 | +* Show the `API` for `TabularPreset` models - Issue [#854](https://github.com/sdv-dev/SDV/issues/854) by @katxiao |
| 68 | +* Update handling constraints doc - Pull Request [#856](https://github.com/sdv-dev/SDV/issues/856) by @amontanez24 |
| 69 | +* Update custom costraints documentation - Pull Request [#857](https://github.com/sdv-dev/SDV/issues/857) by @pvk-developer |
| 70 | + |
3 | 71 | ## 0.15.0 - 2022-05-25
|
4 | 72 |
|
5 | 73 | This release improves the speed of the `GaussianCopula` model by removing logic that previously searched for the appropriate distribution to
|
|
0 commit comments