Vertebrae Documentation

Core guides, API docs, and project notes live here. The pages below pull directly from the repository README, existing Markdown guides, and generated API reference.

Guides

• Project Overview
  • Evaluation flow
  • Installation
  • Quick Start
  • Supported Workflows
  • Reports and Results
  • Optional Extractors
  • Command Line Interface
  • Notes
  • License
• Datasets
  • Dataset identity
  • Supported constructors
  • Named target views
  • Raw structured unit annotations
  • Explicit structured alignment
  • Validation rules
  • Modalities and preserved metadata
  • Hierarchical label views
  • Batching and sharding
  • Working with precomputed embeddings
  • Practical guidance
• Dense Segmentation
• Feature Extractors
  • Resource profiling adapters
• Representation Monitoring
  • Basic workflow
  • Fixed probes and interpretation
  • Fresh computation and cost
  • History storage
  • Failures and reporters
• Embedding Compression
  • Configuration
  • Supported methods
  • Metadata and reports
  • CLI
  • Choosing a method
• Scoring
  • Fixed metric backend
  • OverlapScoringConfig
  • ContinuousOverlapScoringConfig
  • Automatic k resolution
  • Scoring inputs
  • Returned diagnostics
  • Stability analysis
  • Separatix diagnostics
  • Custom embedding metrics
  • Retrieval and matching
  • Practical guidance
• Retrieval and Matching
• Zero-shot Semantic Alignment
  • Fixed prompts and class prototypes
  • Metrics and interpretation
  • Memory-bounded exact scoring
  • Compression and artifact workflows
• Results and Reports
  • Result objects
  • Resource profiles and quality cohorts
  • Ranking and tabular views
  • JSON and Markdown output
  • What recommendations mean
  • Reproducibility mindset
• Runnable Examples
  • Included workflows
• Distributed Execution
• API Reference
  • Submodules