Skip to main content

A packckage for performing fast EDA operations on any pandas data frames.

Project description

Contributors

Shawn Xiao Hu, Eugene You, Gilbert Akuja, Tien Nguyen

very_fast_eda

Documentation Status codecov ci-cd Project Status: Active – The project has reached a stable, usable state and is being actively developed. PyPI - Version PyPI - Python Version

The fast_eda package simplifies data exploration by providing key functions for quick insights. The describe_function() summarizes numeric columns with statistics like mean and median. The distribution_plots() visualizes both categorical and numeric columns using bar charts or histograms. The counts_nulls() identifies missing values in each column. The correlation_matrix() generates a correlation matrix between the features in the data frame. FastEDA helps users efficiently explore datasets and identify key patterns with minimal effort.

  • describe_function(): Summarizes numeric columns in a DataFrame by calculating basic statistics such as mean, median, standard deviation, and range. It provides a quick overview of central tendencies and data spread.

  • distribution_plots(): Visualizes the distribution of both categorical and numeric columns by generating bar charts for categorical data and histograms for numeric data. This function helps in understanding the frequency distribution and patterns in the dataset.

  • counts_nulls(): Counts the number of missing values in each column of the DataFrame, providing a clear overview of data completeness. This function is useful for identifying columns that may require cleaning or imputation.

  • correlation_matrix_viz(): Generate a correlation matrix visualization for numeric columns in a DataFrame.

Python Ecosystem Fit

The fast_eda package fits into the broader Python ecosystem as a lightweight tool designed to simplify the initial stages of exploratory data analysis (EDA). While there are other Python packages that offer similar functionality, such as ydata-profiling, fast_eda differentiates itself by focusing on providing quick and efficient summary statistics, visualizations, and missing data counts in a minimalistic and easy-to-use format. fast_eda aims for speed and simplicity, making it ideal for users who need a quick, lightweight solution without overwhelming complexity.

Unlike ydata-profiling and sweetviz, which generate detailed, interactive HTML reports, fast_eda is designed for rapid, inline insights within a Jupyter Notebook or Python script, making it more suitable for quick exploratory work rather than full-fledged automated reporting. Additionally, fast_eda emphasizes computational efficiency, avoiding the performance overhead associated with generating large, complex reports.

Installation

$ pip install very_fast_eda

Documentation

Our online documentation can be found here

Usage

The fast_eda package simplifies data exploration by providing key functions used to get quick insights such as distribution plots,null value counts, correlation matrix, descriptive statistics such as mean,median and standard deviations.

Once you install fast_eda using pip, you can access the following functions as shown below in the examples.

import fast_eda.fast_eda as eda 
import seaborn as sns 
import pandas as pd 


dist_plots = eda.distribution_plots(iris, 2, 3) # This will show distribution plots of the given dataset 

nulls_values = eda.count_nulls(iris) # This will show a summary of the number of null values in each rows 

correlation_matrix_plot = eda.correlation_matrix_viz(iris) # This will generate the correlation matrix for numeric columns

descriptions = eda.describe_function(iris) # This will generate summary statistics such as mean, medain and standard deviations 

Running Tests

To make sure the fast_eda package is working properly on your system, you can run the testing scripts with pytest. This will require you to have pytest installed on your system.

$ pip install pytest

You will then need to clone the repository on to your machine and navigate to the root directory. Once that is done you can execute the following command to run our testing scripts:

$ pytest

To get a view of the test coverage, you can run the following command:

$ pytest --cov=src/fast_eda

Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

fast_eda was created by Tien Nguyen, Eugene You, Gilbert Akuja, Shawn Xiao Hu. It is licensed under the terms of the MIT license.

Credits

fast_eda was created with cookiecutter and the py-pkgs-cookiecutter template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

very_fast_eda-3.0.0.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

very_fast_eda-3.0.0-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file very_fast_eda-3.0.0.tar.gz.

File metadata

  • Download URL: very_fast_eda-3.0.0.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for very_fast_eda-3.0.0.tar.gz
Algorithm Hash digest
SHA256 975aad0eadd193ab8213cc99997c9debb7594b2825f702049f83e1a081ce206c
MD5 47e7a5d0b5595fd1db70fce9782d3b4d
BLAKE2b-256 c1a91dd0b7d54b5c4e77e9d6b7784f71e50c5f02acbb4475a90ca16d68b85eaa

See more details on using hashes here.

File details

Details for the file very_fast_eda-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: very_fast_eda-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for very_fast_eda-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c5dd60320dd55cbfa62feecc8c31d2c8d68691e7fb97a1adc2a442297fc00c31
MD5 e9f423b509f341c2b778c42218994fc5
BLAKE2b-256 2e3fb27a0831a309f7fc71d4745228335e59bc1e118c9a762ffc02758f3f8d47

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page