hoi

Descrição

HOI (Higher Order Interactions) é um pacote Python que vai além das interações entre pares, quantificando as dependências estatísticas entre 2 ou mais unidades usando métricas teóricas da informação. O pacote é construído sobre Jax, permitindo cálculos em CPU ou GPU.

Instalação

Dependências

HOI requer:

• Pitão (>= 3,8)
• entorpecido(>=1,22)
• cipião (>=1,9)
• jax
• pandas
• scikit-aprender
• jax-tqdm
• tqdm

Instalação do usuário

Para instalar o Jax apenas na GPU ou CPU, consulte a documentação do Jax: https://jax.readthedocs.io/en/latest/installation.html

Se você já possui uma instalação funcional do NumPy, SciPy e Jax, a maneira mais fácil de instalar o hoi é usando pip :

pip install -U hoi

Você também pode instalar a versão mais recente do software diretamente do Github:

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

Para desenvolvedores

Para desenvolvedores, você pode instalá-lo no modo de desenvolvimento com os seguintes comandos:

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

A instalação completa do HOI inclui pacotes adicionais para testar o software e construir a documentação:

• pytest
• pytest-cov
• códigocov
• matriz x
• esfinge!=4.1.0
• galeria da esfinge
• tema pydata-esfinge
• esfingecontrib-bibtex
• numpydoc
• matplotlib
• floco8
• nomenclatura pep8
• preto

Ajuda e suporte

Documentação

• Link para a documentação: https://brainets.github.io/hoi/
• Visão geral da base matemática: https://brainets.github.io/hoi/theory.html
• Lista de métricas HOI implementadas: https://brainets.github.io/hoi/api/modules.html
• Exemplos: https://brainets.github.io/hoi/auto_examples/index.html

Comunicação

Para perguntas, use o seguinte link: https://github.com/brainets/hoi/discussions

Agradecimentos

HOI foi desenvolvido principalmente durante o Google Summer of Code 2023 (https://summerofcode.withgoogle.com/archive/2023/projects/z6hGpvLS)