Add "shap" and "xarray" packages as optional dependencies (#107)

---------

authored-by: Ashish Patel <[email protected]>

Author: ashishpatel16

.github/workflows/deploy-pypi.yml

@@ -43,12 +43,14 @@ jobs:
   bump:
     needs: test
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: '0'
     - name: Bump version and push tag
-      uses: anothrNick/github-tag-action@1.36.0
+      uses: anothrNick/github-tag-action@1.64.0
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         WITH_V: true

Pipfile

@@ -19,3 +19,5 @@ sphinx-rtd-theme = "0.5.2"
 
 [extras]
 ray = "*"
+shap = "*"
+xarray = "*"

README.md

@@ -106,6 +106,15 @@ HiClass and its dependencies can be easily installed with pip:
 pip install hiclass
 ```
 
+If you need additional functionality, you can install extra dependencies using the following syntax:
+```shell
+pip install hiclass"[<extra_name>]"
+```
+Replace <extra_name> with one of the following options:
+
+- ray: Installs the ray package, which is required for parallel processing support.
+- xai: Installs the shap and xarray packages, which are required for explaining Hiclass predictions.
+
 ### Option 2: Conda
 
 Alternatively, HiClass and its dependencies can also be installed with conda:

setup.py

@@ -31,7 +31,7 @@
 
 # What packages are optional?
 # 'fancy feature': ['django'],}
-EXTRAS = {"ray": ["ray>=1.11.0"]}
+EXTRAS = {"ray": ["ray>=1.11.0"], "xai": ["shap", "xarray"]}
 
 # The rest you shouldn't have to touch too much :)
 # ------------------------------------------------