Skip to content

Commit c71c0e8

Browse files
committed
Fix some typos
1 parent f8331e0 commit c71c0e8

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

docs/freqai-configuration.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -204,26 +204,26 @@ If this value is set, FreqAI will initially use the predictions from the trainin
204204

205205
## Using different prediction models
206206

207-
FreqAI has multiple example prediction model libraries that are ready to be used as is via the flag `--freqaimodel`. These libraries include `CatBoost`, `LightGBM`, and `XGBoost` regression, classification, and multi-target models, and can be found in `freqai/prediction_models/`.
207+
FreqAI has multiple example prediction model libraries that are ready to be used as is via the flag `--freqaimodel`. These libraries include `CatBoost`, `LightGBM`, and `XGBoost` regression, classification, and multi-target models, and can be found in `freqai/prediction_models/`.
208208

209-
Regression and classification models differ in what targets they predict - a regression model will predict a target of continous values, for example what price BTC will be at tomorrow, whilst a classifier will predict a target of descrete values, for example if the price of BTC will go up tomorrow or not. This means that you have to specify your targets differently depending on which model type you are using (see details [below](#setting-model-targets)).
209+
Regression and classification models differ in what targets they predict - a regression model will predict a target of continuous values, for example what price BTC will be at tomorrow, whilst a classifier will predict a target of discrete values, for example if the price of BTC will go up tomorrow or not. This means that you have to specify your targets differently depending on which model type you are using (see details [below](#setting-model-targets)).
210210

211-
All of the aforementioned model libraries implement gradient boosted decision tree algorithms. They all work on the principle of emsemble learning, where predictions from multiple simple learners are combined to get a final prediction that is more stable and generalized. The simple learners in this case are decision trees. Gradient boosting refers to the method of learning, where each simple learner is built in sequence - the subsequent learner is used to improve on the error from the previous learner. If you want to learn more about the different model libraries you can find the information in their respective docs:
211+
All of the aforementioned model libraries implement gradient boosted decision tree algorithms. They all work on the principle of ensemble learning, where predictions from multiple simple learners are combined to get a final prediction that is more stable and generalized. The simple learners in this case are decision trees. Gradient boosting refers to the method of learning, where each simple learner is built in sequence - the subsequent learner is used to improve on the error from the previous learner. If you want to learn more about the different model libraries you can find the information in their respective docs:
212212

213213
* CatBoost: https://catboost.ai/en/docs/
214214
* LightGBM: https://lightgbm.readthedocs.io/en/v3.3.2/#
215215
* XGBoost: https://xgboost.readthedocs.io/en/stable/#
216216

217217
There are also numerous online articles describing and comparing the algorithms. Some relatively light-weight examples would be [CatBoost vs. LightGBM vs. XGBoost — Which is the best algorithm?](https://towardsdatascience.com/catboost-vs-lightgbm-vs-xgboost-c80f40662924#:~:text=In%20CatBoost%2C%20symmetric%20trees%2C%20or,the%20same%20depth%20can%20differ.) and [XGBoost, LightGBM or CatBoost — which boosting algorithm should I use?](https://medium.com/riskified-technology/xgboost-lightgbm-or-catboost-which-boosting-algorithm-should-i-use-e7fda7bb36bc). Keep in mind that the performance of each model is highly dependent on the application and so any reported metrics might not be true for your particular use of the model.
218218

219-
Apart from the models already vailable in FreqAI, it is also possible to customize and create your own prediction models using the `IFreqaiModel` class. You are encouraged to inherit `fit()`, `train()`, and `predict()` to let these customize various aspects of the training procedures. You can place custom FreqAI models in `user_data/freqaimodels` - and freqtrade will pick them up from there based on the provided `--freqaimodel` name - which has to correspond to the class name of your custom model.
219+
Apart from the models already available in FreqAI, it is also possible to customize and create your own prediction models using the `IFreqaiModel` class. You are encouraged to inherit `fit()`, `train()`, and `predict()` to customize various aspects of the training procedures. You can place custom FreqAI models in `user_data/freqaimodels` - and freqtrade will pick them up from there based on the provided `--freqaimodel` name - which has to correspond to the class name of your custom model.
220220
Make sure to use unique names to avoid overriding built-in models.
221221

222222
### Setting model targets
223223

224224
#### Regressors
225225

226-
If you are using a regressor, you need to specify a target that has continous values. FreqAI includes a variety of regressors, such as the `CatboostRegressor`via the flag `--freqaimodel CatboostRegressor`. An example of how you could set a regression target for predicting the price 100 candles into the future would be
226+
If you are using a regressor, you need to specify a target that has continuous values. FreqAI includes a variety of regressors, such as the `CatboostRegressor`via the flag `--freqaimodel CatboostRegressor`. An example of how you could set a regression target for predicting the price 100 candles into the future would be
227227

228228
```python
229229
df['&s-close_price'] = df['close'].shift(-100)
@@ -233,15 +233,14 @@ If you want to predict multiple targets, you need to define multiple labels usin
233233

234234
#### Classifiers
235235

236-
If you are using a classifier, you need to specify a target that has descrete values. FreqAI includes a variety of classifiers, such as the `CatboostClassifier` via the flag `--freqaimodel CatboostClassifier`. If you elects to use a classifier, the classes need to be set using strings. For example, if you want to predict if the price 100 candles into the future goes up or down you would set
236+
If you are using a classifier, you need to specify a target that has discrete values. FreqAI includes a variety of classifiers, such as the `CatboostClassifier` via the flag `--freqaimodel CatboostClassifier`. If you elects to use a classifier, the classes need to be set using strings. For example, if you want to predict if the price 100 candles into the future goes up or down you would set
237237

238238
```python
239239
df['&s-up_or_down'] = np.where( df["close"].shift(-100) > df["close"], 'up', 'down')
240240
```
241241

242242
If you want to predict multiple targets you must specify all labels in the same label column. You could, for example, add the label `same` to define where the price was unchanged by setting
243243

244-
245244
```python
246245
df['&s-up_or_down'] = np.where( df["close"].shift(-100) > df["close"], 'up', 'down')
247246
df['&s-up_or_down'] = np.where( df["close"].shift(-100) == df["close"], 'same', df['&s-up_or_down'])

docs/freqai-running.md

-1
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,6 @@ where `unique-id` is the `identifier` set in the `freqai` configuration file. Th
155155

156156
![tensorboard](assets/tensorboard.jpg)
157157

158-
159158
## Setting up a follower
160159

161160
You can indicate to the bot that it should not train models, but instead should look for models trained by a leader with a specific `identifier` by defining:

0 commit comments

Comments
 (0)