Contact: [email protected]
| Date | Author | Description |
|---|---|---|
| 2021-10-13 | numbworks | Created. |
| 2023-01-22 | numbworks | Updated to v2.5.0. |
| 2023-03-09 | numbworks | Updated to v3.0.0. |
NW.UnivariateForecastingClient (unifor.exe) is the command-line client for the NW.UnivariateForecasting library.
The command-line interface for NW.UnivariateForecastingClient is summarized by the following table:
| Command | Sub Command | Options | Exit Codes |
|---|---|---|---|
| about | Success | ||
| session | Success | ||
| session | forecast | --init:{filename} --folderpath:{path} --savesession --roundingdigits:{number} --forecastingdenominator:{number} |
Success Failure |
The regular font indicates the mandatory options, while the italic font indicates an optional ones.
The exit codes are summarized below:
| Label | Value |
|---|---|
| Success | 0 |
| Failure | 1 |
In this document I'll use Windows as reference OS, but the procedures are exactly the same on both Linux and Mac.
To get started:
- download the application from the Releases page on Github and unzip it;
- open a command prompt, such as Windows Terminal;
- navigate to the application folder;
- familiarize with each
Command,Sub CommandandOptionprovided by the application, such as:
PS C:\unifor>.\unifor.exe
PS C:\unifor>.\unifor.exe session
PS C:\unifor>.\unifor.exe session forecast --help
PS C:\unifor>.\unifor.exe about
The simplest command you can run is session forecast, which performs a forecasting task on the values you provide. At very least, the command will look like:
PS C:\unifor>.\unifor.exe session forecast --init:Init.jsonThe command above requires that you have the required file (Init.json) located in the same folder as the application, which by default it's the working folder for all the application's activities.
The command above will log something like this to the console:
[2023-03-09 10:31:21:013] Attempting to load a 'ForecastingInit' object from: C:\unifor\ForecastingInitBareMinimum.json.
[2023-03-09 10:31:21:105] A 'ForecastingInit' object has been successfully loaded.
[2023-03-09 10:31:21:107] Attempting to perform a forecasting task out of the provided ForecastingInit...
[2023-03-09 10:31:21:107] The provided folder path is: 'C:\unifor'.
[2023-03-09 10:31:21:107] The provided forecasting denominator is: '0.00000000000001'.
[2023-03-09 10:31:21:107] The provided rounding digits are: '2'.
[2023-03-09 10:31:21:108] The provided observation name is: ''.
[2023-03-09 10:31:21:108] The provided values are: '2'.
[2023-03-09 10:31:21:108] The provided coefficient is: 'null'.
[2023-03-09 10:31:21:108] The provided error is: 'null'.
[2023-03-09 10:31:21:108] The provided steps are: '1'.
[2023-03-09 10:31:21:108] Processing step nr.: '1'.
[2023-03-09 10:31:21:109] Creating a SlidingWindow out of the provided arguments...
[2023-03-09 10:31:21:109] The provided steps are: '2'.
[2023-03-09 10:31:21:115] The following SlidingWindow has been created: '[ Items: '2' ]
[ Id: '1', X_Actual: '58.5', Y_Forecasted: '615.26' ]
[ Id: '2', X_Actual: '615.26', Y_Forecasted: 'null' ]'.
[2023-03-09 10:31:21:117] Creating an Observation out of the provided SlidingWindow: '[ Items: '2' ]'...
[2023-03-09 10:31:21:125] The following Observation has been created: '[ Coefficient: '0.1', Error: '0', NextValue: '61.53' ]'.
[2023-03-09 10:31:21:125] The observation's coefficient is: '0.1'.
[2023-03-09 10:31:21:125] The observation's error is: '0'.
[2023-03-09 10:31:21:126] The current observation's next value is: '61.53'.
[2023-03-09 10:31:21:126] The forecasting task has been successfully completed.
[2023-03-09 10:31:21:131] Attempting to save the provided 'ForecastingSession' object as: C:\unifor\unifor_session_20230309113121126.json.
[2023-03-09 10:31:21:156] The provided 'ForecastingSession' object has been successfully saved.
If you wish to store the files elsewhere, you can specify a new working folder by using the folderpath option - i.e. --folderpath:C:\Documents
Suggested toolset to view and edit this Markdown file: