Practical overview
When it fits
Use Shapash after you have a model and data to explain, when visual exploration or shareable model-explanation outputs are needed.
Who it is for
- Data scientists explaining models to colleagues
- Machine-learning teams examining local and global model behavior
- Teams preparing model-explanation views or reports for review
Documented uses
- Inspect explanations for individual predictions and overall model behavior.
- Explore interactions between model features in a web app.
- Share model-explanation results with non-data specialists.
- Generate a standalone HTML report using dataset splits and selected metrics.
Requirements & limits
- The documented workflow requires an existing model and dataset; Shapash is not a model-training system.
- The project specifies Python 3.11–3.14 and pip installation.
- Report generation requires the
reportinstallation extra. - The README lists CatBoost, XGBoost, LightGBM, scikit-learn ensembles, linear models and SVM as supported model families and points to integration guidance for others.
- The repository lists an Apache-2.0 license.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Launch the Shapash web app from a compiled explainer
Display model-explanation results in the Shapash web app after creating and compiling a SmartExplainer.
Before you start
- A Python environment with Shapash installed.
- A SmartExplainer initialized with a model and compiled with a dataset.
Steps
Create a
SmartExplainerwith the model, optionally setting feature labels, preprocessing, or postprocessing.Compile it with a dataset using
xpl.compile(x=xtest); optional parameters include predictions, target values, and additional data.Launch the web app with
app = xpl.run_app().
Expected outcome
The app is launched to explore Shapash results, including local and global explainability and feature interactions.
Guide limitations
- This workflow assumes that the model and dataset are available and that the explainer has been compiled.
- The source describes launching the app but does not specify hosting, access control, or sharing configuration.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 10 October 2026
- Original website title
- MAIF/shapash · Official homepage title · retained in its source language

