Skip to content

Commit

Permalink
make release-tag: Merge branch 'master' into stable
Browse files Browse the repository at this point in the history
  • Loading branch information
amontanez24 committed Jul 22, 2022
2 parents b7392bb + f44ad92 commit 28e751a
Show file tree
Hide file tree
Showing 63 changed files with 5,203 additions and 7,080 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Bug report
about: Report an error that you found when using SDV
title: ''
labels: bug, pending review
labels: bug, new
assignees: ''

---
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Feature request
about: Request a new feature that you would like to see implemented in SDV
title: ''
labels: new feature, pending review
labels: new feature, new
assignees: ''

---
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Question
about: Ask a general question about SDV usage
title: ''
labels: question, pending review
labels: question, new
assignees: ''

---
Expand Down
68 changes: 68 additions & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,73 @@
# Release Notes

## 0.16.0 - 2022-07-21

This release brings user friendly improvements and bug fixes on the `SDV` constraints, to help
users generate their synthetic data easily.

Some predefined constraints have been renamed and redefined to be more user friendly & consistent.
The custom constraint API has also been updated for usability. The SDV now automatically determines
the best `handling_strategy` to use for each constraint, attempting `transform` by default and
falling back to `reject_sampling` otherwise. The `handling_strategy` parameters are no longer
included in the API.

Finally, this version of `SDV` also unifies the parameters for all sampling related methods for
all models (including TabularPreset).

### Changes to Constraints

* `GreatherThan` constraint is now separated in two new constraints: `Inequality`, which is
intended to be used between two columns, and `ScalarInequality`, which is intended to be used
between a column and a scalar.

* `Between` constraint is now separated in two new constraints: `Range`, which is intended to
be used between three columns, and `ScalarRange`, which is intended to be used between a column
and low and high scalar values.

* `FixedIncrements` a new constraint that makes the data increment by a certain value.
* New `create_custom_constraint` function available to create custom constraints.

### Removed Constraints
* `Rounding` Rounding is automatically being handled by the ``rdt.HyperTransformer``.
* `ColumnFormula` the `create_custom_constraint` takes place over this one and allows more
advanced usage for the end users.

### New Features

