Skip to content

API Reference Overview

Welcome to the scinr.newton API reference. All API documentation is auto-generated from Python docstrings using mkdocstrings.

Core Modules

  • Pipeline: run_pipeline() orchestrator.
  • Configuration: configure(), get_config(), ScinrConfig.
  • Stages: Individual stage runner functions (Stages 0-5).
  • Normalization: NormalizationEngine and normalization utilities.
  • Results: PipelineResult, StageResult, DocumentResult, DeletionResult.
  • Exceptions: ScinrError hierarchy.
  • Deletion: delete_document() — permanent document removal with cascade and garbage collection.
  • Converters: Document format converters.
  • Storage: Storage backends.
  • Utilities: Theme registry, LLM factory, and utilities.

User Guides

For tutorials and how-to guides, see the User Guides section.