mostlyai-qa 1.0.0__tar.gz

mostlyai_qa-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mostlyai_qa-1.0.0/PKG-INFO

@@ -0,0 +1,185 @@
+Metadata-Version: 2.1
+Name: mostlyai-qa
+Version: 1.0.0
+Summary: Quality assurance for synthetic data
+License: Apache License v2
+Author: MOSTLY AI
+Author-email: dev@mostly.ai
+Requires-Python: >=3.10
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: Jinja2 (>=3.1.2)
+Requires-Dist: fastcluster (>=1.2.6)
+Requires-Dist: joblib (>=1.2.0)
+Requires-Dist: numpy (>=1.26.3,<2.0.0)
+Requires-Dist: pandas (>=2.2.0)
+Requires-Dist: phik (>=0.12.4)
+Requires-Dist: plotly (>=5.18.0)
+Requires-Dist: pyarrow (>=16.0.0)
+Requires-Dist: scikit-learn (>=1.4.0)
+Requires-Dist: scipy (>=1.11.0)
+Requires-Dist: sentence-transformers (>=3.1.0)
+Description-Content-Type: text/markdown
+
+# Synthetic Data - Quality Assurance
+
+Assess the fidelity and novelty of synthetic samples with respect to original samples:
+
+1. calculate a rich set of accuracy, similarity and distance metrics
+2. visualize statistics for easy comparison to training and holdout samples
+3. generate a standalone, easy-to-share, easy-to-read HTML summary report
+
+...all with a single line of Python code 💥.
+
+## Getting Started
+
+### Installation
+
+```bash
+pip install -U mostlyai-qa
+```
+
+### Basic Usage
+
+```python
+from mostlyai import qa
+
+# analyze single-table data
+report_path, metrics = qa.report(
+    syn_tgt_data = synthetic_df,
+    trn_tgt_data = training_df,
+    hol_tgt_data = holdout_df,  # optional
+)
+
+# analyze sequential data
+report_path, metrics = qa.report(
+    syn_tgt_data = synthetic_df,
+    trn_tgt_data = training_df,
+    hol_tgt_data = holdout_df,  # optional
+    tgt_context_key = "user_id",
+)
+
+# analyze sequential data with context
+report_path, metrics = qa.report(
+    syn_tgt_data = synthetic_df,
+    trn_tgt_data = training_df,
+    hol_tgt_data = holdout_df,  # optional
+    syn_ctx_data = synthetic_context_df,
+    trn_ctx_data = training_context_df,
+    hol_ctx_data = holdout_context_df,  # optional
+    ctx_primary_key = "id",
+    tgt_context_key = "user_id",
+)
+```
+
+### Syntax
+
+```python
+def report(
+    *,
+    syn_tgt_data: pd.DataFrame,
+    trn_tgt_data: pd.DataFrame,
+    hol_tgt_data: pd.DataFrame | None = None,
+    syn_ctx_data: pd.DataFrame | None = None,
+    trn_ctx_data: pd.DataFrame | None = None,
+    hol_ctx_data: pd.DataFrame | None = None,
+    ctx_primary_key: str | None = None,
+    tgt_context_key: str | None = None,
+    report_path: str | Path | None = "model-report.html",
+    report_title: str = "Model Report",
+    report_subtitle: str = "",
+    report_credits: str = REPORT_CREDITS,
+    report_extra_info: str = "",
+    max_sample_size_accuracy: int = MAX_SAMPLE_SIZE_ACCURACY,
+    max_sample_size_embeddings: int = MAX_SAMPLE_SIZE_EMBEDDINGS,
+    statistics_path: str | Path | None = None,
+    on_progress: ProgressCallback | None = None,
+) -> tuple[Path, dict | None]:
+    """
+    Generate HTML report and metrics for comparing synthetic and original data samples.
+
+    Args:
+        syn_tgt_data: Synthetic samples
+        trn_tgt_data: Training samples
+        hol_tgt_data: Holdout samples
+        syn_ctx_data: Synthetic context samples
+        trn_ctx_data: Training context samples
+        hol_ctx_data: Holdout context samples
+        ctx_primary_key: Column within the context data that contains the primary key
+        tgt_context_key: Column within the target data that contains the key to link to the context
+        report_path: Path of where to store the HTML report
+        report_title: Title of the HTML report
+        report_subtitle: Subtitle of the HTML report
+        report_credits: Credits of the HTML report
+        report_extra_info: Extra details to be included to the HTML report
+        max_sample_size_accuracy: Max sample size for accuracy
+        max_sample_size_embeddings: Max sample size for embeddings (similarity & distances)
+        statistics_path: Path of where to store the statistics to be used by `report_from_statistics`
+        on_progress: A custom progress callback
+    Returns:
+        1. Path to the HTML report
+        2. Dictionary of calculated metrics:
+        - `accuracy`:  # Accuracy is defined as (100% - Total Variation Distance), for each distribution, and then averaged across.
+          - `overall`: Overall accuracy of synthetic data, i.e. average across univariate, bivariate and coherence.
+          - `univariate`: Average accuracy of discretized univariate distributions.
+          - `bivariate`: Average accuracy of discretized bivariate distributions.
+          - `coherence`: Average accuracy of discretized coherence distributions. Only applicable for sequential data.
+          - `overall_max`: Expected overall accuracy of a same-sized holdout. Serves as reference for `overall`.
+          - `univariate_max`: Expected univariate accuracy of a same-sized holdout. Serves as reference for `univariate`.
+          - `bivariate_max`: Expected bivariate accuracy of a same-sized holdout. Serves as reference for `bivariate`.
+          - `coherence_max`: Expected coherence accuracy of a same-sized holdout. Serves as reference for `coherence`.
+        - `similarity`:  # All similarity metrics are calculated within an embedding space.
+            - `cosine_similarity_training_synthetic`: Cosine similarity between training and synthetic centroids.
+            - `cosine_similarity_training_holdout`: Cosine similarity between training and holdout centroids. Serves as reference for `cosine_similarity_training_synthetic`.
+            - `discriminator_auc_training_synthetic`: Cross-validated AUC of a discriminative model to distinguish between training and synthetic samples.
+            - `discriminator_auc_training_holdout`: Cross-validated AUC of a discriminative model to distinguish between training and holdout samples. Serves as reference for `discriminator_auc_training_synthetic`.
+        - `distances`:  # All distance metrics are calculated within an embedding space. An equal number of training and holdout samples is considered.
+            - `ims_training`: Share of synthetic samples that are identical to a training sample.
+            - `ims_holdout`: Share of synthetic samples that are identical to a holdout sample. Serves as reference for `ims_training`.
+            - `dcr_training`: Average L2 nearest-neighbor distance between synthetic and training samples.
+            - `dcr_holdout`: Average L2 nearest-neighbor distance between synthetic and holdout samples. Serves as reference for `dcr_training`.
+            - `dcr_share`: Share of synthetic samples that are closer to a training sample than to a holdout sample. This shall not be significantly larger than 50\%.
+    """
+```
+
+## Metrics
+
+We calculate three sets of metrics to compare synthetic data with the original data.
+
+### Accuracy
+
+We calculate discretized marginal distributions for all columns, to then calculate the L1 distance between the synthetic and the original training data.
+The reported accuracy is then expressed as 100% minus the total variational distance (TVD), which is half the L1 distance between the two distributions.
+We then average across these accuracies to get a single accuracy score. The higher the score, the better the synthetic data.
+
+1. **Univariate Accuracy**: We measure the accuracy for the univariate distributions for all target columns.
+2. **Bivariate Accuracy**: We measure the accuracy for all pair-wise distributions for target columns, as well as for target columns with respect to the context columns.
+3. **Coherence Accuracy**: We measure the accuracy for the auto-correlation for all target columns. Only applicable for sequential data.
+
+An overall accuracy score is then calculated as the average of these aggregate-level scores.
+
+### Similarity
+
+We embed all records into an embedding space, to calculate two metrics:
+
+1. **Cosing Similarity**: We calculate the cosine similarity between the centroids of the synthetic and the original training data. This is then compared to the cosine similarity between the centroids of the original training and holdout data. The higher the score, the better the synthetic data.
+2. **Discriminator AUC**: We train a binary classifier to check whether one can distinguish between synthetic and original training data based on their embeddings. This is again compared to the same metric for the original training and holdout data. A score close to 50% indicates, that synthetic samples are indistinguishable from original samples.
+
+### Distances
+
+We again embed all records into an embedding space, to then measure individual-level L2 distances between samples. For each synthetic sample, we calculate the distance to the nearest original sample (DCR). We once do this with respect to original training records, and once with respect to holdout records, and then compare these DCRs to each other. For privacy-safe synthetic data we expect to see that synthetic data is just as close to original training data, as it is to original holdout data.
+
+## Sample HTML Report
+
+![Metrics](./docs/screenshots/metrics.png)
+![Accuracy Univariates](./docs/screenshots/accuracy_univariates.png)
+![Accuracy Bivariates](./docs/screenshots/accuracy_bivariates.png)
+![Accuracy Coherence](./docs/screenshots/accuracy_coherence.png)
+![Similarity](./docs/screenshots/similarity.png)
+![Distances](./docs/screenshots/distances.png)
+
+See the [examples](./examples/) directory for further examples.
+

