diff --git a/README.md b/README.md index 98b95ada..9e7a1df2 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,24 @@ -

- shapiq_logo -

+ +--- +**NOTE:** + +`shapiq` is still in an alpha stage and under active development. The [initial release](https://github.com/mmschlk/shapiq/milestone/1) is scheduled to be May 31st. + +---

- - - Coverage Status - - - - - unit-tests - - - - - Documentation Status - - - - - PyPi - - - - - PyPi_status
-  </a>
-      
-  <!-- PePy -->
-  <a href= - pepy - - - - - mit_license - - - - - black_codestyle - + shapiq_logo

+[![License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT) +[![Coverage Status](https://coveralls.io/repos/github/mmschlk/shapiq/badge.svg?branch=main)](https://coveralls.io/github/mmschlk/shapiq?branch=main) +[![Tests](https://github.com/mmschlk/shapiq/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/mmschlk/shapiq/actions/workflows/unit-tests.yml) +[![Read the Docs](https://readthedocs.org/projects/shapiq/badge/?version=latest)](https://shapiq.readthedocs.io/en/latest/?badge=latest) + +[![PyPI Version](https://img.shields.io/pypi/pyversions/shapiq.svg)](https://pypi.org/project/shapiq) +[![PyPI status](https://img.shields.io/pypi/status/shapiq.svg?color=blue)](https://pypi.org/project/shapiq) +[![PePy](https://static.pepy.tech/badge/shapiq?style=flat-square)](https://pepy.tech/project/shapiq) +[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) # SHAP-IQ: SHAP Interaction Quantification > An interaction may speak more than a thousand main effects.