predictr-io/Predictr Forecast Analysis

Create and manage forecast analyses in Predictr.io with optional model fitting and workflow creation

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
api-keyPredictr.io API key for authenticationyes
organisationOrganisation name in Predictr.ioyes
api-endpointPredictr.io API endpoint (e.g., api.predictr.io)noapi.predictr.io
analysis-nameName for the forecast analysis (must be unique)yes
connection-idDatabase connection ID in Predictr.ioyes
table-nameName of the table containing time series datayes
date-columnName of the date/timestamp columnyes
value-columnName of the value column to forecastyes
frequencyTime series frequency: D (daily), W (weekly), or h (hourly)yes
schema-nameDatabase schema name (if applicable)no
table-filterJSON array of filter conditions (e.g., [{"feature": "STORE_CODE", "operator": "EQ", "value": "12345"}])no
regressorsComma-separated list of regressor column namesno
regressors-future-dataJSON object specifying future regressor data source (e.g., {"table_name": "future_weather", "date_column": "date", "schema_name": "analytics"})no
seasonalitySeasonality type: additive or multiplicative (default: additive)noadditive
holidaysCountry code for holiday calendar (e.g., GB, US)no
holiday-subdivisionHoliday subdivision/region (e.g., ENG, CA)no
observedInclude observed holiday dates (default: true)notrue
eventsJSON array of custom events (e.g., [{"event": "Sale", "schedule": [{"ds": "2024-11-24", "duration": 3}]}])no
validation-horizonValidation horizon in time periods (default: 14)no14
validation-periodValidation period in time periods (default: 14)no14
validation-initialInitial validation period in time periods (default: 90)no90
fail-if-existsFail if analysis with same name already exists (default: false)nofalse
fit-modelImmediately fit a model for the analysis (default: true)notrue
model-build-infraModel build infrastructure: s (small) or l (large) (default: s)nos
create-workflowCreate a workflow for the analysis (default: false)nofalse
workflow-enabledEnable the workflow immediately (default: false)nofalse
forecast-periodsNumber of periods to forecast in workflow (default: 14)no14
target-schemaTarget schema for forecast predictions in workflowno
target-tableTarget table for forecast predictions in workflowno
include-historyInclude historical data in workflow predictions (default: true)notrue
workflow-constantsJSON object of constant values to include in workflow predictions (e.g., {"CONTEXT": "store123"})no
column-mappingJSON object mapping forecast columns to target table columns (e.g., {"ds": "FORECAST_AT", "yhat": "ESTIMATE"})no
namedescription
analysis-idID of the created or existing forecast analysis
analysis-existsWhether the analysis already existed (true/false)
model-idID of the fitted model (if fit-model was true)
workflow-idID of the created workflow (if create-workflow was true)