Higher Order Interactions

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for EtienneCmb from gravatar.com EtienneCmb

Unverified details

These details have not been verified by PyPI
Meta
  • License: BSD 3-Clause License
  • Author: BraiNets
  • Maintainer: Etienne Combrisson
  • Tags information-theory , statistics , higher-order-interactions
  • Provides-Extra: test , doc , lint , full
Classifiers
Report project as malware

Project description

Black Codecov JOSS

https://github.com/brainets/hoi/blob/main/docs/_static/hoi-logo.png

Description

HOI (Higher Order Interactions) is a Python package to go beyond pairwise interactions by quantifying the statistical dependencies between 2 or more units using information-theoretical metrics. The package is built on top of Jax allowing computations on CPU or GPU.

Installation

Dependencies

HOI requires :

  • Python (>= 3.8)

  • numpy(>=1.22)

  • scipy (>=1.9)

  • jax

  • pandas

  • scikit-learn

  • jax-tqdm

  • tqdm

User installation

To install Jax on GPU or CPU-only, please refer to Jax’s documentation : https://jax.readthedocs.io/en/latest/installation.html

If you already have a working installation of NumPy, SciPy and Jax, the easiest way to install hoi is using pip:

pip install -U hoi

You can also install the latest version of the software directly from Github :

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

For developers

For developers, you can install it in develop mode with the following commands :

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

The full installation of HOI includes additional packages to test the software and build the documentation :

  • pytest

  • pytest-cov

  • codecov

  • xarray

  • sphinx!=4.1.0

  • sphinx-gallery

  • pydata-sphinx-theme

  • sphinxcontrib-bibtex

  • numpydoc

  • matplotlib

  • flake8

  • pep8-naming

  • black

Help and Support

Documentation

Communication

For questions, please use the following link : https://github.com/brainets/hoi/discussions

Acknowledgments

HOI was mainly developed during the Google Summer of Code 2023 (https://summerofcode.withgoogle.com/archive/2023/projects/z6hGpvLS)

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for EtienneCmb from gravatar.com EtienneCmb

Unverified details

These details have not been verified by PyPI
Meta
  • License: BSD 3-Clause License
  • Author: BraiNets
  • Maintainer: Etienne Combrisson
  • Tags information-theory , statistics , higher-order-interactions
  • Provides-Extra: test , doc , lint , full
Classifiers

Release history Release notifications | RSS feed

This version

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

0.0.1

0.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hoi-0.0.7.tar.gz (33.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hoi-0.0.7-py3-none-any.whl (61.7 kB view details)

Uploaded Python 3

File details

Details for the file hoi-0.0.7.tar.gz.

File metadata

  • Download URL: hoi-0.0.7.tar.gz
  • Upload date:
  • Size: 33.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hoi-0.0.7.tar.gz
Algorithm Hash digest
SHA256 54955507bb235f8ca161fbd82f74fe611db57ff28862a3cc17554f146aea00d6
MD5 ddb943d7e01aa6e7b90111529470923c
BLAKE2b-256 50773598dbb6a719e4e907901f71e20383a2d2661f45ea019c72a443501f2a44

See more details on using hashes here.

Provenance

The following attestation bundles were made for hoi-0.0.7.tar.gz:

Publisher: pypi-publish.yml on brainets/hoi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hoi-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: hoi-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 61.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hoi-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 dfe46c339ea327f104a485c9da7c866c79dda0aaa51ba5dd3d7015a2677fe1da
MD5 cf97a0be8c3edaf196238499cd121848
BLAKE2b-256 885cd1598cea7d3787e67832358bbc9908d83e9ff94263d694c02b175eef120f

See more details on using hashes here.

Provenance

The following attestation bundles were made for hoi-0.0.7-py3-none-any.whl:

Publisher: pypi-publish.yml on brainets/hoi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page