Skip to content

Commit

Permalink
chore: update README with example results
Browse files Browse the repository at this point in the history
  • Loading branch information
T0217 committed Sep 28, 2024
1 parent cdf7866 commit 198d029
Show file tree
Hide file tree
Showing 3 changed files with 822 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

- [Features](#features)
- [Installation](#installation)
- [Results Display](#results-display)
- [Usage](#usage)
- [Demo](#demo)
- [Data Synthesis](#data-synthesis)
Expand All @@ -13,11 +14,12 @@

## Features

SDQCPy offers a comprehensive toolkit for synthetic data generation, quality assessment, and analysis:
`SDQCPy` offers a comprehensive toolkit for synthetic data generation, quality assessment, and analysis:

1. **Data Synthesis**: Generate synthetic data using various models.
2. **Quality Evaluation**: Assess synthetic data quality through statistical tests, classification metrics, explainability analysis, and causal inference.
3. **End-to-End Analysis**: Perform holistic analysis by integrating multiple evaluation methods to provide a comprehensive view of synthetic data quality.
4. **Results Display**: Store the results in a HTML file.

## Installation
***You can install `SDQCPy` using pip:***
Expand All @@ -33,6 +35,15 @@ cd sdqcpy
pip install -e .
```

## Results Display

`SDQCPy` provides a `SequentialAnalysis` class to perform the sequential analysis and store the results in a HTML file.

[Sample Report](./Results%20Display/sample%20report.html)

![Sample Result](./Results%20Display/sample%20result.jpg)


## Usage

### Demo
Expand Down
Loading

0 comments on commit 198d029

Please sign in to comment.