API Reference¶

mi_crow's public Python API is documented automatically from docstrings.

The top-level mi_crow package is intentionally minimal (it only exports things like ping). The real functionality lives in subpackages, which are documented in the sections below.

Table of Contents¶

Language Model - Core language model API for loading models, running inference, and managing activations
Mechanistic Interpretability (SAE) - Sparse Autoencoders, training, concepts, and related modules
Datasets - Dataset loading and management utilities
Store - Persistence layer for activations, models, and runs
Hooks - Hook system for intercepting model activations

Top-level Package¶

mi_crow ¶

mi_crow: helper package for the Engineer Thesis project.

This module is intentionally minimal. It exists to define the top-level package and to enable code coverage to include the package. Importing it should succeed without side effects.

ping ¶

ping()

Return a simple response to verify the package is wired correctly.

Source code in src/mi_crow/__init__.py

def ping() -> str:
    """Return a simple response to verify the package is wired correctly."""
    return "pong"