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

index 9cac5411bc099df15b0079ce9d30739755618f6e..c776e741da0f42a7c553de094d88e215b6032696 100644 (file)
--- a/README.md
+++ b/README.md
@@ -41,14 +41,14 @@ docker compose up -d --build
 | ---------------------------------------------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | _Protections_                                        |                           |                                                                                                                                  |                                                                                                                                                                                                                                                                                                   |
 | custom_protections.trade_duration_candles            | 72                        | int >= 1                                                                                                                         | Estimated trade duration in candles. Scales protections stop duration candles and trade limit.                                                                                                                                                                                                    |
-| custom_protections.lookback_period_fraction          | 0.5                       | float (0,1]                                                                                                                      | Fraction of fit_live_predictions_candles used to calculate lookback_period_candles for MaxDrawdown and StoplossGuard protections.                                                                                                                                                                 |
-| custom_protections.cooldown.enabled                  | true                      | bool                                                                                                                             | Enable/disable CooldownPeriod protection.                                                                                                                                                                                                                                                         |
+| custom_protections.lookback_period_fraction          | 0.5                       | float (0,1]                                                                                                                      | Fraction of `fit_live_predictions_candles` used to calculate `lookback_period_candles` for _MaxDrawdown_ and _StoplossGuard_ protections.                                                                                                                                                         |
+| custom_protections.cooldown.enabled                  | true                      | bool                                                                                                                             | Enable/disable _CooldownPeriod_ protection.                                                                                                                                                                                                                                                       |
 | custom_protections.cooldown.stop_duration_candles    | 4                         | int >= 1                                                                                                                         | Number of candles to wait before allowing new trades after a trade is closed.                                                                                                                                                                                                                     |
-| custom_protections.drawdown.enabled                  | true                      | bool                                                                                                                             | Enable/disable MaxDrawdown protection.                                                                                                                                                                                                                                                            |
+| custom_protections.drawdown.enabled                  | true                      | bool                                                                                                                             | Enable/disable _MaxDrawdown_ protection.                                                                                                                                                                                                                                                          |
 | custom_protections.drawdown.max_allowed_drawdown     | 0.2                       | float (0,1)                                                                                                                      | Maximum allowed drawdown.                                                                                                                                                                                                                                                                         |
-| custom_protections.stoploss.enabled                  | true                      | bool                                                                                                                             | Enable/disable StoplossGuard protection.                                                                                                                                                                                                                                                          |
+| custom_protections.stoploss.enabled                  | true                      | bool                                                                                                                             | Enable/disable _StoplossGuard_ protection.                                                                                                                                                                                                                                                        |
 | _Leverage_                                           |                           |                                                                                                                                  |                                                                                                                                                                                                                                                                                                   |
-| leverage                                             | proposed_leverage         | float [1.0, max_leverage]                                                                                                        | Leverage. Fallback to proposed_leverage for the pair.                                                                                                                                                                                                                                             |
+| leverage                                             | `proposed_leverage`       | float [1.0, max_leverage]                                                                                                        | Leverage. Fallback to `proposed_leverage` for the pair.                                                                                                                                                                                                                                           |
 | _Exit pricing_                                       |                           |                                                                                                                                  |                                                                                                                                                                                                                                                                                                   |
 | exit_pricing.trade_price_target                      | `moving_average`          | enum {`moving_average`,`interpolation`,`weighted_interpolation`}                                                                 | Trade NATR computation method.                                                                                                                                                                                                                                                                    |
 | exit_pricing.thresholds_calibration.decline_quantile | 0.90                      | float (0,1)                                                                                                                      | PnL decline quantile threshold.                                                                                                                                                                                                                                                                   |