mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 12:40:35 +00:00
Update prediction README with up to regression section
This commit is contained in:
@@ -29,27 +29,66 @@ This menu aims to predict the share price of a pre-loaded stock, and the usage o
|
||||
|
||||
|
||||
## sma <a name="sma"></a>
|
||||
```
|
||||
usage: simple_moving_average [-l N_LENGTH] [-d N_DAYS]
|
||||
```
|
||||
* -l : length of SMA window. Default 20.
|
||||
* -d : prediciton days. Default 5.
|
||||
|
||||

|
||||
|
||||
## knn <a name="knn"></a>
|
||||
```
|
||||
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.
|
||||
|
||||

|
||||
|
||||
## linear <a name="linear"></a>
|
||||
|
||||
```
|
||||
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.
|
||||
|
||||

|
||||
|
||||
## quadratic <a name="quadratic"></a>
|
||||
```
|
||||
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.
|
||||
|
||||

|
||||
|
||||
## cubic <a name="cubic"></a>
|
||||
```
|
||||
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.
|
||||
|
||||

|
||||
|
||||
## regression <a name="regression"></a>
|
||||
```
|
||||
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.
|
||||
|
||||

|
||||
|
||||
|
||||
Reference in New Issue
Block a user