make release-tag: Merge branch 'main' into stable

Author: amontanez24

CONTRIBUTING.rst

@@ -174,17 +174,17 @@ Release Workflow
 The process of releasing a new version involves several steps combining both ``git`` and
 ``bumpversion`` which, briefly:
 
-1. Merge what is in ``master`` branch into ``stable`` branch.
+1. Merge what is in ``main`` branch into ``stable`` branch.
 2. Update the version in ``setup.cfg``, ``sdmetrics/__init__.py`` and
    ``HISTORY.md`` files.
 3. Create a new git tag pointing at the corresponding commit in ``stable`` branch.
-4. Merge the new commit from ``stable`` into ``master``.
+4. Merge the new commit from ``stable`` into ``main``.
 5. Update the version in ``setup.cfg`` and ``sdmetrics/__init__.py``
    to open the next development iteration.
 
 .. note:: Before starting the process, make sure that ``HISTORY.md`` has been updated with a new
           entry that explains the changes that will be included in the new version.
-          Normally this is just a list of the Pull Requests that have been merged to master
+          Normally this is just a list of the Pull Requests that have been merged to main
           since the last release.
 
 Once this is done, run of the following commands:

HISTORY.md

@@ -1,5 +1,80 @@
 # History
 
+## v0.13.0 - 2023-12-04
+
+This release makes significant improvements to the Diagnostic Reports! The report now runs a diagnostic to calculate scores for three basic but important properties of your data: data validity, data structure and in the multi table case, relationship validity. Data validity checks that the columns of your data are valid (eg. correct range or values). Data structure makes sure the synthetic data has the correct columns. Relationship validity checks to make sure key references are correct and the cardinality is within ranges seen in the real data. These changes are meant to make the `DiagnosticReport` a quick way for you to see if there are any major problems with your synthetic data.
+
+Additionally, some general improvements were made and bugs were resolved. The `LogisticDetection` and `SVCDetection` metrics were fixed to only use boolean, categorical, datetime and numeric columns in their calculations. A bug that prevented visualizations from displaying on Jupyter notebooks was patched. The cardinality property in the multi table `QualityReport` can now handle multiple foreign keys to the same parent. Finally, a new visualization was added for sequential/timeseries data called `get_column_line_plot`.
+
+### New Features
+
+* Detection metrics should only use statistically modeled columns (filter out the rest) - Issue [#286](https://github.com/sdv-dev/SDMetrics/issues/286) by @lajohn4747
+* Add visualization for timeseries / sequential data  - Issue [#376](https://github.com/sdv-dev/SDMetrics/issues/376) by @lajohn4747
+* Multi table quality report should handle multi-foreign keys (to same parent) - Issue [#406](https://github.com/sdv-dev/SDMetrics/issues/406) by @R-Palazzo
+* Add `KeyUniqueness` metric - Issue [#460](https://github.com/sdv-dev/SDMetrics/issues/460) by @R-Palazzo
+* Add `ReferentialIntegrity` metric - Issue [#461](https://github.com/sdv-dev/SDMetrics/issues/461) by @R-Palazzo
+* Add `CategoryAdherence` metric - Issue [#462](https://github.com/sdv-dev/SDMetrics/issues/462) by @R-Palazzo
+* Add `TableFormat` metric - Issue [#463](https://github.com/sdv-dev/SDMetrics/issues/463) by @R-Palazzo
+* Add `CardinalityBoundaryAdherence` metric - Issue [#464](https://github.com/sdv-dev/SDMetrics/issues/464) by @frances-h
+* Add `DataValidity` property - Issue [#467](https://github.com/sdv-dev/SDMetrics/issues/467) by @R-Palazzo
+* Add `Structure` property - Issue [#468](https://github.com/sdv-dev/SDMetrics/issues/468) by @R-Palazzo
+* Add `Relationship Validity` property - Issue [#469](https://github.com/sdv-dev/SDMetrics/issues/469) by @R-Palazzo
+* Update `DiagnosticReport` to calculate base correctness of synthetic data - Issue [#471](https://github.com/sdv-dev/SDMetrics/issues/471) by @R-Palazzo
+* Update the synthetic data that's available for the multi-table demo - Issue [#501](https://github.com/sdv-dev/SDMetrics/issues/501) by @R-Palazzo
+* Update the synthetic data that's available for the single-table demo - Issue [#502](https://github.com/sdv-dev/SDMetrics/issues/502) by @R-Palazzo
+* Update `TableFormat` metric to `TableStructure` + fix its computation - Issue [#518](https://github.com/sdv-dev/SDMetrics/issues/518) by @R-Palazzo
+
+### Bugs Fixed
+
+* Sometimes graphs don't show when using Jupyter notebook - Issue [#322](https://github.com/sdv-dev/SDMetrics/issues/322) by @pvk-developer
+* Fix ReferentialIntegrity NaN handling - Issue [#494](https://github.com/sdv-dev/SDMetrics/issues/494) by @R-Palazzo
+* KeyUniqueness metric should only be applied to primary and alternate keys - Issue [#503](https://github.com/sdv-dev/SDMetrics/issues/503) by @R-Palazzo
+* Single table Structure property should not have visualization - Issue [#504](https://github.com/sdv-dev/SDMetrics/issues/504) by @R-Palazzo
+* Multi table Structure property visualization has incorrect styling - Issue [#505](https://github.com/sdv-dev/SDMetrics/issues/505) by @R-Palazzo
+* `UserWarning: KeyError: 'relationships'` in DiagnosticReport if metadata missing relationships - Issue [#506](https://github.com/sdv-dev/SDMetrics/issues/506) by @R-Palazzo
+* Report `validate` method should be private - Issue [#507](https://github.com/sdv-dev/SDMetrics/issues/507) by @R-Palazzo
+* `ValueError` in DiagnosticReport if synthetic data does not match metadata - Issue [#508](https://github.com/sdv-dev/SDMetrics/issues/508) by @R-Palazzo
+* Check if QualityReport needs the synthetic data to match the metadata - Issue [#509](https://github.com/sdv-dev/SDMetrics/issues/509) by @R-Palazzo
+* Running single table report on multi table data (or vice versa) results in confusing error - Issue [#510](https://github.com/sdv-dev/SDMetrics/issues/510) by @R-Palazzo
+* Add metadata validation - Issue [#526](https://github.com/sdv-dev/SDMetrics/issues/526) by @R-Palazzo
+
+## v0.12.1 - 2023-11-01
+
+This release fixes a bug with the new Intertable Trends property and older pandas versions and a bug with how the ML Efficacy metric handled train and test data. Reports handle missing relationships more gracefully.
+
+### Bugs Fixed
+
+* Multiple FutureWarning lines printed out when running the Quality Report (Intertable Trends property) - Issue [#490](https://github.com/sdv-dev/SDMetrics/issues/490) by @frances-h
+* Transformer should not be fit on test data - Issue [#291](https://github.com/sdv-dev/SDMetrics/issues/291) by @fealho
+* Reports should not crash if there are no relationships - Issue [#481](https://github.com/sdv-dev/SDMetrics/issues/481) by @lajohn4747
+
+## v0.12.0 - 2023-10-31
+
+This release adds a new property, InterTable Trends. Several plots were moved from the reports module into the new visualizations module.  The `metadata` parameter was removed for these plots, and the `plot_types` parameter was added. `plot_types` lets the user control which plot type is used. Several crashes have been resolved.
+
+### New Features
+
+* Provide meta information about the reports - Pull [#472](https://github.com/sdv-dev/SDMetrics/pull/472) by @frances-h
+* Validate that the metadata is always a dict - Issue [#428](https://github.com/sdv-dev/SDMetrics/issues/428) by @R-Palazzo
+* Expose reports module in top-level init - Pull [#459](https://github.com/sdv-dev/SDMetrics/pull/459) by @frances-h
+* Add new get_column_pair_plot - Issue [#444](https://github.com/sdv-dev/SDMetrics/issues/444) by @pvk-developer
+* Add InterTable Trends property - Issue [#451](https://github.com/sdv-dev/SDMetrics/issues/451) by @frances-h
+* Add new get_column_plot - Issue [#443](https://github.com/sdv-dev/SDMetrics/issues/443) by @pvk-developer
+* Add new get_cardinality_plot - Issue [#445](https://github.com/sdv-dev/SDMetrics/issues/445) by @frances-h
+* Create visualizations module - Issue [#442](https://github.com/sdv-dev/SDMetrics/issues/442) by @frances-h, @pvk-developer
+
+### Bugs Fixed
+
+* Fix `NewRowSynthesis` on datetime columns without formats - Issue [#473](https://github.com/sdv-dev/SDMetrics/issues/473) by @fealho
+* Intertable trends property crashes if a table has no statistical columns - Issue [#476](https://github.com/sdv-dev/SDMetrics/issues/476) by @lajohn4747
+* Fix BoundaryAdherence NaN handling - Issue [#470](https://github.com/sdv-dev/SDMetrics/issues/470) by @frances-h
+* The Intertable Trends visualization is mislabeled as 'Column Shapes' - Issue [#477](https://github.com/sdv-dev/SDMetrics/issues/477) by @lajohn4747
+* ValueError when using get_cardinality_plot on some schemas - Issue [#447](https://github.com/sdv-dev/SDMetrics/issues/447) by @frances-h
+
+### Internal
+
+* Switch default branch from master to main - Issue [#420](https://github.com/sdv-dev/SDMetrics/issues/420) by @amontanez24
+
 ## v0.11.1 - 2023-09-14
 
 This release makes multiple changes to better handle errors that get raised from the `DiagnosticReport`. The report should be able to run to completion now and have any errors that it encounters reported in a column on the details that can be observed from running `get_details`. It also resolves many warnings that were interrupting the printing of the report's results and progress.

INSTALL.md

@@ -46,12 +46,12 @@ make install
 
 If you intend to modify the source code or contribute to the project you will need to
 install it from the source using the `make install-develop` command. In this case, we
-recommend you to branch from `master` first:
+recommend you to branch from `main` first:
 
 ```bash
 git clone [email protected]:sdv-dev/SDMetrics
 cd SDMetrics
-git checkout master
+git checkout main
 git checkout -b <your-branch-name>
 make install-develp
 ```

Makefile

@@ -146,22 +146,22 @@ publish: dist publish-confirm ## package and upload a release
 	twine upload dist/*
 
 .PHONY: bumpversion-release
-bumpversion-release: ## Merge master to stable and bumpversion release
+bumpversion-release: ## Merge main to stable and bumpversion release
 	git checkout stable || git checkout -b stable
-	git merge --no-ff master -m"make release-tag: Merge branch 'master' into stable"
+	git merge --no-ff main -m"make release-tag: Merge branch 'main' into stable"
 	bumpversion release
 	git push --tags origin stable
 
 .PHONY: bumpversion-release-test
-bumpversion-release-test: ## Merge master to stable and bumpversion release
+bumpversion-release-test: ## Merge main to stable and bumpversion release
 	git checkout stable || git checkout -b stable
-	git merge --no-ff master -m"make release-tag: Merge branch 'master' into stable"
+	git merge --no-ff main -m"make release-tag: Merge branch 'main' into stable"
 	bumpversion release --no-tag
 	@echo git push --tags origin stable
 
 .PHONY: bumpversion-patch
-bumpversion-patch: ## Merge stable to master and bumpversion patch
-	git checkout master
+bumpversion-patch: ## Merge stable to main and bumpversion patch
+	git checkout main
 	git merge stable
 	bumpversion --no-tag patch
 	git push
@@ -180,7 +180,7 @@ bumpversion-major: ## Bump the version the next major skipping the release
 
 .PHONY: bumpversion-revert
 bumpversion-revert: ## Undo a previous bumpversion-release
-	git checkout master
+	git checkout main
 	git branch -D stable
 
 CLEAN_DIR := $(shell git status --short | grep -v ??)
@@ -193,10 +193,10 @@ ifneq ($(CLEAN_DIR),)
 	$(error There are uncommitted changes)
 endif
 
-.PHONY: check-master
-check-master: ## Check if we are in master branch
-ifneq ($(CURRENT_BRANCH),master)
-	$(error Please make the release from master branch\n)
+.PHONY: check-main
+check-main: ## Check if we are in main branch
+ifneq ($(CURRENT_BRANCH),main)
+	$(error Please make the release from main branch\n)
 endif
 
 .PHONY: check-history
@@ -206,7 +206,7 @@ ifeq ($(CHANGELOG_LINES),0)
 endif
 
 .PHONY: check-release
-check-release: check-clean check-master check-history ## Check if the release can be made
+check-release: check-clean check-main check-history ## Check if the release can be made
 	@echo "A new release can be made"
 
 .PHONY: release
@@ -216,10 +216,10 @@ release: check-release bumpversion-release publish bumpversion-patch
 release-test: check-release bumpversion-release-test publish-test bumpversion-revert
 
 .PHONY: release-candidate
-release-candidate: check-master publish bumpversion-candidate
+release-candidate: check-main publish bumpversion-candidate
 
 .PHONY: release-candidate-test
-release-candidate-test: check-clean check-master publish-test
+release-candidate-test: check-clean check-main publish-test
 
 .PHONY: release-minor
 release-minor: check-release bumpversion-minor release

README.md

@@ -7,16 +7,16 @@
 [![Development Status](https://img.shields.io/badge/Development%20Status-2%20--%20Pre--Alpha-yellow)](https://pypi.org/search/?c=Development+Status+%3A%3A+2+-+Pre-Alpha)
 [![PyPI Shield](https://img.shields.io/pypi/v/sdmetrics.svg)](https://pypi.python.org/pypi/sdmetrics)
 [![Downloads](https://pepy.tech/badge/sdmetrics)](https://pepy.tech/project/sdmetrics)
-[![Tests](https://github.com/sdv-dev/SDMetrics/workflows/Run%20Tests/badge.svg)](https://github.com/sdv-dev/SDMetrics/actions?query=workflow%3A%22Run+Tests%22+branch%3Amaster)
-[![Coverage Status](https://codecov.io/gh/sdv-dev/SDMetrics/branch/master/graph/badge.svg)](https://codecov.io/gh/sdv-dev/SDMetrics)
+[![Tests](https://github.com/sdv-dev/SDMetrics/workflows/Run%20Tests/badge.svg)](https://github.com/sdv-dev/SDMetrics/actions?query=workflow%3A%22Run+Tests%22+branch%3Amain)
+[![Coverage Status](https://codecov.io/gh/sdv-dev/SDMetrics/branch/main/graph/badge.svg)](https://codecov.io/gh/sdv-dev/SDMetrics)
 [![Slack](https://img.shields.io/badge/Community-Slack-blue?style=plastic&logo=slack)](https://bit.ly/sdv-slack-invite)
 [![Tutorial](https://img.shields.io/badge/Demo-Get%20started-orange?style=plastic&logo=googlecolab)](https://bit.ly/sdmetrics-demo)
 
 <div align="left">
 <br/>
 <p align="center">
 <a href="https://github.com/sdv-dev/SDV">
-<img align="center" width=40% src="https://github.com/sdv-dev/SDV/blob/master/docs/images/SDMetrics-DataCebo.png"></img>
+<img align="center" width=40% src="https://github.com/sdv-dev/SDV/blob/stable/docs/images/SDMetrics-DataCebo.png"></img>
 </a>
 </p>
 </div>
@@ -121,7 +121,7 @@ To learn more about the reports and metrics, visit the [SDMetrics Documentation]
 
 
 <div align="center">
-<a href="https://datacebo.com"><img align="center" width=40% src="https://github.com/sdv-dev/SDV/blob/master/docs/images/DataCebo.png"></img></a>
+<a href="https://datacebo.com"><img align="center" width=40% src="https://github.com/sdv-dev/SDV/blob/stable/docs/images/DataCebo.png"></img></a>
 </div>
 <br/>
 <br/>

RELEASE.md

@@ -7,7 +7,7 @@ This document describes the steps required to perform a full release of **SDMetr
 Before starting to prepare an **SDMetrics** release make sure of the following points:
 
 1. All the changes that need to be included in the current release have been added to
-   the [sdv-dev/SDMetrics repository](https://github.com/sdv-dev/SDMetrics) `master`
+   the [sdv-dev/SDMetrics repository](https://github.com/sdv-dev/SDMetrics) `main`
    branch.
 2. All the issues related to code changes which were closed after the latest release
    have been assigned to the current milestone, given a `bug` or `enhancement` tag
@@ -18,7 +18,7 @@ Before starting to prepare an **SDMetrics** release make sure of the following p
    an issue and assign a developer, a tag and a milestone to it directly.
 4. The Milestone that corresponds to the release does not have any issue that is still open.
    If there is any, either close it (if possible), or deassign it from the Milestone.
-5. The latest build for the `master` branch performed by the CI systems (Github Actions
+5. The latest build for the `main` branch performed by the CI systems (Github Actions
    and Travis) was successful. If the builds are more than a couple of days old, re-trigger
    them and wait for them to finish successfully.
 
@@ -146,7 +146,7 @@ Thanks to @<CONTRIBUTOR-USER-NAMES...> for contributing to this release.
 
 In case of doubt, loo at the previous release notes and try to follow a similar style.
 
-Once this is done, commit the change directly to `master` with the message `Add release notes for
+Once this is done, commit the change directly to `main` with the message `Add release notes for
 vX.Y.Z`.
 
 ## Make the final release

conda/meta.yaml

@@ -1,4 +1,4 @@
-{% set version = '0.11.1' %}
+{% set version = '0.13.0.dev1' %}
 
 package:
   name: "{{ name|lower }}"

sdmetrics/__init__.py

@@ -4,7 +4,7 @@
 
 __author__ = 'MIT Data To AI Lab'
 __email__ = '[email protected]'
-__version__ = '0.11.1'
+__version__ = '0.13.0.dev1'
 
 import sys
 import warnings as python_warnings
@@ -15,7 +15,7 @@
 from pkg_resources import iter_entry_points
 
 from sdmetrics import (
-    column_pairs, demos, goal, multi_table, single_column, single_table, timeseries)
+    column_pairs, demos, goal, multi_table, reports, single_column, single_table, timeseries)
 from sdmetrics.demos import load_demo
 
 __all__ = [
@@ -27,6 +27,7 @@
     'single_column',
     'single_table',
     'timeseries',
+    'reports',
 ]
 
 

sdmetrics/column_pairs/__init__.py

@@ -1,15 +1,20 @@
 """Metrics to compare column pairs."""
 
 from sdmetrics.column_pairs.base import ColumnPairsMetric
+from sdmetrics.column_pairs.statistical.cardinality_boundary_adherence import (
+    CardinalityBoundaryAdherence)
 from sdmetrics.column_pairs.statistical.contingency_similarity import ContingencySimilarity
 from sdmetrics.column_pairs.statistical.correlation_similarity import CorrelationSimilarity
 from sdmetrics.column_pairs.statistical.kl_divergence import (
     ContinuousKLDivergence, DiscreteKLDivergence)
+from sdmetrics.column_pairs.statistical.referential_integrity import ReferentialIntegrity
 
 __all__ = [
+    'CardinalityBoundaryAdherence',
     'ColumnPairsMetric',
     'ContingencySimilarity',
     'ContinuousKLDivergence',
     'CorrelationSimilarity',
     'DiscreteKLDivergence',
+    'ReferentialIntegrity',
 ]

sdmetrics/column_pairs/statistical/__init__.py

@@ -1,13 +1,18 @@
 """Statistical Metrics to compare column pairs."""
 
+from sdmetrics.column_pairs.statistical.cardinality_boundary_adherence import (
+    CardinalityBoundaryAdherence)
 from sdmetrics.column_pairs.statistical.contingency_similarity import ContingencySimilarity
 from sdmetrics.column_pairs.statistical.correlation_similarity import CorrelationSimilarity
 from sdmetrics.column_pairs.statistical.kl_divergence import (
     ContinuousKLDivergence, DiscreteKLDivergence)
+from sdmetrics.column_pairs.statistical.referential_integrity import ReferentialIntegrity
 
 __all__ = [
+    'CardinalityBoundaryAdherence',
     'ContingencySimilarity',
     'ContinuousKLDivergence',
     'CorrelationSimilarity',
     'DiscreteKLDivergence',
+    'ReferentialIntegrity',
 ]