Prediction Scheduler
Last updated
Last updated
Use this procedure to create a prediction scheduler for a model within a project.
Hover over the menu and select Projects. The Projects dashboard is displayed.
Select the project for which you want to create a prediction scheduler. You can create prediction schedulers for different models in a project.
The Canvas page is displayed.
Click the Predictions tab on the project navigation menu on the left to open the Predictions page.
Do one of the following:
Click the plus icon on the top right corner of the page.
Click the +Prediction Scheduler option to create a prediction scheduler. However, you can only view this option when there are no schedulers created in this project.
The following page is displayed where you can create a prediction scheduler to run this data pipeline at the set time interval.
Select the model that you want to use to generate predictions at the scheduled frequency.
Click Proceed.
Select the model on which you want to generate predictions at the scheduled frequency.
Select the scheduler frequency. Possible values:
Daily - This displays Hrs and Min. drop-down to select the time at which the job should be triggered.
Weekly - This displays days in a week and time at which the scheduler should be run.
Cron - This displays the Unix Cron format to create a scheduler.
View the data pipeline on the canvas.
Click Save to create the prediction scheduler. This also enables the +Destination option to configure the data connector to which you can publish the generated output datasets or the input dataset.
You can see the project variables button only if the variables are defined at the project level. After creating the scheduler, you can change the value in project variables.
Click + Destination. This opens the Destinations side panel.
Click + Destination.
Select the dataset that you want to add to the destination. If the dataset list is huge, you can use the search option to search for the dataset you want.
Select the destination from the drop-down list. You can only view the list of external data sources configured under this tenant excluding Snowflake and Fivetran connectors.
Info When you select the SQL connector to synchronize or copy the output dataset generated after running the project, the table name column is displayed. Here, you can provide the table name and select either "Append" or "Replace". Opting for the "Append" option will append the dataset to the existing one, provided both datasets share the same schema. Alternatively, selecting the "Replace" option will replace the existing dataset with the new one.
If you choose the data connector as MongoDB, you can provide the database name and collection. In the event that the provided collection name already exists, the new dataset will be appended to the existing collection.
Provide the destination folder and destination file name to save the file in the destination folder with the new file name after the job is run every time at the scheduled time.
Click Save to save this destination. This button is enabled only after you select all the required destination fields.
Note
You can store files in multiple destinations. To add another destination, click + DESTINATION. If you want to remove any destination, click the delete icon.
If you no longer want to save the output to the configured destination, you can use the delete icon to delete the destination.
Close the window after configuring the destination for the job. Once the destination details are set, the destination node will appear on the scheduler canvas.
Click GLOBAL VARIABLES to change the configured parameters for this job.
Note: The GLOBAL VARIABLES button is enabled only when the global variables are declared at the project level. To configure global variables, refer to configuring global variables at a project level.
Change the value for the key. Please note that you cannot change the key.
Use this procedure to manually run or re-run the prediction scheduler. However, scheduled runs occur automatically based on the configured recurrence.
To manually run a prediction scheduler:
Select the project in which you want to run the job.
Click the Predictions tab to view the list of manual predictions and prediction schedulers for this project. The predictions list page is only visible if predictions have been created for the selected project.
Click the scheduler name link you want to run manually. This opens the specific prediction scheduler's page.
Click Run to initiate the job manually. This opens the Manual Run Configuration side panel.
Enter a run name and click Run. Once the prediction scheduler run starts, its status changes from Created to Entity Loading and then to Running. When the run completes successfully, you can view the output on the Run History page.
To re-run a job, click the ellipsis icon in the Run Name column on the Run History page and select RE-RUN.
To delete a specific run, select DELETE.
Use this procedure to manage all the prediction schedulers in a project.
Hover over the menu icon and select Projects. The Projects dashboard is displayed.
Select the project for which you can schedule or create a job. You can create jobs for different scenarios in a project.
Click the Predictions tab on the left navigation menu of the project to open the schedulers page and view the list of manual and automatic schedulers you have already created.
Note: If there are multiple schedulers, you can use the search option to find the scheduler you want.
You can also create a new scheduler, using the plus option.
Click on the Prediction Scheduler name that you want to edit. This redirects you to the Prediction scheduler page where you can edit the prediction scheduler details.
Modify the required details.
Click Save to view the new changes.
On this Prediction scheduler page, you can also:
Run this job manually, clicking the Run button.
View the run history, using the Run history icon. This allows you to view the history of all prediction scheduler runs till date and up to 300 records of last 30 days.
Pause the job that is running, using the Pause icon. You can click the same icon to start the paused prediction scheduler.
Click the Action drop-down to select the Delete option to delete this prediction scheduler permanently.
Click the Timeout 1hr option to change the timeout duration of the prediction scheduler. You can view this option when you click the Actions drop-down. By default, the timeout duration is set to 1 hr. Setting this will terminate the prediction scheduler after this duration.
Use this procedure to view all the prediction schedulers in a project and see the output generated after every job run.
Hover over the menu icon and select Projects. The Projects dashboard is displayed.
Select the project for which you can to schedule or create a job. You can create jobs for different scenarios in a project.
Click the Predictions tab on the left navigation menu of the project to open the predictions page and navigate to the Prediction scheduler tab to view the list of prediction schedulers created.
Review this information:
Scheduler Name: The name of the job.
Input Model: The selected model used to create the prediction scheduler.
Status: The status of this scheduler. Possible values:
Scheduler Active - By default is set to Active.
Scheduler Inactive - Indicates that the manual run has been paused.
Last run by: Indicates whether the business user or scheduler has run the scheduler last.
Last Run: The date and time at which the scheduler was run lastly.
Last 5 Runs: Indicates the last five scheduler run status. Possible values:
Failed - The scheduler has failed to run.
Success - The scheduler has been run successfully.
Created - The scheduler has been created.
Last Run Prediction Output: Click to view the output generated from the last scheduler run. This option is available only after the scheduler has been executed; until then, it remains disabled.
Last Run Log: Click to view the logs. You can check the logs to understand the errors in jobs that have failed to run.
Last Run Canvas: Click to view the canvas page. You can only view the page to see the failed blocks and successful blocks in the data pipeline.
Last Run Project Variables: Click to view the last run project variables in this job.
You can click on the table settings icon to reorder the columns and select and deselect the columns you want to view.
Click the ellipses icon next to the scheduler name to access the following options:
Edit: Modify the scheduler details.
Pause: Temporarily halt the current scheduler run.
Run: Manually execute the scheduler outside the automatic schedule.
Run History: View past runs and track executed prediction schedulers.
Delete: Permanently remove the scheduler from the project.
Use this procedure to republish the data pipeline to prediction scheduler. When you update the dataset, delete a recipe or add a new recipe to the data pipeline, you can republish the new flow to the prediction scheduler using the Publish to Prediction Schedulers option on the canvas. This updates the canvas on the selected schedulers.
To publish the changes made in the data pipeline to all or specific prediction scheduler(s) in a project:
Select the project to navigate to the canvas view page.
Click the Actions drop-down and select Publish to Prediction Schedulers on the canvas. This displays the Republish Model Flow to Prediction Scheduler dialog.
This displays the list of prediction schedulers to which you want to publish the latest or updated data pipeline.
Select the checkboxes corresponding to the prediction schedulers to which you want to update the latest canvas. This enables the Yes, Republish button.
Click Yes, Republish to republish or update the latest data pipeline to the selected prediction schedulers.
From the next schedule, the prediction scheduler run is performed on the new modeling pipeline.
Use this procedure to fetch the changes made to the data pipeline on the canvas to the data pipeline in a specific prediction scheduler.
To publish the changes made to the data pipeline on the canvas to a specific scheduler from the prediction scheduler page:
Select the project to navigate to the canvas view page.
Select Predictions from the project level navigation. This takes you to the Schedulers page where you can view the list of schedulers created for this project.
Select the prediction scheduler to which you want to publish the changes made to the data pipeline. This takes you to the selected prediction scheduler page.
Click the Republish button in the canvas section to incorporate all the changes that were made to the canvas at the project level to this pipeline.
The Republish Model Flow to Prediction Scheduler window appears.
Click Yes, Republish to republish the project canvas to the scheduler.
Use this procedure to compare the current canvas of the project and canvas of the prediction scheduler side-by-side to track changes.
To compare the canvas of the scheduler with the current canvas of the project:
Select the project to navigate to the canvas view page.
Select Predictions from the project level navigation. This takes you to the prediction schedulers page where you can view the list of schedulers created for this project.
Select the scheduler that you want to compare with the current canvas of the project. This opens the scheduler page.
Click Compare to compare the canvas of this prediction scheduler with the canvas of the project to notice the differences. You can see the difference between both the canvases side by side.
If you notice the canvas of the prediction scheduler is not up-to-date, you can click Republish to fetch the latest canvas of the project to update the changes.
