User Guide
This section contains step-by-step guides for common tasks and workflows with NIRS4ALL.
- Data Handling
- Loading Data
- Synthetic Data Generation
- Signal Types and Conversion
- Sample Repetition & Aggregation
- Heterogeneous Source Repetitions
- Tutorial: Heterogeneous Source Repetitions
- Raw multimodal pipelines
- Fusion tardive avec observations partielles
- Native multimodal early fusion
- Octave models in a Python multimodal workflow
- Sample Filtering User Guide
- Overview
- Coming Soon
- See Also
- Preprocessing
- Data Augmentation
- Pipelines
- Models
- Model Training
- Hyperparameter Tuning
- Search source subsets, preprocessing chains and Ridge versus PLS
- Native tuning and conformal calibration
- Native PLS phase controls
- Native PLS HPO within each outer fold
- Initialize SGD REFIT from an explicit CV fold
- AOM Models
- Deep Learning Models
- TabPFN for NIRS — fixed recipe (no HPO)
- Overview
- Supported Model Frameworks
- Quick Example
- Built-in NIRS Models
- See Also
- Predictions
- Deployment
- Visualization
- Extended Python API
- Troubleshooting
- Logging System User Guide
- Understanding Scores, Evaluation, and Refit
Overview
The User Guide provides practical how-to guides organized by topic. Each guide focuses on a specific task and includes working code examples.
Load and manage spectroscopic data from various formats. Filter samples and aggregate predictions.
Master spectral preprocessing techniques: SNV, MSC, derivatives, Savitzky-Golay, and more.
Improve model robustness with sample and feature augmentation techniques.
Advanced pipeline patterns: branching, merging, stacking, and generators.
Train and compare machine learning models with hyperparameter tuning.
Export trained pipelines as standalone bundles for production use.
Analyze predictions, residuals, and explain model behavior with SHAP.
Migration guides, common issues, and solutions.
Extended Python functions, operators, controllers, and common recipes.
Additional Topics
Logging System User Guide - Configure logging for debugging and monitoring
Extended Python API - Extended Python API, operators, controllers, and recipes
See Also
Writing a Pipeline in nirs4all - Complete pipeline syntax reference
Operator catalog: choose a job, then inspect the method - All available operators
Interactive Example Browser - Working examples organized by topic