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

index c54a82daeca80126f2aded628c4a8a02b7a06e21..d2b5f806f1d59da6912677c9e7997c283bfef862 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.robust_quantiles            | [0.25, 0.75]      | tuple[float, float] where 0 <= q_low < q_high <= 1                                                                               | Quantile range for robust normalization (IQR-based scaling).                                                                                                                                               |
-| freqai.extrema_weighting.rank_method                 | `average`         | enum {`average`,`min`,`max`,`dense`,`ordinal`}                                                                                   | Ranking method for rank normalization (how tied values are handled).                                                                                                                                       |
+| 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_                                 |                   |                                                                                                                                  |                                                                                                                                                                                                            |
 | freqai.feature_parameters.label_period_candles       | min/max midpoint  | int >= 1                                                                                                                         | Zigzag labeling NATR horizon.                                                                                                                                                                              |
 | freqai.feature_parameters.min_label_period_candles   | 12                | int >= 1                                                                                                                         | Minimum labeling NATR horizon used for reversals labeling HPO.                                                                                                                                             |