Beschreibung

HOI (Higher Order Interactions) ist ein Python-Paket, das über paarweise Interaktionen hinausgeht, indem es die statistischen Abhängigkeiten zwischen zwei oder mehr Einheiten mithilfe informationstheoretischer Metriken quantifiziert. Das Paket basiert auf Jax und ermöglicht Berechnungen auf CPU oder GPU.

Installation

Abhängigkeiten

HOI erfordert:

Python (>= 3.8)
numpy(>=1,22)
scipy (>=1,9)
jax
Pandas
scikit-lernen
jax-tqdm
tqdm

Benutzerinstallation

Um Jax nur auf der GPU oder CPU zu installieren, lesen Sie bitte die Dokumentation von Jax: https://jax.readthedocs.io/en/latest/installation.html

Wenn Sie bereits über eine funktionierende Installation von NumPy, SciPy und Jax verfügen, können Sie HOI am einfachsten mit pip installieren:

pip install -U hoi

Sie können die neueste Version der Software auch direkt von Github installieren:

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

Für Entwickler

Für Entwickler können Sie es im Entwicklungsmodus mit den folgenden Befehlen installieren:

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

Die vollständige Installation von HOI umfasst zusätzliche Pakete zum Testen der Software und zum Erstellen der Dokumentation:

pytest
pytest-cov
Codecov
xarray
Sphinx!=4.1.0
Sphinx-Galerie
pydata-sphinx-theme
sphinxcontrib-bibtex
numpydoc
matplotlib
Flocke8
pep8-benennung
Schwarz

Hilfe und Support

Dokumentation

Link zur Dokumentation: https://brainets.github.io/hoi/
Überblick über den mathematischen Hintergrund: https://brainets.github.io/hoi/theory.html
Liste der implementierten HOI-Metriken: https://brainets.github.io/hoi/api/modules.html
Beispiele: https://brainets.github.io/hoi/auto_examples/index.html