|
1 |
| -<p align="center"> |
2 |
| - <img height="250px" src="docs/source/_static/logo_shapiq_light.svg" alt="shapiq_logo"> |
3 |
| -</p> |
| 1 | + |
| 2 | +--- |
| 3 | +**NOTE:** |
| 4 | + |
| 5 | +`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. |
| 6 | + |
| 7 | +--- |
4 | 8 |
|
5 | 9 | <p align="center">
|
6 |
| - <!-- Coverage Test --> |
7 |
| - <a href='https://coveralls.io/github/mmschlk/shapiq?branch=main'> |
8 |
| - <img src='https://coveralls.io/repos/github/mmschlk/shapiq/badge.svg?branch=main' alt='Coverage Status' /> |
9 |
| - </a> |
10 |
| - |
11 |
| - <!-- Tests --> |
12 |
| - <a href="https://github.com/mmschlk/shapiq/actions/workflows/unit-tests.yml"> |
13 |
| - <img src="https://github.com/mmschlk/shapiq/actions/workflows/unit-tests.yml/badge.svg" alt="unit-tests"> |
14 |
| - </a> |
15 |
| - |
16 |
| - <!-- Read the Docs --> |
17 |
| - <a href='https://shapiq.readthedocs.io/en/latest/?badge=latest'> |
18 |
| - <img src='https://readthedocs.org/projects/shapiq/badge/?version=latest' alt='Documentation Status' /> |
19 |
| - </a> |
20 |
| - |
21 |
| - <!-- PyPI Version --> |
22 |
| - <a href="https://pypi.org/project/shapiq"> |
23 |
| - <img src="https://img.shields.io/pypi/v/shapiq.svg?color=blue" alt="PyPi"> |
24 |
| - </a> |
25 |
| - |
26 |
| - <!-- PyPI status --> |
27 |
| - <a href="https://pypi.org/project/shapiq"> |
28 |
| - <img src="https://img.shields.io/pypi/status/shapiq.svg?color=blue" alt="PyPi_status |
29 |
| - </a> |
30 |
| - |
31 |
| - <!-- PePy --> |
32 |
| - <a href="https://pepy.tech/project/shapiq"> |
33 |
| - <img src="https://static.pepy.tech/badge/shapiq?style=flat-square" alt="pepy"> |
34 |
| - </a> |
35 |
| - |
36 |
| - <!-- License --> |
37 |
| - <a href="https://opensource.org/licenses/MIT"> |
38 |
| - <img src="https://img.shields.io/badge/License-MIT-brightgreen.svg" alt="mit_license"> |
39 |
| - </a> |
40 |
| - |
41 |
| - <!-- Codestyle --> |
42 |
| - <a href="https://github.com/psf/black"> |
43 |
| - <img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="black_codestyle"> |
44 |
| - </a> |
| 10 | + <img height="250px" src="docs/source/_static/logo_shapiq_light.svg" alt="shapiq_logo"/> |
45 | 11 | </p>
|
46 | 12 |
|
| 13 | +[](https://opensource.org/licenses/MIT) |
| 14 | +[](https://coveralls.io/github/mmschlk/shapiq?branch=main) |
| 15 | +[](https://github.com/mmschlk/shapiq/actions/workflows/unit-tests.yml) |
| 16 | +[](https://shapiq.readthedocs.io/en/latest/?badge=latest) |
| 17 | + |
| 18 | +[](https://pypi.org/project/shapiq) |
| 19 | +[](https://pypi.org/project/shapiq) |
| 20 | +[](https://pepy.tech/project/shapiq) |
| 21 | +[](https://github.com/psf/black) |
47 | 22 |
|
48 | 23 | # SHAP-IQ: SHAP Interaction Quantification
|
49 | 24 | > An interaction may speak more than a thousand main effects.
|
|
0 commit comments