Skip to content

Commit a86e04e

Browse files
Changes: (#9)
* Adjusted README badges * Adjusted setup release options
1 parent 4a6864f commit a86e04e

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22

33
# Easy Explain
44

5-
[![Python Version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-green.svg)](#supported-python-versions)
5+
66
[![GitHub][github_badge]][github_link]
77
[![PyPI][pypi_badge]][pypi_link]
8+
[![Test][test_passing_badge]][test_passing_badge]
9+
[![Licence][licence_badge]][licence_link]
810
[![Download][download_badge]][download_link]
911
[![Download][total_download_badge]][download_link]
10-
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
11-
[![Licence][licence_badge]][licence_link]
12+
[![Python Version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-green.svg)](#supported-python-versions)
13+
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
1214

1315
**Simplify the Explanation of AI Models**
1416

@@ -17,7 +19,7 @@
1719
Unlock the "why" behind your AI models' decisions with `easy-explain`, a Python package designed to democratize access to advanced XAI algorithms. By integrating state-of-the-art explanation techniques with minimal code, we make AI transparency accessible to developers and researchers alike.
1820

1921
> [!IMPORTANT]
20-
> The new version of `easy-explain` has breaking changes. We have changed the logic of different imports to support more models like YoloV8. Have a look at the provided [examples](https://github.com/stavrostheocharis/easy_explain/tree/main/examples).
22+
> The new versions of `easy-explain` after 0.4.3 have breaking changes. We have changed the logic of different imports to support more models like YoloV8. Have a look at the provided [examples](https://github.com/stavrostheocharis/easy_explain/tree/main/examples).
2123
2224

2325
## Requirements
@@ -46,10 +48,10 @@ pip install easy-explain
4648
## Features and Functionality
4749

4850
`easy-explain` uses under the hood different packages based on the model to be used. [Captum](https://captum.ai/) is used for classification models and it aids to comprehend how the data properties impact the model predictions or neuron activations, offering insights on how the model performs. Captum comes together with [Pytorch library](https://pytorch.org/).
49-
There are also other customade algorithms to support other models like the LRP implementation for YoloV8.
51+
There are also other algorithms supported like GradCam or customade algorithms to support other models like the LRP implementation for YoloV8.
5052

5153

52-
Currently, `easy-explain` specializes in two cutting-edge XAI methodologies for images:
54+
Currently, `easy-explain` specializes in specific cutting-edge XAI methodologies for images:
5355

5456
- Occlusion: For deep insight into classification model decisions.
5557
- Cam: SmoothGradCAMpp & LayerCAM for explainability on image classification models.
@@ -141,10 +143,12 @@ Join us in making AI models more interpretable, transparent, and trustworthy wit
141143

142144
[download_badge]: https://static.pepy.tech/personalized-badge/easy-explain?period=month&units=international_system&left_color=grey&right_color=green&left_text=Monthly%20Downloads
143145

146+
[test_passing_badge]: https://github.com/stavrostheocharis/easy_explain/actions/workflows/python-app.yml/badge.svg
147+
144148
[total_download_badge]: https://static.pepy.tech/personalized-badge/easy-explain?period=total&units=international_system&left_color=grey&right_color=green&left_text=Total%20Downloads
145149

146150
[download_link]: https://pypi.org/project/easy-explain/#files
147151

148152
[licence_badge]: https://img.shields.io/github/license/stavrostheocharis/easy_explain
149153

150-
[licence_link]: LICENSE
154+
[licence_link]: LICENSE

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
setup(
88
name="easy_explain",
99
packages=find_packages(),
10-
version="0.4.3",
10+
version="0.5.0",
1111
license="MIT",
1212
description="A library that helps to explain AI models in a really quick & easy way",
1313
long_description=long_description,
1414
long_description_content_type="text/markdown",
1515
author="Stavros Theocharis",
1616
author_email="stavrostheocharis@yahoo.gr",
1717
url="https://github.com/stavrostheocharis/stavrostheocharis",
18-
download_url="https://github.com/stavrostheocharis/easy_explain/archive/refs/tags/v0.4.3.tar.gz",
18+
download_url="https://github.com/stavrostheocharis/easy_explain/archive/refs/tags/v0.5.0.tar.gz",
1919
keywords=[
2020
"explainable ai",
2121
"xai",

0 commit comments

Comments
 (0)