Examples#
Simple Example
The simplest yaml file is generated by the ads operator init --type forecast
and looks like the following:
kind: operator
type: forecast
version: v1
spec:
datetime_column:
name: Date
historical_data:
url: data.csv
horizon: 3
model: auto
target_column: target
Typical Example
A typical forecast yaml will usually have the following fields:
kind: operator
type: forecast
version: v1
spec:
additional_data:
url: additional_data.csv
datetime_column:
name: time
generate_explanations: true
historical_data:
url: primary_data.csv
horizon: 5
metric: smape
model: "auto"
output_directory:
url: results
target_category_columns:
- Series
target_column: Total
test_data:
url: test_data.csv
Complex Example
The yaml can also be maximally stated as follows:
kind: operator
type: forecast
version: v1
spec:
historical_data:
url: primary_data.csv
additional_data:
url: additional_data.csv
output_directory:
url: results
test_data:
url: test_data.csv
target_category_columns:
- Store_ID
target_column: Sales
horizon: 5
datetime_column:
format: "%d/%m/%y"
name: Date
model: automlx
model_kwargs:
time_budget: 1
tuning:
n_trials: 5
preprocessing: true
metric: smape
confidence_interval_width: 0.8
generate_explanations: true
generate_metrics: true
generate_report: true
local_explanation_filename: local_explanation.csv
metrics_filename: metrics.csv
report_filename: report.html
report_theme: light
forecast_filename: forecast.csv
global_explanation_filename: global_explanation.csv
test_metrics_filename: test_metrics.csv