Options - Prediction Engine

<div class="section-label">02 Options</div> <div class="section-title">Settings for each prediction call.</div> These are **advanced knobs**. For general analysis, call predict_psr, predict_maxfit, or predict_grid without the options argument; each method uses suitable defaults. To customize a run, pass the matching object: [[#PredictOptions|PredictOptions]] with predict_psr, [[#MaxFitOptions|MaxFitOptions]] with predict_maxfit, or [[Settings/Grid Options#GridOptions|GridOptions]] with predict_grid. MaxFitOptions and GridOptions extend PredictOptions: the same shared fields, plus the knobs for the respective path. Grid search, sampling, and retain are on [[Settings/Grid Options|Grid options]]. ```mermaid classDiagram direction TB class PredictOptions { shared base fields } class MaxFitOptions { +objective +inner_parallel } class GridOptions { +max_iter +min_k +max_k +allowed_k +seed +attribute_combi +required_attributes +attribute_groups +adjust_impact_for_missing +retain_grid_objects +inner_parallel } PredictOptions <|-- MaxFitOptions PredictOptions <|-- GridOptions ``` ## PredictOptions Settings for predict. Also the shared base inherited by MaxFitOptions and GridOptions. **Call:** `predict_psr` **Type:** `PredictOptions` **Defaults when omitted:** threshold `[0.5]`; `censor_type` `relevance`; `censor_unit` `percent`; `censor_operator` `gte` ```text PredictOptions ├── threshold ├── censor_type, censor_unit, censor_operator ├── prediction_scale ├── adj_fit_multiplier, inv_method └── missing_moments, include_linear_regression, verbose ``` Field details: | Name | Type / values | Default | Description | | --- | --- | --- | --- | | threshold | vector, length ≥ 1 | [0.5] | Censor cut(s); becomes T on results | | censor_type | relevance \| similarity | relevance | Score that is thresholded. both is invalid here | | censor_unit | score \| percent | percent | Raw score vs percentile | | censor_operator | gt \| lt \| gte \| lte | gte | How the cut compares to the score | | prediction_scale | response \| logistic | response | Prediction on y scale or logistic scale | | adj_fit_multiplier | identity \| K \| log | K | How adjusted fit is scaled | | inv_method | gaussian \| cholesky \| pseudoinverse | gaussian | Covariance inversion method | | missing_moments | pairwise \| complete | pairwise | How μ, Σ, and PSR N treat NaNs. Incomplete X rows still get weight 0; this does not drop them from ŷ. complete is listwise. Alias: verify_missing_data on → complete | | include_linear_regression | on / off | off | Attach optional yhat_linear when available | | verbose | on / off | off | Diagnostic status messages | > [!note]- Percentile algorithm > When censor_unit is percent, a process-wide percentile algorithm also applies (full_sort or order_statistics). It is not a field on the options object. See [[Settings/Allowed Values#Percentile algorithm|Allowed values]]. ## MaxFitOptions Settings for predict_maxfit. Includes all [[#PredictOptions|PredictOptions]] fields, with MaxFit-oriented defaults for threshold and censor type. **Call:** `predict_maxfit` **Type:** `MaxFitOptions` **Inherits:** [[#PredictOptions|PredictOptions]] ```text MaxFitOptions ├── …PredictOptions ├── threshold, censor_type (MaxFit defaults) ├── objective └── inner_parallel ``` MaxFit-specific options and overridden defaults: | Name | Type / values | Default | Description | | --- | --- | --- | --- | | threshold | vector, length ≥ 1 | [0, 0.2, 0.5, 0.8] | Candidate thresholds to search | | censor_type | relevance \| similarity \| both | both | both allowed (unlike Predict) | | objective | fit \| adjusted_fit \| kfit | kfit | Score used to pick the winning threshold | | inner_parallel | auto \| off | auto | Within-call parallel when searching both censor types | Other PredictOptions fields keep the PSR defaults unless you override them. <div class="btn-row center"> <a class="btn-primary" href="/Settings/Grid%20Options">Grid options</a> <a class="btn-ghost" href="/Settings/Allowed%20Values">Allowed values</a> </div> ## Related - [[Functions/PSR]] · [[MaxFit]] · [[Grid Prediction]] - [[Settings/Grid Options|Grid options]] · [[Settings/Allowed Values|Allowed values]] - [[Results/Overview|Results]] > [!warning]- C ABI / native integrators > Option names and defaults here follow the thin clients. The C ABI may expose different symbols, flag names, or ownership rules. Integration engineers should pin and follow the public header contract rather than this chapter alone: [[Install/Native Runtime|Native Runtime]] · [C ABI on GitHub](https://github.com/CambridgeSportsAnalytics/rbp-math-c-abi).