ReportOptions
Options & Configuration · AiDotNet.Evaluation.Options
Configuration options for evaluation report generation.
For Beginners
After evaluating your model, you need to communicate results. These options control:
- Format (Markdown for docs, JSON for APIs, HTML for dashboards)
- Detail level (summary for stakeholders, full for data scientists)
- What to include (metrics, plots, recommendations)
How It Works
Controls how evaluation results are formatted and presented, including output format, detail level, and what sections to include.
Constructors
| Constructor | Summary |
|---|---|
ReportOptions() |
Properties
| Property | Summary |
|---|---|
ReportDetailLevel? DetailLevel { get; set; } |
Detail level for the report. |
ReportFormat? Format { get; set; } |
Output format for the report. |
ReportSection[] SectionsToExclude { get; set; } |
Sections to exclude. |
ReportSection[] SectionsToInclude { get; set; } |
Sections to include (if null, all applicable sections). |
bool? AppendToFile { get; set; } |
Whether to append to existing file. |
bool? EmbedImagesInHtml { get; set; } |
Whether to embed images in HTML (base64). |
bool? IncludeBeginnerExplanations { get; set; } |
Whether to include “For Beginners” explanations. |
bool? IncludeComputationTimes { get; set; } |
Whether to include computation time statistics. |
bool? IncludeConfidenceIntervals { get; set; } |
Whether to include confidence intervals in tables. |
bool? IncludeExecutiveSummary { get; set; } |
Whether to include executive summary. |
bool? IncludeInterpretations { get; set; } |
Whether to include interpretation/explanation for each metric. |
bool? IncludeMetricTables { get; set; } |
Whether to include metric tables. |
bool? IncludeRawData { get; set; } |
Whether to include raw data exports. |
bool? IncludeRecommendations { get; set; } |
Whether to include recommendations for improvement. |
bool? IncludeSectionNumbers { get; set; } |
Whether to include section numbers. |
bool? IncludeTableOfContents { get; set; } |
Whether to include table of contents. |
bool? IncludeTimestamp { get; set; } |
Whether to include timestamp. |
bool? IncludeVisualizations { get; set; } |
Whether to include visualization data/references. |
bool? IncludeWarnings { get; set; } |
Whether to include warnings (data issues, assumption violations). |
bool? LatexStandalone { get; set; } |
Whether to make LaTeX report standalone. |
bool? UsePercentages { get; set; } |
Whether to use percentage format where appropriate. |
int? DecimalPlaces { get; set; } |
Number of decimal places for metrics. |
int? MaxTableRows { get; set; } |
Maximum table rows before truncation. |
string Author { get; set; } |
Author name for the report. |
string CustomCss { get; set; } |
Custom CSS for HTML reports. |
string Language { get; set; } |
Language for the report. |
string LatexDocumentClass { get; set; } |
LaTeX document class for LaTeX reports. |
string OutputEncoding { get; set; } |
Encoding for output file. |
string OutputPath { get; set; } |
Output file path. |
string Subtitle { get; set; } |
Subtitle or description. |
string TimestampFormat { get; set; } |
Custom timestamp format. |
string Title { get; set; } |
Title for the report. |