Reference
Complete reference documentation for NIRS4ALL APIs, syntax, and operators.
- Writing a Pipeline in nirs4all
- Pipeline Keywords Reference
- Operator catalog: choose a job, then inspect the method
- Choose a pipeline node by what you want to do
- Transforms Reference
- Choose a transform by the effect you want to remove
- Same worked recipe in JSON, YAML and Python
- Scatter Correction and Normalization
- Smoothing
- Derivatives
- Baseline Correction
- Orthogonalization
- Signal Conversion
- Wavelet Transforms and Feature Extraction
- Feature Selection
- Resampling and Cropping
- Target Transforms
- See Also
- How to interpret and combine the families
- A complete, small transformation experiment
- Learning exercises and exact APIs
- Ragged temporal encoding: SequenceSummary
- Fixed convolution features: FCKStaticTransformer
- Augmentation Operators Reference
- Choose a perturbation that resembles real acquisition variability
- Same worked recipe in JSON, YAML and Python
- Noise
- Baseline Drift
- Wavelength Distortion
- Spectral Distortion
- Mixup
- Physical / Instrumental
- Environmental
- Scattering
- Edge Artifacts
- Spline-Based
- Random Geometric
- See Also
- What the perturbations mean
- Sample versus feature augmentation
- Diagnose an augmentation experiment
- Built-in Models Reference
- Choose a model by the target and structure of your data
- Same worked recipe in JSON, YAML and Python
- Adaptive PLS (Auto-Preprocessing)
- AOM-Ridge and FastAOM
- Standard PLS
- Orthogonal PLS
- Multi-Block and Domain-Invariant
- Sparse and Interval
- Kernel PLS
- Locally Weighted
- Nonlinear PLS
- Meta-Model Stacking
- AOM-PLS Operator Bank
- See Also
- Understand the fitted object
- Interpret a component sweep
- More models than this spectroscopy shortlist
- Typed multimodal estimators
- Principal component regression
- Splitters Reference
- Filters Reference
- Choose a criterion, then decide what its flag means
- Same worked recipe in JSON, YAML and Python
- YOutlierFilter
- XOutlierFilter
- SpectralQualityFilter
- HighLeverageFilter
- MetadataFilter
- CompositeFilter
- Tag vs Exclude Keywords
- See Also
- Read a flag as evidence, not a diagnosis
- Where filtering belongs in a workflow
- Generator keywords: choices, combinations and their exact outputs
- Clickable keyword index
- Alternatives and numeric values
- Products, paired parameters and ordered alternatives
- Sets and sequences: why order changes the count
- Search size and reproducibility
- Constraints: remove choices you do not want to test
- Reuse a search specification
- Advanced names with limited effects
- Inspect before fitting
- Combination Generator Documentation
- Configuration Reference
- Configuration Reference
- Metrics Reference
- Predictions API Reference
- Session API Reference
- Public Interfaces and Runtime
- Public execution matrix
- Native Capability Preflight
- Native conformal finetuning release audit
- CLI reference
- Workspace Architecture
- Storage API Reference
Pipeline & Syntax
Step formats, execution order, serialization rules.
All dict keywords: model, y_processing, branch, merge, tag, exclude, and more.
_or_, _range_, _grid_, _zip_, _sample_ and other expansion keywords.
PipelineConfigs, DatasetConfigs, CacheConfig specification.
Operators by Category
SNV, MSC, derivatives, baseline, wavelets, feature selection, and more.
Noise, baseline drift, wavelength shifts, mixup, physical effects, and more.
Built-in PLS variants (AOM-PLS, POP-PLS, OPLS, DiPLS, etc.) and deep learning.
Kennard-Stone, SPXY, K-means, and sklearn splitters.
Y-outlier, X-outlier, spectral quality, high leverage, metadata filters.
Full catalog including sklearn and deep learning operators.
Results & Deployment
All evaluation metrics for regression and classification.
Predictions and PredictionResultsList objects.
Stateful Session workflows and model persistence.
Fail-closed R2/R4 limitations and machine-readable preflight routes.
Command-line interface for workspace commands.
Workspace architecture and directory structure.
SQLite metadata store, Parquet arrays, artifact storage.
API Documentation
Detailed API documentation is also available in the API Reference section.
See Also
User Guide - Step-by-step how-to guides
Architecture Overview - Architecture overview for developers
Artifacts & Storage - Artifacts and storage developer guide
Interactive Example Browser - Working examples organized by topic