hoi

説明

HOI (高次相互作用) は、情報理論的メトリクスを使用して 2 つ以上のユニット間の統計的依存関係を定量化することで、ペアごとの相互作用を超える Python パッケージです。このパッケージは Jax 上に構築されており、CPU または GPU での計算が可能です。

インストール

依存関係

HOI には次のものが必要です。

• Python (>= 3.8)
• numpy(>=1.22)
• scipy (>=1.9)
• ジャックス
• パンダ
• scikit-learn
• jax-tqdm
• tqdm

ユーザーによるインストール

Jax を GPU または CPU のみにインストールするには、Jax のドキュメントを参照してください: https://jax.readthedocs.io/en/latest/installation.html

NumPy、SciPy、Jax がすでに動作するようにインストールされている場合、hoi をインストールする最も簡単な方法はpip使用することです。

pip install -U hoi

ソフトウェアの最新バージョンを Github から直接インストールすることもできます。

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

開発者向け

開発者の場合は、次のコマンドを使用して開発モードでインストールできます。

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

HOI の完全インストールには、ソフトウェアをテストし、ドキュメントを構築するための追加パッケージが含まれています。

• pytest
• pytest-cov
• コードコブ
• Xアレイ
• スフィンクス!=4.1.0
• スフィンクスギャラリー
• pydata-スフィンクスのテーマ
• sphinxcontrib-bibtex
• numpydoc
• マットプロットライブラリ
• フレーク8
• pep8-命名
• 黒

ヘルプとサポート

ドキュメント

• ドキュメントへのリンク: https://brainets.github.io/hoi/
• 数学的背景の概要 : https://brainets.github.io/hoi/ Theory.html
• 実装された HOI メトリクスのリスト: https://brainets.github.io/hoi/api/modules.html
• 例: https://brainets.github.io/hoi/auto_examples/index.html

コミュニケーション

質問がある場合は、次のリンクを使用してください: https://github.com/brainets/hoi/Discussions

謝辞

HOI は主に Google Summer of Code 2023 中に開発されました (https://Summerofcode.withgoogle.com/archive/2023/projects/z6hGpvLS)