Scheduled prediction sync keeps your predictions up to date by automatically reading your apply data and writing back the resulting predictions.
What is Scheduled prediction sync?
Scheduled prediction sync allows you to specify the name of prediction dataset and then automatically reads the apply dataset, generates the predictions and writes them back to your target environment on a scheduled basis.
How does it work?
Scheduled prediction sync is an option available for any prediction dataset in Kraken that is powered by an apply dataset NOT coming from a manually-uploaded .CSV file. (.CSV files coming from buckets like Amazon S3 and MinIO are supported.) When you create a prediction dataset and enable the sync option, you can specify the name you'd like for the predicted dataset; by default, the name will be the name of your apply dataset with "_PREDICTED" appended to it. Once the sync option is enabled, Kraken will immediately write the prediction dataset and then keep the predictions up to date by reading the apply dataset on a scheduled basis and then writing the prediction dataset to your target environment.
To access and enable scheduled prediction sync, edit the syncing options for the prediction dataset of your choice that is not powered by an apply dataset coming from a manually-uploaded .CSV file.
Once you've accessed the syncing options, you can edit the name of the synced dataset and enable the sync option. Once you've enabled sync, that's it! Kraken will now keep your predictions up to date. At any time, if you want to stop the scheduled prediction sync, simply disable the sync option.
How can I see the run history and status of my scheduled predictions?
At any time you can access the Sync screen and scroll down to see the run history of your predictions. This history will include information on both scheduled predictions as well as those run manually with the "RUN NOW" button. If you see an "error" icon, hovering over that icon will provide details about what went wrong with that particular prediction sync.
How do I change the name of my synced prediction dataset?
- Disable the sync option (the button will be grey when it's disabled)
- Edit a new name for your synced dataset
- Enable the sync option (the button will be green when it's enabled)
When and how often will Kraken update my predictions?
By default, Kraken will run your scheduled prediction sync on a daily basis, shortly after 1am Mountain Time. If you would like to choose a specific time for all of your daily scheduled predictions, contact Big Squid Support and we can manually set a daily time for your predictions. Note that changing the default time will affect all predictions for your user. If you're looking to specify different times for different predictions, please read the "custom schedule" section, directly below.
Can Kraken run my scheduled predictions more than once a day or on a custom schedule?
Big Squid customers with an Enterprise plan have the ability to request unlimited custom schedules for prediction syncs. Need your prediction to run every hour between 8am and 10pm on weekdays plus twice a day on weekends? Kraken can do that. Want to run a prediction every other day at 10am and 2pm, plus every hour on the first day of the month? Kraken can do that.
Enterprise plan customers can contact their friendly neighborhood Big Squid Customer Success Representative or Big Squid Support to request the creation of custom prediction schedules. If you are not an Enterprise plan customer, please contact Big Squid Sales for more information.
Important considerations about scheduled prediction sync:
- When creating a scheduled prediction sync, ensure that the synced dataset name you plan to use does not already exist in your target environment. If the name already exists, Kraken will be unable to write the prediction dataset and will throw an error. This is by design, to prevent you from inadvertently overwriting existing data in your target environment.
- Related to - but distinct from - consideration #1 above, once you have created a scheduled prediction sync with a unique name, Kraken will overwrite that prediction dataset during scheduled predictions as well as if you click the "RUN NOW" button in the Sync dialog to run the predictions manually. In other words, Kraken does not append predictions but, instead, overwrites the previous prediction dataset.
How is Scheduled Prediction Sync different from Automated Prediction Download?
Scheduled prediction sync writes Kraken predictions on a scheduled basis for any apply dataset not coming from a manually-uploaded .CSV file. Kraken writes the data to the target environment on a scheduled basis in what's commonly referred to as a data "push".
Conversely, Automated Prediction Download is specifically designed to allow you to retrieve ("pull") prediction datasets that Kraken has already generated from any apply dataset, including manually-uploaded .CSV data. It is a "one-way street" from Kraken to your applications to access existing predictions at any time you choose. It's important to note that, while you can use Automated Prediction Download to pull predictions from Kraken at any time, the "freshness" of those predictions will be based on the last time the predictions were updated in Kraken, either manually by a user or by a scheduled prediction. In other words, Automated Prediction Download does not force Kraken to refresh the predictions; it simply provides access to the latest existing predictions.
There are many reasons why you may choose one or the other - as well as when you may want to use both - for a given prediction dataset. See the "Why (and how) would I use Automated Prediction Download?" section of the Automated Prediction Download documentation for more information.