mostlyai_qa-1.0.0/README.md

@@ -0,0 +1,158 @@
+# Synthetic Data - Quality Assurance
+
+Assess the fidelity and novelty of synthetic samples with respect to original samples:
+
+1. calculate a rich set of accuracy, similarity and distance metrics
+2. visualize statistics for easy comparison to training and holdout samples
+3. generate a standalone, easy-to-share, easy-to-read HTML summary report
+
+...all with a single line of Python code 💥.
+
+## Getting Started
+
+### Installation
+
+```bash
+pip install -U mostlyai-qa
+```
+
+### Basic Usage
+
+```python
+from mostlyai import qa
+
+# analyze single-table data
+report_path, metrics = qa.report(
+    syn_tgt_data = synthetic_df,
+    trn_tgt_data = training_df,
+    hol_tgt_data = holdout_df,  # optional
+)
+
+# analyze sequential data
+report_path, metrics = qa.report(
+    syn_tgt_data = synthetic_df,
+    trn_tgt_data = training_df,
+    hol_tgt_data = holdout_df,  # optional
+    tgt_context_key = "user_id",
+)
+
+# analyze sequential data with context
+report_path, metrics = qa.report(
+    syn_tgt_data = synthetic_df,
+    trn_tgt_data = training_df,
+    hol_tgt_data = holdout_df,  # optional
+    syn_ctx_data = synthetic_context_df,
+    trn_ctx_data = training_context_df,
+    hol_ctx_data = holdout_context_df,  # optional
+    ctx_primary_key = "id",
+    tgt_context_key = "user_id",
+)
+```
+
+### Syntax
+
+```python
+def report(
+    *,
+    syn_tgt_data: pd.DataFrame,
+    trn_tgt_data: pd.DataFrame,
+    hol_tgt_data: pd.DataFrame | None = None,
+    syn_ctx_data: pd.DataFrame | None = None,
+    trn_ctx_data: pd.DataFrame | None = None,
+    hol_ctx_data: pd.DataFrame | None = None,
+    ctx_primary_key: str | None = None,
+    tgt_context_key: str | None = None,
+    report_path: str | Path | None = "model-report.html",
+    report_title: str = "Model Report",
+    report_subtitle: str = "",
+    report_credits: str = REPORT_CREDITS,
+    report_extra_info: str = "",
+    max_sample_size_accuracy: int = MAX_SAMPLE_SIZE_ACCURACY,
+    max_sample_size_embeddings: int = MAX_SAMPLE_SIZE_EMBEDDINGS,
+    statistics_path: str | Path | None = None,
+    on_progress: ProgressCallback | None = None,
+) -> tuple[Path, dict | None]:
+    """
+    Generate HTML report and metrics for comparing synthetic and original data samples.
+
+    Args:
+        syn_tgt_data: Synthetic samples
+        trn_tgt_data: Training samples
+        hol_tgt_data: Holdout samples
+        syn_ctx_data: Synthetic context samples
+        trn_ctx_data: Training context samples
+        hol_ctx_data: Holdout context samples
+        ctx_primary_key: Column within the context data that contains the primary key
+        tgt_context_key: Column within the target data that contains the key to link to the context
+        report_path: Path of where to store the HTML report
+        report_title: Title of the HTML report
+        report_subtitle: Subtitle of the HTML report
+        report_credits: Credits of the HTML report
+        report_extra_info: Extra details to be included to the HTML report
+        max_sample_size_accuracy: Max sample size for accuracy
+        max_sample_size_embeddings: Max sample size for embeddings (similarity & distances)
+        statistics_path: Path of where to store the statistics to be used by `report_from_statistics`
+        on_progress: A custom progress callback
+    Returns:
+        1. Path to the HTML report
+        2. Dictionary of calculated metrics:
+        - `accuracy`:  # Accuracy is defined as (100% - Total Variation Distance), for each distribution, and then averaged across.
+          - `overall`: Overall accuracy of synthetic data, i.e. average across univariate, bivariate and coherence.
+          - `univariate`: Average accuracy of discretized univariate distributions.
+          - `bivariate`: Average accuracy of discretized bivariate distributions.
+          - `coherence`: Average accuracy of discretized coherence distributions. Only applicable for sequential data.
+          - `overall_max`: Expected overall accuracy of a same-sized holdout. Serves as reference for `overall`.
+          - `univariate_max`: Expected univariate accuracy of a same-sized holdout. Serves as reference for `univariate`.
+          - `bivariate_max`: Expected bivariate accuracy of a same-sized holdout. Serves as reference for `bivariate`.
+          - `coherence_max`: Expected coherence accuracy of a same-sized holdout. Serves as reference for `coherence`.
+        - `similarity`:  # All similarity metrics are calculated within an embedding space.
+            - `cosine_similarity_training_synthetic`: Cosine similarity between training and synthetic centroids.
+            - `cosine_similarity_training_holdout`: Cosine similarity between training and holdout centroids. Serves as reference for `cosine_similarity_training_synthetic`.
+            - `discriminator_auc_training_synthetic`: Cross-validated AUC of a discriminative model to distinguish between training and synthetic samples.
+            - `discriminator_auc_training_holdout`: Cross-validated AUC of a discriminative model to distinguish between training and holdout samples. Serves as reference for `discriminator_auc_training_synthetic`.
+        - `distances`:  # All distance metrics are calculated within an embedding space. An equal number of training and holdout samples is considered.
+            - `ims_training`: Share of synthetic samples that are identical to a training sample.
+            - `ims_holdout`: Share of synthetic samples that are identical to a holdout sample. Serves as reference for `ims_training`.
+            - `dcr_training`: Average L2 nearest-neighbor distance between synthetic and training samples.
+            - `dcr_holdout`: Average L2 nearest-neighbor distance between synthetic and holdout samples. Serves as reference for `dcr_training`.
+            - `dcr_share`: Share of synthetic samples that are closer to a training sample than to a holdout sample. This shall not be significantly larger than 50\%.
+    """
+```
+
+## Metrics
+
+We calculate three sets of metrics to compare synthetic data with the original data.
+
+### Accuracy
+
+We calculate discretized marginal distributions for all columns, to then calculate the L1 distance between the synthetic and the original training data.
+The reported accuracy is then expressed as 100% minus the total variational distance (TVD), which is half the L1 distance between the two distributions.
+We then average across these accuracies to get a single accuracy score. The higher the score, the better the synthetic data.
+
+1. **Univariate Accuracy**: We measure the accuracy for the univariate distributions for all target columns.
+2. **Bivariate Accuracy**: We measure the accuracy for all pair-wise distributions for target columns, as well as for target columns with respect to the context columns.
+3. **Coherence Accuracy**: We measure the accuracy for the auto-correlation for all target columns. Only applicable for sequential data.
+
+An overall accuracy score is then calculated as the average of these aggregate-level scores.
+
+### Similarity
+
+We embed all records into an embedding space, to calculate two metrics:
+
+1. **Cosing Similarity**: We calculate the cosine similarity between the centroids of the synthetic and the original training data. This is then compared to the cosine similarity between the centroids of the original training and holdout data. The higher the score, the better the synthetic data.
+2. **Discriminator AUC**: We train a binary classifier to check whether one can distinguish between synthetic and original training data based on their embeddings. This is again compared to the same metric for the original training and holdout data. A score close to 50% indicates, that synthetic samples are indistinguishable from original samples.
+
+### Distances
+
+We again embed all records into an embedding space, to then measure individual-level L2 distances between samples. For each synthetic sample, we calculate the distance to the nearest original sample (DCR). We once do this with respect to original training records, and once with respect to holdout records, and then compare these DCRs to each other. For privacy-safe synthetic data we expect to see that synthetic data is just as close to original training data, as it is to original holdout data.
+
+## Sample HTML Report
+
+![Metrics](./docs/screenshots/metrics.png)
+![Accuracy Univariates](./docs/screenshots/accuracy_univariates.png)
+![Accuracy Bivariates](./docs/screenshots/accuracy_bivariates.png)
+![Accuracy Coherence](./docs/screenshots/accuracy_coherence.png)
+![Similarity](./docs/screenshots/similarity.png)
+![Distances](./docs/screenshots/distances.png)
+
+See the [examples](./examples/) directory for further examples.

