Examples & Tutorials

This section provides comprehensive examples and tutorials for using VBI across different computational backends and inference methods.

Simulation Examples

Learn how to simulate brain models using different computational backends:

Getting Started

NumPy/Numba Backend (CPU)

CPU-based simulations using numba for acceleration:

CuPy Backend (GPU)

GPU-accelerated simulations using CuPy:

C++ Backend (High Performance)

High-performance simulations using C++ backend:

Specialized Examples

Quick Start Guide

  1. Begin with Intro - Basic VBI functionality

  2. Learn feature extraction with Introduction to feature extraction

  3. Choose your backend:

    • For CPU: Try numba examples (fast, no GPU required)

    • For GPU: Try CuPy examples (fastest, requires CUDA)

    • For high performance: Try C++ examples (optimized, good for production)

  4. Move to inference: See Inference Methods & Examples for parameter estimation

Computational Backend Comparison

Backend Performance Comparison

Backend

Speed

Requirements

Best For

NumPy/Numba

Fast

CPU only

Development, prototyping

CuPy

Fastest

CUDA GPU

Large simulations, production

C++

Very Fast

C++ compiler

High performance, deployment

Installation Notes

  • Light version (pip install vbi): Includes numba examples

  • Light + GPU version (pip install vbi[light-gpu]): Includes CuPy support

  • Full version (pip install vbi[inference]): Includes all backends

  • GPU version (pip install vbi[inference-gpu]): Includes CuPy support