Data

Tools

Indexes

Applications

Experiments

Open Source Science

xrai

https://github.com/psyres-osnabrueck-university/xrai

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (7.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: PsyRes-Osnabrueck-University
  • Language: Python
  • Default Branch: master
  • Size: 3.16 MB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 4
Created over 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme Citation

README.md

Project descriptions

XRAI (eXplanable Regression-based Artificial Intelligence) is a package for the integration of regression-based machine-learning and eXplainable AI via the SHAP-package. XRAI allows the prediction of a target variable via several ML algorithms from scikit-learn (Lasso, Elastic Net, Random Forest, Support Vector Regression, XGBoost, and a Support Vector Regression meta-learner). Algorithm selection is conducted via nested cross-validation.

Specifications can be selected regarding the internal and external folds, the selected algorithms and the use of feature selection via featureWiz. The cross-validation scheme can be safed for reproductibility. SHAP allows the estimation of feature importance both for individual predictions, as well as across the whole dataset.

Usage

This package requires a dataset that contains ....

```python from xrai import Transform from xrai import Preparation

file_path = "path/to/your/excel/file.xlsx"

preparation = Preparation(basepath=os.getcwd(), filename="distortionsfinal.xlsx", outcome=None, outcomelist=[], classedsplits=False, outcometofeatures=[], testsets=10, valsets=5) transformer = Transform(dataPrepared=preparation) transformer.genplots() ```

This produces plots as follows:

SHAP summary plot

SHAP summary plot

SHAP waterfall plot

SHAP Heatmap plot

Owner

  • Name: PsyRes-Osnabrueck-University
  • Login: PsyRes-Osnabrueck-University
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Lalk
    given-names: Christopher
    orcid: https://orcid.org/0000-0002-1793-3507
  - family-names: Mathew
    given-names: Roshan
title: "XRAI - eXplanable Regression-based Artificial Intelligence"
version: 0.1.1
date-released: 2024-12-15

GitHub Events

Total
  • Release event: 4
  • Delete event: 1
  • Member event: 1
  • Push event: 48
  • Pull request event: 3
  • Create event: 15
Last Year
  • Release event: 4
  • Delete event: 1
  • Member event: 1
  • Push event: 48
  • Pull request event: 3
  • Create event: 15

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • rmathew-uni (2)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/docs-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
build/lib/setup.py pypi
  • featurewiz *
  • gpboost *
  • matplotlib *
  • merf *
  • numpy *
  • openpyxl *
  • pandas *
  • scikit-learn *
  • scipy *
  • shap *
  • statistics *
  • xgboost *
  • xlsxwriter *
pyproject.toml pypi
  • XlsxWriter ==3.2.0
  • featurewiz @ git+https://github.com/AutoViML/featurewiz.git@2fab4170382b698114935f7b0842f36ebcaa51c0
  • gpboost ==1.5.3
  • matplotlib ==3.9.2
  • merf ==1.0
  • numpy ==2.0.2
  • openpyxl ==3.1.5
  • pandas ==2.2.3
  • scikit-learn ==1.5.2
  • scipy ==1.14.1
  • shap ==0.46.0
  • statistics ==1.0.3.5
  • xgboost ==1.7.6
requirements.txt pypi
  • Cython ==0.29.36
  • HanTa ==1.1.1
  • Jinja2 ==3.1.2
  • Markdown ==3.4.3
  • MarkupSafe ==2.1.2
  • Pillow ==9.4.0
  • Pygments ==2.14.0
  • QtPy ==2.3.1
  • Send2Trash ==1.8.2
  • Werkzeug ==2.3.4
  • XlsxWriter ==3.1.2
  • absl-py ==1.4.0
  • anyio ==3.7.0
  • argon2-cffi ==21.3.0
  • argon2-cffi-bindings ==21.2.0
  • arrow ==1.2.3
  • asttokens ==2.2.1
  • astunparse ==1.6.3
  • attrs ==23.1.0
  • backcall ==0.2.0
  • beautifulsoup4 ==4.12.2
  • bertopic ==0.15.0
  • bleach ==6.0.0
  • cachetools ==5.3.0
  • category-encoders ==2.6.1
  • certifi ==2023.5.7
  • cffi ==1.15.1
  • charset-normalizer ==3.1.0
  • click ==8.1.3
  • cloudpickle ==2.2.1
  • colorama ==0.4.6
  • comm ==0.1.3
  • contourpy ==1.0.7
  • cycler ==0.11.0
  • dask ==2023.6.1
  • debugpy ==1.6.7
  • decorator ==5.1.1
  • defusedxml ==0.7.1
  • distributed ==2023.6.1
  • docutils ==0.19
  • et-xmlfile ==1.1.0
  • exceptiongroup ==1.1.2
  • executing ==1.2.0
  • fastjsonschema ==2.17.1
  • feather-format ==0.4.1
  • filelock ==3.12.0
  • flatbuffers ==23.5.9
  • fonttools ==4.39.2
  • fqdn ==1.5.1
  • fsspec ==2023.5.0
  • gast ==0.4.0
  • google-auth ==2.18.1
  • google-auth-oauthlib ==1.0.0
  • google-pasta ==0.2.0
  • gpboost ==1.2.3
  • grpcio ==1.54.2
  • h5py ==3.8.0
  • hdbscan ==0.8.33
  • huggingface-hub ==0.14.1
  • idna ==3.4
  • imbalanced-learn ==0.10.1
  • importlib-metadata ==6.6.0
  • importlib-resources ==5.12.0
  • ipykernel ==6.24.0
  • ipython ==8.11.0
  • ipython-genutils ==0.2.0
  • ipywidgets ==8.0.7
  • isoduration ==20.11.0
  • jax ==0.4.10
  • jedi ==0.18.2
  • joblib ==1.2.0
  • jsonpointer ==2.4
  • jsonschema ==4.17.3
  • jupyter ==1.0.0
  • jupyter-console ==6.6.3
  • jupyter-events ==0.6.3
  • jupyter_client ==8.3.0
  • jupyter_core ==5.3.1
  • jupyter_server ==2.7.0
  • jupyter_server_terminals ==0.4.4
  • jupyterlab-pygments ==0.2.2
  • jupyterlab-widgets ==3.0.8
  • keras ==2.12.0
  • kiwisolver ==1.4.4
  • libclang ==16.0.0
  • lightgbm ==3.3.5
  • littleutils ==0.2.2
  • locket ==1.0.0
  • lxml ==4.9.3
  • matplotlib ==3.7.1
  • matplotlib-inline ==0.1.6
  • merf ==1.0
  • mistune ==3.0.1
  • mpmath ==1.3.0
  • msgpack ==1.0.5
  • nbclassic ==1.0.0
  • nbclient ==0.8.0
  • nbconvert ==7.6.0
  • nbformat ==5.9.0
  • nest-asyncio ==1.5.6
  • networkx ==3.1
  • nltk ==3.8.1
  • notebook ==6.5.4
  • notebook_shim ==0.2.3
  • oauthlib ==3.2.2
  • openpyxl ==3.1.2
  • opt-einsum ==3.3.0
  • outdated ==0.2.2
  • overrides ==7.3.1
  • packaging ==23.0
  • pandas ==1.5.3
  • pandas-flavor ==0.6.0
  • pandocfilters ==1.5.0
  • parso ==0.8.3
  • partd ==1.4.0
  • patsy ==0.5.3
  • pickleshare ==0.7.5
  • pingouin ==0.5.3
  • platformdirs ==3.8.0
  • plotly ==5.18.0
  • prometheus-client ==0.17.0
  • prompt-toolkit ==3.0.38
  • protobuf ==4.23.1
  • psutil ==5.9.5
  • pure-eval ==0.2.2
  • pyasn1 ==0.5.0
  • pyasn1-modules ==0.3.0
  • pycparser ==2.21
  • pynndescent ==0.5.10
  • pyparsing ==3.0.9
  • pyrsistent ==0.19.3
  • python-dateutil ==2.8.2
  • python-docx ==0.8.11
  • python-json-logger ==2.0.7
  • pytz ==2023.2
  • pywinpty ==2.0.10
  • pyzmq ==25.1.0
  • qtconsole ==5.4.3
  • regex ==2023.5.5
  • requests ==2.30.0
  • requests-oauthlib ==1.3.1
  • rfc3339-validator ==0.1.4
  • rfc3986-validator ==0.1.1
  • rsa ==4.9
  • scikit-learn ==1.2.2
  • scipy ==1.10.1
  • seaborn ==0.12.2
  • sentence-transformers ==2.2.2
  • sentencepiece ==0.1.99
  • shap ==0.42.1
  • six ==1.16.0
  • sklearn ==0.0.post1
  • slicer ==0.0.7
  • sniffio ==1.3.0
  • sortedcontainers ==2.4.0
  • soupsieve ==2.4.1
  • stack-data ==0.6.2
  • statistics ==1.0.3.5
  • statsmodels ==0.14.0
  • sympy ==1.12
  • tabulate ==0.9.0
  • tblib ==2.0.0
  • tenacity ==8.2.3
  • tensorboard ==2.12.3
  • tensorboard-data-server ==0.7.0
  • tensorflow ==2.12.0
  • tensorflow-estimator ==2.12.0
  • tensorflow-intel ==2.12.0
  • tensorflow-io-gcs-filesystem ==0.31.0
  • termcolor ==2.3.0
  • terminado ==0.17.1
  • threadpoolctl ==3.1.0
  • tinycss2 ==1.2.1
  • tokenizers ==0.13.3
  • toolz ==0.12.0
  • torch ==2.0.1
  • torchvision ==0.15.2
  • tornado ==6.3.2
  • tqdm ==4.65.0
  • traitlets ==5.9.0
  • transformers ==4.29.2
  • typing_extensions ==4.5.0
  • umap-learn ==0.5.5
  • uri-template ==1.3.0
  • urllib3 ==1.26.15
  • wcwidth ==0.2.6
  • webcolors ==1.13
  • webencodings ==0.5.1
  • websocket-client ==1.6.1
  • widgetsnbextension ==4.0.8
  • wrapt ==1.14.1
  • xarray ==2023.10.1
  • xformers ==0.0.22.post7
  • xgboost ==1.7.4
  • xlrd ==2.0.1
  • zict ==3.0.0
  • zipp ==3.15.0
src/setup.py pypi
  • featurewiz *
  • gpboost *
  • matplotlib *
  • merf *
  • numpy *
  • openpyxl *
  • pandas *
  • scikit-learn *
  • scipy *
  • shap *
  • statistics *
  • xgboost *
  • xlsxwriter *
src/xrai.egg-info/requires.txt pypi
  • featurewiz *
  • gpboost *
  • matplotlib *
  • merf *
  • numpy *
  • openpyxl *
  • pandas *
  • scikit-learn *
  • scipy *
  • shap *
  • statistics *
  • xgboost *
  • xlsxwriter *
test-requirements.txt pypi
.github/workflows/python-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pypa/gh-action-pypi-publish release/v1 --verbose composite