]> Piment Noir Git Repositories - freqai-strategies.git/commitdiff
docs: refine README.md description of extrema selection methods
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Sat, 13 Dec 2025 02:32:59 +0000 (03:32 +0100)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Sat, 13 Dec 2025 02:32:59 +0000 (03:32 +0100)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
README.md

index 5db40ad9bedd55980d3100a1918fe9a72bbd921f..3855def9bffc0f0403dbdd53ccb6dfb3b67bb206 100644 (file)
--- a/README.md
+++ b/README.md
@@ -95,7 +95,7 @@ docker compose up -d --build
 | freqai.feature_parameters.label_knn_p_order          | `None`                    | float \| None                                                                                                                    | Tunable for KNN neighbor distances aggregation methods: p-order (`knn_power_mean`, default: 1.0) or quantile (`knn_quantile`, default: 0.5). (optional)                                                                                                                                           |
 | freqai.feature_parameters.label_knn_n_neighbors      | 5                         | int >= 1                                                                                                                         | Number of neighbors for KNN.                                                                                                                                                                                                                                                                      |
 | _Predictions extrema_                                |                           |                                                                                                                                  |                                                                                                                                                                                                                                                                                                   |
-| freqai.predictions_extrema.selection_method          | `rank`                    | enum {`rank`,`values`,`partition`}                                                                                               | Extrema selection method. `values` uses reversal values, `rank` uses ranked extrema values, `partition` uses sign-based partitioning.                                                                                                                                                             |
+| freqai.predictions_extrema.selection_method          | `rank`                    | enum {`rank`,`values`,`partition`}                                                                                               | Extrema selection method. `rank` uses ranked extrema values, `values` uses reversal values, `partition` uses sign-based partitioning.                                                                                                                                                             |
 | freqai.predictions_extrema.thresholds_smoothing      | `mean`                    | enum {`mean`,`isodata`,`li`,`minimum`,`otsu`,`triangle`,`yen`,`median`,`soft_extremum`}                                          | Thresholding method for prediction thresholds smoothing.                                                                                                                                                                                                                                          |
 | freqai.predictions_extrema.thresholds_alpha          | 12.0                      | float > 0                                                                                                                        | Alpha for `soft_extremum`.                                                                                                                                                                                                                                                                        |
 | freqai.predictions_extrema.threshold_outlier         | 0.999                     | float (0,1)                                                                                                                      | Quantile threshold for predictions outlier filtering.                                                                                                                                                                                                                                             |