Skip to content

API Overview

The octopi Python API gives you full programmatic control over the particle picking pipeline — useful for scripting large-scale workflows, integrating into notebooks, or customizing training beyond what the CLI exposes.

Core Workflow

  • Quick Start

    End-to-end pipeline in one script — target creation, training, segmentation, localization, and evaluation.

    Get started

  • Training

    Set up data generators, configure model architectures, choose loss functions, and run model exploration.

    Train

  • Inference

    Segment tomograms, localize particle coordinates, and evaluate against ground truth.

    Run inference

  • Adding New Models

    Implement a custom architecture and register it with the octopi model registry.

    Extend