Fixed paths (#5)

Author: stavrostheocharis

README.md

@@ -2,7 +2,7 @@
 
 # Easy Explain
 
-[![Python Version](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10-green.svg)](#supported-python-versions) 
+[![Python Version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-green.svg)](#supported-python-versions) 
 [![GitHub][github_badge]][github_link]
 [![PyPI][pypi_badge]][pypi_link]
 [![Download][download_badge]][download_link]
@@ -22,8 +22,8 @@ Unlock the "why" behind your AI models' decisions with `easy-explain`, a Python
 ## Requirements
 
 ### Python Versions Supported
-- **Primary**: `3.10`
-- **Also Supported**: `3.8`, `3.9`
+- **Primary**: `3.11`
+- **Also Supported**: `3.9`, `3.10`
 
 Ensure one of these Python versions is installed on your system to use `easy-explain`.
 
@@ -58,13 +58,29 @@ Currently, `easy-explain` specializes in two cutting-edge XAI methodologies for
 To begin unraveling the intricacies of your model's decisions, import and utilize the corresponding classes as follows:
 
 ```python
-from easy_explain.methods.occlusion.occlusion import OcclusionExplain 
+from easy_explain import OcclusionExplain
+
+model = 'your-model'
+
+occlusion_explain = OcclusionExplain(model=model)
+vis_types=[["blended_heat_map", "original_image"]]
+vis_signs = [["positive","all"]]
+
+occlusion_explain.generate_explanation(image_url="your-image",total_preds=5,vis_types = vis_types, vis_signs = vis_signs, labels_path="your-labels-path")
 
 ```
 
 ```python
-from easy_explain.methods.lrp.yolov8.yolo import YOLOv8LRP
+from easy_explain import YOLOv8LRP
+
+model = 'your-model'
+image = 'your-image'
+
+lrp = YOLOv8LRP(model, power=2, eps=1, device='cpu')
+
+explanation_lrp = lrp.explain(image, cls='your-class', contrastive=False).cpu()
 
+lrp.plot_explanation(frame=image, explanation = explanation_lrp, contrastive=True, cmap='seismic', title='Explanation for your class"')
 ```
 
 For more information about how to begin have a look at the [examples notebooks](https://github.com/stavrostheocharis/easy_explain/tree/main/examples).

easy_explain/__init__.py

@@ -1,2 +1,3 @@
-# from easy_explain.easy_explain import run_easy_explain
-from easy_explain import methods
+from .methods import YOLOv8LRP, OcclusionExplain
+
+__all__ = ["YOLOv8LRP", "OcclusionExplain"]

easy_explain/methods/__init__.py

@@ -0,0 +1,4 @@
+from .lrp.yolov8 import YOLOv8LRP
+from .occlusion import OcclusionExplain
+
+__all__ = ["YOLOv8LRP", "OcclusionExplain"]

easy_explain/methods/lrp/yolov8/__init__.py

@@ -0,0 +1,3 @@
+from .yolo import YOLOv8LRP
+
+__all__ = ["YOLOv8LRP"]

easy_explain/methods/occlusion/__init__.py

@@ -0,0 +1,3 @@
+from .occlusion import OcclusionExplain
+
+__all__ = ["OcclusionExplain"]

examples/lrp/easy_explain_lrp_for_Yolov8_use_as_package_pipeline.ipynb

@@ -45,7 +45,7 @@
     "if module_path not in sys.path:\n",
     "    sys.path.append(module_path)\n",
     "\n",
-    "from easy_explain.methods.lrp.yolov8.yolo import YOLOv8LRP"
+    "from easy_explain import YOLOv8LRP"
    ]
   },
   {
@@ -58,7 +58,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 4,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -74,7 +74,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -91,7 +91,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 6,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -119,7 +119,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 7,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -136,7 +136,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 8,
    "metadata": {},
    "outputs": [
     {

examples/occlusion/easy_explain_occlusion_use_as_package_for_multiple_targets.ipynb

@@ -28,7 +28,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -41,7 +41,7 @@
     "if module_path not in sys.path:\n",
     "    sys.path.append(module_path)\n",
     "\n",
-    "from easy_explain.methods.occlusion.occlusion import OcclusionExplain"
+    "from easy_explain import OcclusionExplain\n"
    ]
   },
   {

examples/occlusion/easy_explain_occlusion_use_as_package_pipeline.ipynb

@@ -41,7 +41,7 @@
     "if module_path not in sys.path:\n",
     "    sys.path.append(module_path)\n",
     "\n",
-    "from easy_explain.methods.occlusion.occlusion import OcclusionExplain"
+    "from easy_explain import OcclusionExplain"
    ]
   },
   {
@@ -58,7 +58,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "model = torchvision.models.resnet50(pretrained=True).eval()\n"
+    "model = torchvision.models.resnet50(pretrained=True).eval()"
    ]
   },
   {

setup.py

@@ -5,15 +5,15 @@
 setup(
     name="easy_explain",
     packages=["easy_explain"],
-    version="0.4.0",
+    version="0.4.1",
     license="MIT",
     description="A library that helps to explain AI models in a really quick & easy way",
     long_description=long_description,
     long_description_content_type="text/markdown",
     author="Stavros Theocharis",
     author_email="stavrostheocharis@yahoo.gr",
     url="https://github.com/stavrostheocharis/stavrostheocharis",
-    download_url="https://github.com/stavrostheocharis/easy_explain/archive/refs/tags/v0.4.0.tar.gz",
+    download_url="https://github.com/stavrostheocharis/easy_explain/archive/refs/tags/v0.4.1.tar.gz",
     keywords=[
         "explainable ai",
         "xai",
@@ -38,5 +38,6 @@
         "License :: OSI Approved :: MIT License",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
     ],
 )