Metadata-Version: 2.1
Name: DataSynthesizer
Version: 0.1.2
Summary: Generate synthetic data that simulate a given dataset.
Home-page: https://github.com/DataResponsibly/DataSynthesizer
Author: Data, Responsibly
Author-email: dataresponsibly@gmail.com
License: MIT license
Description: [![PyPi Shield](https://img.shields.io/pypi/v/DataSynthesizer.svg)](https://pypi.python.org/pypi/DataSynthesizer) [![Travis CI Shield](https://travis-ci.com/DataResponsibly/DataSynthesizer.svg?branch=master)](https://travis-ci.com/DataResponsibly/DataSynthesizer)
        
        # DataSynthesizer
        
        DataSynthesizer generates synthetic data that simulates a given dataset.
        
        > It aims to facilitate the collaborations between data scientists and owners of sensitive data. It applies Differential Privacy techniques to achieve strong privacy guarantee.
        >
        > For more details, please refer to [DataSynthesizer: Privacy-Preserving Synthetic Datasets](docs/cr-datasynthesizer-privacy.pdf)
        
        ### Install DataSynthesizer
        
        ```bash
        pip install DataSynthesizer
        ```
        
        ### Usage
        
        #### Assumptions for the Input Dataset
        
        1. The input dataset is a table in first normal form (1NF).
        2. When implementing differential privacy, DataSynthesizer injects noises into the statistics within **active domain** that are the values presented in the table.
        
        #### Use Jupyter Notebooks
        
        ```bash
        # install jupyter first
        pip install jupyter
        ```
        
        There are some demos in `./notebooks/`
        
        - [DataSynthesizer__random_mode.ipynb](notebooks/DataSynthesizer__random_mode.ipynb)
        - [DataSynthesizer__independent_attribute_mode.ipynb](notebooks/DataSynthesizer__independent_attribute_mode.ipynb)
        - [DataSyntheiszer__correlated_attribute_mode.ipynb](notebooks/DataSyntheiszer__correlated_attribute_mode.ipynb)
        
        #### Use webUI
        
        DataSynthesizer can be executed by a web-based UI.
        
        ```bash
        # install django
        pip install django
        
        # go to the directory for webUI
        cd DataSynthesizer/webUI/
        
        # run the server
        python manage.py runserver
        ```
        
        Then open a browser and visit http://127.0.0.1:8000/synthesizer/
        
        
        # History
        
        ## 0.1.0 - 2020-06-11
        
        * First release on PyPI.
        
        ## 0.1.1 - 2020-07-05
        
        ### Bugs Fixed
        
        * Numpy error when synthesising data with unique identifiers. - [Issue #23](https://github.com/DataResponsibly/DataSynthesizer/issues/23) by @raids
        
        ## 0.1.2 - 2020-07-19
        
        ### Bugs Fixed
        
        * infer_distribution() for string attributes fails to sort index of varying types. - [Issue #24](https://github.com/DataResponsibly/DataSynthesizer/issues/24) by @raids
Keywords: DataSynthesizer
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.8
Description-Content-Type: text/markdown
