save_forecast
Save Chronulus forecast data and explanations into separate CSV and TXT files. Use this tool to store rescaled predictions and detailed insights for analysis or reference in specified directories.
Instructions
A tool that saves a Chronulus forecast from NormalizedForecaster to separate CSV and TXT files
When to use this tool:
Use this tool when you need to save both the forecast data and its explanation to files
The forecast data will be saved as a CSV file for data analysis
The forecast explanation will be saved as a TXT file for reference
Both files will be saved in the same directory specified by output_path
This tool can also be used to directly save rescaled predictions without first calling the rescaling tool
How to use this tool:
Provide the prediction_id from a previous forecast
Specify the output_path where both files should be saved
Provide csv_name for the forecast data file (must end in .csv)
Provide txt_name for the explanation file (must end in .txt)
Optionally provide y_min and y_max to rescale the predictions (defaults to 0)
Set invert_scale to True if the target units run in the opposite direction
The tool will provide status updates through the MCP context
Input Schema
Name | Required | Description | Default |
---|---|---|---|
csv_name | Yes | The path where the CSV file should be saved. Should end in .csv | |
invert_scale | No | Set this flag to true if the scale of the new units will run in the opposite direction from the inputs. | |
output_path | Yes | The path where the CSV file should be saved. Should end in .csv | |
prediction_id | Yes | The prediction_id from a prediction result | |
txt_name | Yes | The name of the TXT file to be saved. Should end in .txt | |
y_max | No | The expected largest value for the use case. E.g., for product sales, 0 would be the largest possible value would be given by the user or determined from this history of sales for the product in question or a similar product. | |
y_min | No | The expected smallest value for the use case. E.g., for product sales, 0 would be the least possible value for sales. |