YAML Schema

kind	allowed operator required True type string default operator meta description Which service are you trying to use? Common kinds: `operator`, `job`
version	allowed v1 required True type string default v1 meta description Operators may change yaml file schemas from version to version, as well as implementation details. Double check the version to ensure compatibility.
type	required True type string default forecast meta description Type should always be `forecast` when using a forecast operator
spec	required True schema historical_data required True type dict meta description This should be indexed by date and target category (optionally). It should include all targets and endogeneous data. schema format allowed csv json clipboard excel hdf feather load_files required False type string columns required False type list schema type string options nullable True required False type dict url required True type string default data.csv meta description The url can be local, or remote. For example: `oci://<bucket>@<namespace>/data.csv` limit required False type integer additional_data required False type dict meta description Additional datasets must be indexed by the same targets and target categories as the historical data. Also is must have datapoints for each date/category for your horizon. This must be exogeneous data. schema format allowed csv json clipboard excel hdf feather load_files required False type string columns required False type list schema type string options nullable True required False type dict url required False type string meta description The url can be local, or remote. For example: `oci://<bucket>@<namespace>/data.csv` limit required False type integer test_data required False meta description Optional, only if evaluation is needed. schema connect_args nullable True required False type dict format required False type string allowed csv json clipboard excel hdf sql columns required False type list schema type string url required True type string default test.csv meta description The url can be local, or remote. For example: `oci://<bucket>@<namespace>/data.csv` name required False type string options nullable True required False type dict type dict output_directory required False schema connect_args nullable True required False type dict format required False type string allowed csv json clipboard excel hdf sql url required True type string default result/ meta description The url can be local, or remote. For example: `oci://<bucket>@<namespace>/` name required False type string options nullable True required False type dict type dict report_file_name required False type string default report.html meta description Placed into output_directory location. Defaults to report.html report_title required False type string report_theme required False type string default light allowed light dark report_metrics_name required False type string default report.csv meta description Placed into output_directory location. Defaults to report.csv target_column type string required True default target preprocessing type boolean required False default True meta description preprocessing and feature engineering can be disabled using this flag, Defaults to true datetime_column type dict required True schema name type string required True default Date format type string required False target_category_columns type list required False schema type string horizon required True schema periods type integer default 3 required True interval type integer required False interval_unit required True type string default M allowed S M H D W Mo Q Y type dict model type string required True default automlx allowed prophet arima neuralprophet automlx autots auto model_kwargs type dict required False confidence_interval_width type float required False default 0.8 tuning type dict required False schema n_trials type integer required False default 10 metric type string required False default MAPE allowed MAPE RMSE MSE SMAPE type dict