TrainingRecipeReport
Models & Types · AiDotNet.Models
What a model’s paper specifies for training, what is actually being used, and every difference between the two.
For Beginners
Research papers describe exactly how they trained a model. This tells you whether your model is training that way — and when it is not, what changed and on what grounds. “Adapted” is normal and usually correct: a learning rate chosen for a batch of 4096 images has to be adjusted for a batch of 32, and the adjustment follows a published rule.
How It Works
Libraries normally leave a paper’s training recipe in prose — a model card, a README, a training script — detached from the model, not applied, and silently replaced by a generic default. The result is that a model can be an order of magnitude away from its published learning rate with nothing anywhere saying so. That is the defect issue #1928 records, across 685 construction sites.
This report exists so that never happens silently again. It answers three questions a user otherwise cannot ask: what does the paper say, what am I actually training with, and if those differ, why. A deviation the library cannot honour is listed rather than hidden.
Constructors
| Constructor | Summary |
|---|---|
TrainingRecipeReport() |
Properties
| Property | Summary |
|---|---|
IReadOnlyList<RecipeAdaptation> Adaptations { get; set; } |
Adjustments made for this run’s scale, each naming its justifying rule. |
IReadOnlyList<string> Cautions { get; set; } |
Things a user should know about this configuration that are neither adjustments nor failures — most often that the run’s scale differs from the paper’s in a way no published rule covers. |
IReadOnlyList<string> Unhonoured { get; set; } |
Parts of the recipe that could not be applied, and why. |
OptimizerKind PaperOptimizer { get; set; } |
The optimizer the paper specifies, or Unspecified. |
RecipeFidelity Fidelity { get; } |
How faithfully the applied configuration reproduces the paper. |
string AppliedOptimizer { get; set; } |
The optimizer actually constructed. |
string Component { get; set; } |
The component this report describes, or empty for the model as a whole. |
string Source { get; set; } |
Where in the paper the recipe comes from. |
Methods
| Method | Summary |
|---|---|
TrainingRecipeReport NotDeclaredFor(string component) |
The report for a model that declares nothing. |
string Describe() |
A one-line human-readable summary, suitable for logs and diagnostics. |