Reference

Complete reference documentation for NIRS4ALL APIs, syntax, and operators.

• Writing a Pipeline in nirs4all
  • Table of Contents
  • Overview
  • Pipeline vs Pipeline Generator
  • Basic Step Syntaxes
  • Model Step Syntaxes
  • Generator Syntaxes
  • Branching and Merging Keywords
  • File Formats
  • Syntax Reference Table
  • Serialization Rules
  • Best Practices
  • Examples
  • Troubleshooting
  • See Also
• Operator Catalog
  • Category Overview
  • Augmentation
  • Spectral Preprocessing
  • Feature Engineering (scikit-learn TransformerMixin)
  • Dimension Reduction
  • Classical Models (scikit-learn estimators)
  • Deep Learning (TensorFlow)
  • Validation & Splitting
  • Target Processing
  • Prediction & Outputs
  • Pipeline Utilities
  • Maintenance Notes
• Generator Keywords Reference
  • Table of Contents
  • Overview
  • Phase 1-2: Core Keywords
  • Phase 3: Advanced Keywords
  • Phase 4: Production Keywords
  • Modifier Keywords
  • API Functions
  • Selection Semantics: pick vs arrange
  • Common Patterns and Examples
  • See Also
• Combination Generator Documentation
  • Overview
  • Architecture
  • Core Concepts
  • Complete Syntax Reference
  • Key Behavioral Rules
  • Implementation Details
  • Performance Planning
  • Usage Examples
  • Performance Considerations
  • Version History
  • Related Documentation
• Configuration Reference
  • PipelineConfigs
  • DatasetConfigs
  • Complete Examples
  • See Also
• Metrics Reference
  • Overview
  • Regression Metrics
  • Classification Metrics
  • Using Metrics in Code
  • Metric Selection Guidelines
  • Complete Example
  • See Also
• Predictions API Reference
  • Module-Level Functions
  • Result Classes
  • PredictionResultsList
  • PredictionResult
  • WorkspaceStore (Prediction Queries)
  • See Also
• Workspace CLI Commands
  • Installation
  • Usage
  • Commands
  • Programmatic Usage
  • Workflow Example
  • Notes
• Workspace Architecture
  • Design Principles
  • Directory Structure
  • DuckDB Schema (7 tables)
  • API Classes
  • Common Workflows
  • See Also
• Storage API Reference
  • Module: nirs4all.pipeline.storage
  • See Also

Overview

This section provides detailed reference documentation:

📄 Pipeline Syntax

Complete guide to writing pipelines including all step types, generator syntax, and options.

Comprehensive

Writing a Pipeline in nirs4all

🧰 Operator Catalog

Complete listing of all available operators: preprocessors, splitters, models, and augmentations.

All Operators

Operator Catalog

🔧 Generator Keywords

Reference for _or_, _range_, _choice_ and other generator keywords.

Generators

Generator Keywords Reference

⚙️ Configuration

Complete PipelineConfigs and DatasetConfigs specification.

Config

Configuration Reference

📊 Metrics

All evaluation metrics for regression and classification.

Evaluation

Metrics Reference

📈 Predictions API

Complete guide to the Predictions and PredictionResultsList objects.

Results

Predictions API Reference

💻 CLI Reference

Command-line interface documentation for all nirs4all workspace commands.

Commands

Workspace CLI Commands

📁 Workspace

Workspace architecture and directory structure.

Organization

Workspace Architecture

API Documentation

Detailed API documentation is also available in the nirs4all section.

See Also

• User Guide - Step-by-step how-to guides

• Architecture Overview - Architecture overview for developers

• Artifacts & Storage - Artifacts and storage developer guide

• Examples - Working examples organized by topic