diff --git a/prediction_techniques/README.md b/prediction_techniques/README.md index 925fc8d6d91..ddad0db91fd 100644 --- a/prediction_techniques/README.md +++ b/prediction_techniques/README.md @@ -29,27 +29,66 @@ This menu aims to predict the share price of a pre-loaded stock, and the usage o ## sma +``` +usage: simple_moving_average [-l N_LENGTH] [-d N_DAYS] +``` + * -l : length of SMA window. Default 20. + * -d : prediciton days. Default 5. ![sma](https://user-images.githubusercontent.com/25267873/108604945-d29aea80-73a8-11eb-8dac-6a545b9c52b9.png) ## knn +``` +usage: knn [-i N_INPUTS] [-d N_DAYS] [-j N_JUMPS] [-n N_NEIGHBORS] +``` + * -i : number of days to use for prediction. Default 40. + * -d : prediciton days. Default 5. + * -j : number of jumps in training data. Default 1. + * -n : number of neighbors to use on the algorithm. Default 20. ![knn](https://user-images.githubusercontent.com/25267873/108604942-d169bd80-73a8-11eb-9021-6f787cbd41e3.png) ## linear - +``` +usage: linear [-i N_INPUTS] [-d N_DAYS] [-j N_JUMPS] +usage: regression -p 1 [-i N_INPUTS] [-d N_DAYS] [-j N_JUMPS] +``` + * -i : number of days to use for prediction. Default 40. + * -d : prediciton days. Default 5. + * -j : number of jumps in training data. Default 1. ![linear](https://user-images.githubusercontent.com/25267873/108604948-d3cc1780-73a8-11eb-860f-49274a34038b.png) ## quadratic +``` +usage: quadratic [-i N_INPUTS] [-d N_DAYS] [-j N_JUMPS] +usage: regression -p 2 [-i N_INPUTS] [-d N_DAYS] [-j N_JUMPS] +``` + * -i : number of days to use for prediction. Default 40. + * -d : prediciton days. Default 5. + * -j : number of jumps in training data. Default 1. ![quadratic](https://user-images.githubusercontent.com/25267873/108604935-cca50980-73a8-11eb-9af1-bba807203cc6.png) ## cubic +``` +usage: cubic [-i N_INPUTS] [-d N_DAYS] [-j N_JUMPS] +usage: regression -p 3 [-i N_INPUTS] [-d N_DAYS] [-j N_JUMPS] +``` + * -i : number of days to use for prediction. Default 40. + * -d : prediciton days. Default 5. + * -j : number of jumps in training data. Default 1. ![cubic](https://user-images.githubusercontent.com/25267873/108604941-d169bd80-73a8-11eb-9220-84a7013e1283.png) ## regression +``` +usage: regression -p N_POLYNOMIAL [-i N_INPUTS] [-d N_DAYS] [-j N_JUMPS] +``` + * -i : number of days to use for prediction. Default 40. + * -d : prediciton days. Default 5. + * -j : number of jumps in training data. Default 1. + * -p : polynomial associated with regression. Required. ![regression](https://user-images.githubusercontent.com/25267873/108604946-d3338100-73a8-11eb-9e99-fa526fb56672.png)