adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update freqai-spice-rack.md

Browse Source 
Instructs newer users to place the code calling spice_rack in populate_indicators
This commit is contained in:
smarmau
2022-10-10 11:59:43 +11:00
committed by GitHub
parent 7cdd510cf9
commit 011759d1b7
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/freqai-spice-rack.md
View File

@@ -10,7 +10,7 @@ The `spice_rack` is aimed at users who do not wish to deal with setting up `Freq
"freqai_identifier": "spicey-id", "freqai_identifier": "spicey-id",
``` ```
Which tells `FreqAI` to set up a pre-set `FreqAI` instance automatically under the hood with preset parameters. Now the user can access a suite of custom `FreqAI` supercharged indicators inside their strategy: Which tells `FreqAI` to set up a pre-set `FreqAI` instance automatically under the hood with preset parameters. Now the user can access a suite of custom `FreqAI` supercharged indicators inside their strategy by placing the following code into `populate_indicators`:
```python ```python
dataframe['dissimilarity_index'] = self.freqai.spice_rack( dataframe['dissimilarity_index'] = self.freqai.spice_rack(
@@ -68,4 +68,4 @@ Users can then use these columns in concert with all their own additional indica
| Parameter | Description | | Parameter | Description |
|------------|-------------| |------------|-------------|
| `DI_values` | **Required.** <br> The dissimilarity index of the current candle to the recent candles. More information available [here](freqai-feature-engineering.md#identifying-outliers-with-the-dissimilarity-index-di) <br> **Datatype:** Floats. | `DI_values` | **Required.** <br> The dissimilarity index of the current candle to the recent candles. More information available [here](freqai-feature-engineering.md#identifying-outliers-with-the-dissimilarity-index-di) <br> **Datatype:** Floats.
| `extrema` | **Required.** <br> A continuous prediction from FreqAI which aims to help predict if the current candle is a maxima or a minma. FreqAI aims for 1 to be a maxima and -1 to be a minima - but the values should typically hover between -0.2 and 0.2. <br> **Datatype:** Floats. | `extrema` | **Required.** <br> A continuous prediction from FreqAI which aims to help predict if the current candle is a maxima or a minma. FreqAI aims for 1 to be a maxima and -1 to be a minima - but the values should typically hover between -0.2 and 0.2. <br> **Datatype:** Floats.