openclean 0.2.0

Library for data cleaning and data profiling

About

openclean is a Python library for data profiling and data cleaning. The project is motivated by the fact that data preparation is still a major bottleneck for many data science projects. Data preparation requires profiling to gain an understanding of data quality issues, and data manipulation to transform the data into a form that is fit for the intended purpose.

While a large number of different tools and techniques have previously been developed for profiling and cleaning data, one main issue that we see with these tools is the lack of access to them in a single (unified) framework. Existing tools may be implemented in different programming languages and require significant effort to install and interface with. In other cases, promising data cleaning methods have been published in the scientific literature but there is no suitable codebase available for them. We believe that the lack of seamless access to existing work is a major contributor to why data preparation is so time consuming.

The goal of openclean is to bring together data cleaning tools in a single environment that is easy and intuitive to use for a data scientist. openclean allows users to compose and execute cleaning pipelines that are built using a variety of different tools. We aim for openclean to be flexible and extensible to allow easy integration of new functionality. To this end, we define a set of primitives and API’s for the different types of operators (actors) in openclean pipelines.

Features

openclean has many features that make the data wrangling experience straightforward. It shines particularly in these areas:

Data Profiling

openclean comes with a profiler to provide users actionable metrics about their data’s quality. It allows users to detect possible problems early on by providing various statistical measures of the data from min-max frequencies, to uniqueness and entropy calculations. The interface is easy to implement and can be extended by python savvy users to cater their needs.

Data Cleaning & Wrangling

openclean’s operators have been created specifically to handle data janitorial tasks. They help identify and present statistical anomalies, fix functional dependency violations, locate and update spelling mistakes, and handle missing values gracefully. As openclean is growing fast, so is this list of operators!

Data Enrichment

openclean seamlessly integrates with Socrata and Reference Data Repository to provide it’s users master datasets which can be incorporated in the data cleaning process.

Data Provenance

openclean comes with a mini-version control engine that allows users to maintain versions of their datasets and at any point commit, checkout or rollback changes. Not only this, users can register custom functions inside the openclean engine and apply them effortlessly across different datasets/notebooks.

Installation

Install openclean from PyPI using pip with:

pip install openclean

You can also install the different openclean extensions openclean-geo, openclean-metanome, openclean-notebook, and openclean-pattern, or install openclean with all the extensions:

pip install openclean[full]

Note: See the Demo section below for instructions to run the example notebooks in this repository.

Usage

We include several example notebooks in this repository that demonstrate possible use cases for openclean. We recommend starting with the documentation or the New York City Restaurant Inspection Results notebook. In that example our goal is to reproduce a previous study from 2014 that looks at the distribution of restaurant inspection grades in New York City. For our study, we use data that was downloaded in Sept. 2019. The example is split into two different Jupyter notebooks:

• Data Profiling

• Data Cleaning

Other examples along with the datasets are located in the examples’ folder

Demo

Use the following steps to setup and run the example notebooks in this repository. We recommend using a virtual environment. Below are two examples for setting up a virtual environment

# -- Create a new virtual environment
virtualenv venv
# -- Activate the virtual environment
source venv/bin/activate

If you are using the Python distribution from Anaconda, you can setup an environment like this:

# -- Create a new virtual environment
conda create -n openclean pip
# -- Activate the virtual environment
conda activate openclean

After activating your virtual environment, follow these steps to setup and run the notebook examples :

# Clone the openclean repository into your current working directory.
git clone [e-mail]:VIDA-NYU/openclean.git
# Change working directory to the cloned repository.
cd openclean
# Install openclean and dependencies required for the demo
pip install .[demo]
# Run Jupyter (the navigate to the notebooks in folder `examples/notebooks`)
jupyter notebook

Demo Video

Want to see openclean in action? Check out our video demo: https://youtu.be/HNmNB6YMgHk

Documentation

The official documentation is hosted on readthedocs: http://openclean.readthedocs.io/

You can also read more about openclean in this blog post (on GitHub and Towards Data Science).

Contributing

We welcome all contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas.

A detailed overview on how to contribute can be found here.