From 5404905d2828d814def95353b258cef389448655 Mon Sep 17 00:00:00 2001 From: Matthias Date: Sat, 8 Apr 2023 17:13:51 +0200 Subject: [PATCH] Fix typos in docs --- docs/freqai-parameter-table.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/freqai-parameter-table.md b/docs/freqai-parameter-table.md index 6c95892d4..9ed3d6dce 100644 --- a/docs/freqai-parameter-table.md +++ b/docs/freqai-parameter-table.md @@ -88,19 +88,20 @@ Mandatory parameters are marked as **Required** and have to be set in one of the ### PyTorch parameters -#### general: +#### general | Parameter | Description | |------------|-------------| -| | **Model training parameters within the freqai.model_training_parameters sub dictionary** -| `learning_rate` | learning rate to be passed to the optimizer.
**Datatype:** float.
Default: `3e-4`. -| `model_kwargs` | paramters to be passed to the model class.
**Datatype:** dict.
Default: `{}`. -| `trainer_kwargs` | paramters to be passed to the trainer class.
**Datatype:** dict.
Default: `{}`. +| | **Model training parameters within the `freqai.model_training_parameters` sub dictionary** +| `learning_rate` | Learning rate to be passed to the optimizer.
**Datatype:** float.
Default: `3e-4`. +| `model_kwargs` | Parameters to be passed to the model class.
**Datatype:** dict.
Default: `{}`. +| `trainer_kwargs` | Parameters to be passed to the trainer class.
**Datatype:** dict.
Default: `{}`. -#### trainer_kwargs: +#### trainer_kwargs | Parameter | Description | |------------|-------------| +| | **Model training parameters within the `freqai.model_training_parameters.model_kwargs` sub dictionary** | `max_iters` | The number of training iterations to run. iteration here refers to the number of times we call self.optimizer.step(). used to calculate n_epochs.
**Datatype:** int.
Default: `100`. | `batch_size` | The size of the batches to use during training..
**Datatype:** int.
Default: `64`. | `max_n_eval_batches` | The maximum number batches to use for evaluation..
**Datatype:** int, optional.
Default: `None`.