]> Piment Noir Git Repositories - freqai-strategies.git/commitdiff
docs: refine README.md
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Fri, 21 Nov 2025 17:00:10 +0000 (18:00 +0100)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Fri, 21 Nov 2025 17:00:10 +0000 (18:00 +0100)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
README.md

index f124648e4a8ab46538d9e18cfb812a25f6386e56..1a19d8a2fea1ed599b8f077d300ef5f2833ff8ea 100644 (file)
--- a/README.md
+++ b/README.md
@@ -60,8 +60,8 @@ docker compose up -d --build
 | freqai.extrema_weighting.normalization               | `minmax`          | enum {`minmax`,`zscore`,`l1`,`l2`,`robust`,`softmax`,`tanh`,`rank`,`none`}                                                       | Normalization method for weights.                                                                                                                                                                          |
 | freqai.extrema_weighting.gamma                       | 1.0               | float (0,10]                                                                                                                     | Contrast exponent applied after normalization (>1 emphasizes extremes, 0<gamma<1 softens).                                                                                                                 |
 | freqai.extrema_weighting.softmax_temperature         | 1.0               | float > 0                                                                                                                        | Temperature parameter for softmax normalization (lower values sharpen distribution, higher values flatten it).                                                                                             |
-| freqai.extrema_weighting.tanh_scale                  | 1.0               | float > 0                                                                                                                        | Scale parameter for tanh normalization applied to z-scores before tanh transformation (higher values make tanh steeper, lower values make it gentler).                                                     |
-| freqai.extrema_weighting.tanh_gain                   | 0.5               | float > 0                                                                                                                        | Gain parameter for tanh normalization that replaces the default 0.5 scaling factor (controls output range after tanh transformation).                                                                      |
+| freqai.extrema_weighting.tanh_scale                  | 1.0               | float > 0                                                                                                                        | Scale parameter for tanh normalization.                                                                                                                                                                    |
+| freqai.extrema_weighting.tanh_gain                   | 0.5               | float > 0                                                                                                                        | Gain parameter for tanh normalization.                                                                                                                                                                     |
 | freqai.extrema_weighting.robust_quantiles            | [0.25, 0.75]      | list[float] where 0 <= q_low < q_high <= 1                                                                                       | Quantile range for robust normalization.                                                                                                                                                                   |
 | freqai.extrema_weighting.rank_method                 | `average`         | enum {`average`,`min`,`max`,`dense`,`ordinal`}                                                                                   | Ranking method for rank normalization.                                                                                                                                                                     |
 | _Feature parameters_                                 |                   |                                                                                                                                  |                                                                                                                                                                                                            |