NeuralMI: A Toolbox for Rigorous Mutual Information Estimation in Neuroscience

Welcome to the technical reference for NeuralMI. This page provides detailed documentation on the public functions, classes, and modules that make up the library’s API.

For a high-level overview and practical examples, please see the Tutorials. For implementation details, feel free to explore the source code on our GitHub repository.

Contents:

• Getting Started
  • A Toolbox for Rigorous Mutual Information Estimation in Neuroscience
  • Key Features
  • Quickstart: An Accurate Estimate
  • Learning Path
  • Installation
  • Further Reading
  • Contributing
  • License
• Tutorials
  • Part 1: The Fundamentals
  • Part 2: Core Concepts for Scientific Rigor
  • Part 3: Advanced Analysis and Customization
• API Reference
  • The Core run() Function
  • The Results Object
  • Data Generation (datasets)
  • Visualization (visualize)
  • Configuration
  • Exceptions
• Further Reading
  • Theoretical Foundations of NeuralMI
  • Under the Hood: Core Concepts for MI Estimation
  • Under the Hood: A Developer’s Guide to NeuralMI