Description

HOI (Higher Order Interactions) est un package Python permettant d'aller au-delà des interactions par paires en quantifiant les dépendances statistiques entre 2 unités ou plus à l'aide de métriques théoriques de l'information. Le package est construit sur Jax permettant des calculs sur CPU ou GPU.

Installation

Dépendances

HOI nécessite :

Python (>= 3,8)
numpy(>=1,22)
scipy (>=1,9)
jax
pandas
scikit-apprendre
jax-tqdm
tqdm

Installation utilisateur

Pour installer Jax sur GPU ou CPU uniquement, veuillez vous référer à la documentation de Jax : https://jax.readthedocs.io/en/latest/installation.html

Si vous disposez déjà d'une installation fonctionnelle de NumPy, SciPy et Jax, le moyen le plus simple d'installer hoi consiste à utiliser pip :

pip install -U hoi

Vous pouvez également installer la dernière version du logiciel directement depuis Github :

pip install git+https://github.com/brainets/hoi.git

Pour les développeurs

Pour les développeurs, vous pouvez l'installer en mode développement avec les commandes suivantes :

git clone https://github.com/brainets/hoi.git
cd hoi
pip install -e .[ ' full ' ]

L'installation complète de HOI comprend des packages supplémentaires pour tester le logiciel et construire la documentation :

test py
pytest-cov
codecov
tableau x
sphinx!=4.1.0
galerie-sphinx
thème-pydata-sphinx
sphinxcontrib-bibtex
numpydoc
matplotlib
flocon8
nom pep8
noir

Aide et support

Documentation

Lien vers la documentation : https://brainets.github.io/hoi/
Aperçu du bagage mathématique : https://brainets.github.io/hoi/theory.html
Liste des métriques HOI implémentées : https://brainets.github.io/hoi/api/modules.html
Exemples : https://brainets.github.io/hoi/auto_examples/index.html