* Improve error message for invalid constraints - Issue [#801](https://github.com/sdv-dev/SDV/issues/801) by @fealho
* Numerical Instability in Constrained GaussianCopula - Issue [#806](https://github.com/sdv-dev/SDV/issues/806) by @fealho
* Unify sampling params for reject sampling - Issue [#809](https://github.com/sdv-dev/SDV/issues/809) by @amontanez24
* Split `GreaterThan` constraint into `Inequality` and `ScalarInequality` - Issue [#814](https://github.com/sdv-dev/SDV/issues/814) by @fealho
* Split `Between` constraint into `Range` and `ScalarRange` - Issue [#815](https://github.com/sdv-dev/SDV/issues/815) @pvk-developer
* Change `columns` to `column_names` in `OneHotEncoding` and `Unique` constraints - Issue [#816](https://github.com/sdv-dev/SDV/issues/816) by @amontanez24
* Update columns parameter in `Positive` and `Negative` constraint - Issue [#817](https://github.com/sdv-dev/SDV/issues/817) by @fealho
* Create `FixedIncrements` constraint - Issue [#818](https://github.com/sdv-dev/SDV/issues/818) by @amontanez24
* Improve datetime handling in `ScalarInequality` and `ScalarRange` constraints - Issue [#819](https://github.com/sdv-dev/SDV/issues/819) by @pvk-developer
* Support strict boundaries even when transform strategy is used - Issue [#820](https://github.com/sdv-dev/SDV/issues/820) by @fealho
* Add `create_custom_constraint` factory method - Issue [#836](https://github.com/sdv-dev/SDV/issues/836) by @fealho

### Internal Improvements
* Remove `handling_strategy` parameter - Issue [#833](https://github.com/sdv-dev/SDV/issues/833) by @amontanez24
* Remove `fit_columns_model` parameter - Issue [#834](https://github.com/sdv-dev/SDV/issues/834) by @pvk-developer
* Remove the `ColumnFormula` constraint - Issue [#837](https://github.com/sdv-dev/SDV/issues/837) by @amontanez24
* Move `table_data.copy` to base class of constraints - Issue [#845](https://github.com/sdv-dev/SDV/issues/845) by @fealho

### Bugs Fixed
* Numerical Instability in Constrained GaussianCopula - Issue [#801](https://github.com/sdv-dev/SDV/issues/801) by @tlranda and @fealho
* Fix error message for `FixedIncrements` - Issue [#865](https://github.com/sdv-dev/SDV/issues/865) by @pvk-developer
* Fix constraints with conditional sampling - Issue [#866](https://github.com/sdv-dev/SDV/issues/866) by @amontanez24
* Fix error message in `ScalarInequality` - Issue [#868](https://github.com/sdv-dev/SDV/issues/868) by @pvk-developer
* 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
* 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
* `TabularPreset` doesn't support new sampling parameters - Issue [#887](https://github.com/sdv-dev/SDV/issues/887) by @fealho
* Conditional Sampling: `batch_size` is being set to `None` by default? - Issue [#889](https://github.com/sdv-dev/SDV/issues/889) by @amontanez24
* Conditional sampling using GaussianCopula inefficient when categories are noised - Issue [#910](https://github.com/sdv-dev/SDV/issues/910) by @amontanez24

### Documentation Changes
* Show the `API` for `TabularPreset` models - Issue [#854](https://github.com/sdv-dev/SDV/issues/854) by @katxiao
* Update handling constraints doc - Pull Request [#856](https://github.com/sdv-dev/SDV/issues/856) by @amontanez24
* Update custom costraints documentation - Pull Request [#857](https://github.com/sdv-dev/SDV/issues/857) by @pvk-developer

## 0.15.0 - 2022-05-25

This release improves the speed of the `GaussianCopula` model by removing logic that previously searched for the appropriate distribution to
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
[![Coverage Status](https://codecov.io/gh/sdv-dev/SDV/branch/master/graph/badge.svg)](https://codecov.io/gh/sdv-dev/SDV)
[![Downloads](https://pepy.tech/badge/sdv)](https://pepy.tech/project/sdv)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/sdv-dev/SDV/master?filepath=tutorials)
[![Slack](https://img.shields.io/badge/Slack%20Workspace-Join%20now!-36C5F0?logo=slack)](https://join.slack.com/t/sdv-space/shared_invite/zt-gdsfcb5w-0QQpFMVoyB2Yd6SRiMplcw)
[![Slack](https://img.shields.io/badge/Slack%20Workspace-Join%20now!-36C5F0?logo=slack)](https://bit.ly/sdv-slack-invite)

<div align="left">
<br/>
Expand Down Expand Up @@ -59,7 +59,7 @@ hierarchical generative modeling and recursive sampling techniques.
[License]: https://github.com/sdv-dev/SDV/blob/master/LICENSE
[Development Status]: https://pypi.org/search/?c=Development+Status+%3A%3A+2+-+Pre-Alpha
[Slack Logo]: https://github.com/sdv-dev/SDV/blob/master/docs/images/slack.png
[Community]: https://join.slack.com/t/sdv-space/shared_invite/zt-gdsfcb5w-0QQpFMVoyB2Yd6SRiMplcw
[Community]: https://bit.ly/sdv-slack-invite
[MyBinder Logo]: https://github.com/sdv-dev/SDV/blob/master/docs/images/mybinder.png
[Tutorials]: https://mybinder.org/v2/gh/sdv-dev/SDV/master?filepath=tutorials

Expand Down Expand Up @@ -98,7 +98,7 @@ If you want to be part of the SDV community to receive announcements of the late
ask questions, suggest new features or participate in the development meetings, please join
our Slack Workspace!

[![Slack](https://img.shields.io/badge/Slack%20Workspace-Join%20now!-36C5F0?logo=slack)](https://join.slack.com/t/sdv-space/shared_invite/zt-gdsfcb5w-0QQpFMVoyB2Yd6SRiMplcw)
[![Slack](https://img.shields.io/badge/Slack%20Workspace-Join%20now!-36C5F0?logo=slack)](https://bit.ly/sdv-slack-invite)

# Install

Expand Down Expand Up @@ -251,7 +251,7 @@ https://github.com/sdv-dev/SDMetrics) library.
to see how you can contribute to the project.
3. If you have any doubts, feature requests or detect an error, please [open an issue on github](
https://github.com/sdv-dev/SDV/issues) or [join our Slack Workspace](
https://join.slack.com/t/sdv-space/shared_invite/zt-gdsfcb5w-0QQpFMVoyB2Yd6SRiMplcw)
https://bit.ly/sdv-slack-invite)
4. Also, do not forget to check the [project documentation site](https://sdv.dev/SDV/)!

# Citation
Expand Down
2 changes: 1 addition & 1 deletion conda/meta.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{% set name = 'sdv' %}
{% set version = '0.15.0' %}
{% set version = '0.16.0.dev6' %}

package:
name: "{{ name|lower }}"
Expand Down
122 changes: 53 additions & 69 deletions docs/api_reference/constraints/tabular.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,8 @@ Tabular Constraints

.. currentmodule:: sdv.constraints

CustomConstraint
~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: api/

CustomConstraint
CustomConstraint.fit
CustomConstraint.transform
CustomConstraint.fit_transform
CustomConstraint.reverse_transform
CustomConstraint.is_valid
CustomConstraint.filter_valid
CustomConstraint.from_dict
CustomConstraint.to_dict

FixedCombinations
~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: api/
Expand All @@ -37,24 +21,40 @@ FixedCombinations
FixedCombinations.from_dict
FixedCombinations.to_dict

GreaterThan
Inequality
~~~~~~~~~~

.. autosummary::
:toctree: api/

Inequality
Inequality.fit
Inequality.transform
Inequality.fit_transform
Inequality.reverse_transform
Inequality.is_valid
Inequality.filter_valid
Inequality.from_dict
Inequality.to_dict

ScalarInequality
~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: api/

GreaterThan
GreaterThan.fit
GreaterThan.transform
GreaterThan.fit_transform
GreaterThan.reverse_transform
GreaterThan.is_valid
GreaterThan.filter_valid
GreaterThan.from_dict
GreaterThan.to_dict
ScalarInequality
ScalarInequality.fit
ScalarInequality.transform
ScalarInequality.fit_transform
ScalarInequality.reverse_transform
ScalarInequality.is_valid
ScalarInequality.filter_valid
ScalarInequality.from_dict
ScalarInequality.to_dict

Positive
~~~~~~~~~~~~~~~~
~~~~~~~~

.. autosummary::
:toctree: api/
Expand All @@ -70,7 +70,7 @@ Positive
Positive.to_dict

Negative
~~~~~~~~~~~~~~~~
~~~~~~~~

.. autosummary::
:toctree: api/
Expand All @@ -85,56 +85,40 @@ Negative
Negative.from_dict
Negative.to_dict

ColumnFormula
~~~~~~~~~~~~~~~~
Range
~~~~~

.. autosummary::
:toctree: api/

ColumnFormula
ColumnFormula.fit
ColumnFormula.transform
ColumnFormula.fit_transform
ColumnFormula.reverse_transform
ColumnFormula.is_valid
ColumnFormula.filter_valid
ColumnFormula.from_dict
ColumnFormula.to_dict
Range
Range.fit
Range.transform
Range.fit_transform
Range.reverse_transform
Range.is_valid
Range.filter_valid
Range.from_dict
Range.to_dict

Between
~~~~~~~
ScalarRange
~~~~~~~~~~~

.. autosummary::
:toctree: api/

Between
Between.fit
Between.transform
Between.fit_transform
Between.reverse_transform
Between.is_valid
Between.filter_valid
Between.from_dict
Between.to_dict

Rounding
~~~~~~~~

.. autosummary::
:toctree: api/

Rounding
Rounding.fit
Rounding.transform
Rounding.fit_transform
Rounding.reverse_transform
Rounding.is_valid
Rounding.filter_valid
Rounding.from_dict
Rounding.to_dict
ScalarRange
ScalarRange.fit
ScalarRange.transform
ScalarRange.fit_transform
ScalarRange.reverse_transform
ScalarRange.is_valid
ScalarRange.filter_valid
ScalarRange.from_dict
ScalarRange.to_dict

OneHotEncoding
~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~

.. autosummary::
:toctree: api/
Expand All @@ -150,7 +134,7 @@ OneHotEncoding
OneHotEncoding.to_dict

Unique
~~~~~~~~~~~~~~~~
~~~~~~

.. autosummary::
:toctree: api/
Expand Down
1 change: 1 addition & 0 deletions docs/api_reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ and classes in SDV.
:maxdepth: 2

sdv
lite/index
tabular/index
relational/index
timeseries/index
Expand Down
10 changes: 10 additions & 0 deletions docs/api_reference/lite/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _sdv.lite:

sdv.lite
========

.. toctree::
:maxdepth: 1
:titlesonly:

tabular
18 changes: 18 additions & 0 deletions docs/api_reference/lite/tabular.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.. _sdv.lite.tabular:

.. currentmodule:: sdv.lite.tabular

TabularPreset
=============

.. autosummary::
:toctree: api/

TabularPreset
TabularPreset.list_available_presets
TabularPreset.fit
TabularPreset.sample
TabularPreset.sample_conditions
TabularPreset.sample_remaining_columns
TabularPreset.save
TabularPreset.load
7 changes: 5 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,20 @@
'nbsphinx',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.autosectionlabel',
'sphinx.ext.githubpages',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'IPython.sphinxext.ipython_console_highlighting',
'IPython.sphinxext.ipython_directive',
'sphinx_toolbox.collapse'
]

ipython_execlines = [
"from utils import is_valid, transform, reverse_transform",
"import pandas as pd",
"pd.set_option('display.width', 1000000)",
"pd.set_option('max_columns', 1000)",
"pd.set_option('display.max_columns', 1000)",
]

autosummary_generate = True
Expand Down Expand Up @@ -135,7 +138,7 @@
html_theme_options = {
"github_url": "https://github.com/sdv-dev/SDV",
"twitter_url": "https://twitter.com/sdv_dev",
"slack_url": "https://join.slack.com/t/sdv-space/shared_invite/zt-gdsfcb5w-0QQpFMVoyB2Yd6SRiMplcw",
"slack_url": "https://bit.ly/sdv-slack-invite",
"show_prev_next": True,
"google_analytics_id": "UA-180602145-3",
}
Expand Down
Loading

0 comments on commit 28e751a

Please sign in to comment.