mostlyai_qa-1.0.0/pyproject.toml

@@ -0,0 +1,39 @@
+[tool.poetry]
+name = "mostlyai-qa"
+version = "1.0.0"
+description = "Quality assurance for synthetic data"
+readme = "README.md"
+license = "Apache License v2"
+authors = ["MOSTLY AI <dev@mostly.ai>"]
+packages = [
+    { include = "mostlyai", from = "src" }
+]
+
+[tool.poetry.dependencies]
+python = ">=3.10"
+numpy = ">=1.26.3,<2.0.0"
+scipy = ">=1.11.0"
+pandas = ">=2.2.0"
+pyarrow = ">=16.0.0"
+plotly = ">=5.18.0"
+phik = ">=0.12.4"
+fastcluster = ">=1.2.6"
+joblib = ">=1.2.0"
+Jinja2 = ">=3.1.2"
+scikit-learn = ">=1.4.0"
+sentence-transformers = ">=3.1.0"
+
+[tool.poetry.group.dev.dependencies]
+ruff = "0.7.0"
+pytest = ">=7.1.2"
+pre-commit = ">=3.2.0"
+twine = "^5.1.1"
+
+
+[tool.ruff]
+target-version = "py310"
+line-length = 120
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

mostlyai_qa-1.0.0/src/mostlyai/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2024 MOSTLY AI
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

mostlyai_qa-1.0.0/src/mostlyai/qa/__init__.py

@@ -0,0 +1,25 @@
+# Copyright 2024 MOSTLY AI
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+
+import pandas as pd
+
+from mostlyai.qa.report import report
+from mostlyai.qa.report_from_statistics import report_from_statistics
+
+__all__ = ["report", "report_from_statistics"]
+
+os.environ["TOKENIZERS_PARALLELISM"] = "false"
+pd.set_option("future.no_silent_downcasting", True)