Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

HELM — explications adaptées au profil

HELM (helm-xai) est une bibliothèque Python d’explicabilité pour la classification de textes, en particulier la modération de contenus. Elle propose des explications adaptées aux profils utilisateur, modérateur, expert technique et régulateur. Une extension expérimentale explique les prédictions de modèles entraînés sur des tableaux de variables numériques et catégorielles, notamment Random Forest, XGBoost et LightGBM, ainsi que les GLM binomiaux et GAM logistiques avec un adaptateur fourni par HELM.

Installation

Python 3.10 à 3.12. Pour installer la bibliothèque et son interface locale :

python -m pip install "helm-xai[ui]==0.2.0rc5"
helm-ui

Le navigateur ouvre http://127.0.0.1:8767/. Choisir un profil, saisir un commentaire et cliquer sur Expliquer. La wheel inclut l’interface ; Node.js n’est pas requis. Pour un autre port : helm-ui --port 8771. Arrêter le serveur avec Ctrl+C.

Le modèle de démonstration est entraîné sur 12 phrases synthétiques. Il permet d’essayer le parcours, mais ne constitue pas un détecteur de toxicité validé. L’interface utilise les poids des modèles de texte déjà présents dans le cache local ; elle ne les télécharge pas.

Utilisation Python

from helm import HELMPipeline, UserProfile
from helm.ui.models import DemoModel

pipeline = HELMPipeline(model_name="demo", model=DemoModel().load())
resultat = pipeline.explain(
    "Merci pour cette réponse utile",
    user_profile=UserProfile.END_USER,
    evaluate=True, num_features=8, evaluation_k=3,
)
print(resultat.prediction)
print(resultat.formatted_output.summary)

Le profil désigne le destinataire de l’explication ; il est choisi explicitement. HELM ne déduit pas le profil de la personne à partir de son commentaire.

Fonctionnalités

  • Sélection et présentation d’explications par profil, avec backends effectivement exécutés identifiés.
  • Attributions, règles locales et recherches de contrefactuels, selon les méthodes et dépendances disponibles.
  • Interface locale avec historique, export JSON et avis liés à chaque explication individuelle.
  • Extension TabularHELM : explications de prédictions individuelles, classement des scores élevés/faibles et sorties HTML par profil pour des données tabulaires.

Les analyses restent dans le dossier de données utilisateur helm-xai de la machine qui lance le serveur. helm-ui --data-dir ./mes-analyses permet de le changer.

Modèles tabulaires : compatibilité et périmètre

HELM explique un modèle déjà entraîné ; il ne l’entraîne pas à votre place.

Modèle Prise en charge dans cette version
Random Forest (RandomForestClassifier) Testé sur des données synthétiques, y compris avec des variables numériques et catégorielles dans une Pipeline scikit-learn.
XGBoost (XGBClassifier) et LightGBM (LGBMClassifier) Testés en classification binaire sur données synthétiques mixtes, dans une Pipeline scikit-learn.
GLM binomial (statsmodels) Testé avec BinaryProbabilityAdapter.from_glm, fourni dans HELM.
GAM logistique (pyGAM.LogisticGAM) Testé avec BinaryProbabilityAdapter.from_gam, fourni dans HELM.
Autres classifieurs compatibles scikit-learn À vérifier individuellement ; aucune compatibilité universelle n’est revendiquée.

Le modèle ou la Pipeline doit fournir predict, predict_proba et classes_, et accepter les DataFrames pandas transmis avec le même schéma et le même prétraitement qu’à l’entraînement. La classe à expliquer est choisie explicitement. Les modèles de régression, les objets XGBoost Booster bruts et les modèles Spark ML ne sont pas directement couverts par cet adaptateur.

Les tests couvrent les probabilités, les classements, SHAP/LIME et les quatre profils. Exemples et conditions précises.

Dépendances optionnelles

Extra Usage
ui Interface locale
text Modèles de texte avec PyTorch et Transformers
ig Integrated Gradients via Captum
anchors Backend Anchors natif
notebook Widgets Jupyter
boosting XGBoost et LightGBM
statistics GLM binomial statsmodels et GAM logistique pyGAM
dev Outils de test et de construction

Pour un modèle de texte et ces explicateurs : python -m pip install "helm-xai[text,ig,anchors,notebook]==0.2.0rc5". Les poids des modèles sont à obtenir séparément, selon leurs licences.

Documentation et exemples

Périmètre et licence

Version candidate de recherche. Les tests logiciels vérifient les parcours et les calculs sur des cas contrôlés ; ils ne constituent pas une validation humaine. L’extension tabulaire est expérimentale et la compatibilité Databricks reste à vérifier sur le Runtime cible. L’interface locale n’est pas un service d’étude hébergé.

Les explications décrivent le comportement du modèle, sans établir de causalité. Les scores de méthodes différentes ne sont pas moyennés. Les métriques de fidélité ne mesurent pas la satisfaction des utilisateurs.

Code sous licence MIT. Les bibliothèques et modèles tiers conservent leurs licences respectives.

Metadata

Release files for helm-xai 0.2.0rc5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for helm-xai 0.2.0rc5
File Size Uploaded Provenance Actions
helm_xai-0.2.0rc5.tar.gz 280.0 kB With provenance Details for helm_xai-0.2.0rc5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for helm-xai 0.2.0rc5
File Interpreter ABI Platform Actions
helm_xai-0.2.0rc5-py3-none-any.whl Python 3 none any Details for helm_xai-0.2.0rc5-py3-none-any.whl

Total release size: 482.3 kB

Release files / helm_xai-0.2.0rc5.tar.gz

Download URL helm_xai-0.2.0rc5.tar.gz
Size 280.0 kB
Tags Source
SHA-256 checksum
How to use checksums
347a967389186d63cb79205894bcd6e0d8aa4b549a21c401d21eedb62cf78a60
BLAKE2b-256 checksum
How to use checksums
4156898c03bc2ae52734ef21092e6b81268fb49e9e962892423cf6787f215d61
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.

Transparency log

Release files / helm_xai-0.2.0rc5-py3-none-any.whl

Download URL helm_xai-0.2.0rc5-py3-none-any.whl
Size 202.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e388fdf916c326f02cafd0abf5fbe49259eea7181af8decb2797e0108ca91603
BLAKE2b-256 checksum
How to use checksums
5a8f13dd48d2049e5fd85a612fe76dc0a189ce3789729ab21d85812112a0131d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.

Transparency log

Security for helm-xai 0.2.0rc5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for helm_xai-0.2.0rc5.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page