multi: mark bimodal estimator experimental

This commit is contained in:
bitromortac 2023-03-22 16:39:15 +01:00
parent 170677be2b
commit a3e46dae9f
No known key found for this signature in database
GPG key ID: 1965063FC13BEBE2
5 changed files with 7 additions and 5 deletions

View file

@ -65,7 +65,8 @@ var setCfgCommand = cli.Command{
cli.StringFlag{
Name: "estimator",
Usage: "the probability estimator to use, choose " +
"between 'apriori' or 'bimodal'",
"between 'apriori' or 'bimodal' (bimodal is " +
"experimental)",
},
// Apriori config.
cli.DurationFlag{

View file

@ -1667,7 +1667,7 @@ type MissionControlConfig struct {
// before we raise the failure amount.
MinimumFailureRelaxInterval uint64 `protobuf:"varint,5,opt,name=minimum_failure_relax_interval,json=minimumFailureRelaxInterval,proto3" json:"minimum_failure_relax_interval,omitempty"`
// ProbabilityModel defines which probability estimator should be used in
// pathfinding.
// pathfinding. Note that the bimodal estimator is experimental.
Model MissionControlConfig_ProbabilityModel `protobuf:"varint,6,opt,name=model,proto3,enum=routerrpc.MissionControlConfig_ProbabilityModel" json:"model,omitempty"`
// EstimatorConfig is populated dependent on the estimator type.
//

View file

@ -513,7 +513,7 @@ message MissionControlConfig {
/*
ProbabilityModel defines which probability estimator should be used in
pathfinding.
pathfinding. Note that the bimodal estimator is experimental.
*/
ProbabilityModel model = 6;

View file

@ -1477,7 +1477,7 @@
},
"model": {
"$ref": "#/definitions/MissionControlConfigProbabilityModel",
"description": "ProbabilityModel defines which probability estimator should be used in\npathfinding."
"description": "ProbabilityModel defines which probability estimator should be used in\npathfinding. Note that the bimodal estimator is experimental."
},
"apriori": {
"$ref": "#/definitions/routerrpcAprioriParameters"

View file

@ -1106,6 +1106,7 @@ litecoin.node=ltcd
[routerrpc]
; Probability estimator used for pathfinding. (default: apriori)
; Note that the bimodal estimator is experimental.
; routerrpc.estimator=[apriori|bimodal]
; Minimum required route success probability to attempt the payment (default:
@ -1156,7 +1157,7 @@ litecoin.node=ltcd
; Defines how strongly non-routed channels of forwarders should be taken into
; account for probability estimation. A weight of zero disables this feature.
; Valid values are in [0, 1]. (default: 0.2)
; routerrpc.bimodal.nodeweight=0.3
; routerrpc.bimodal.nodeweight=0.1
; Defines the information decay of knowledge about previous successes and
; failures in channels. (default: 168h0m0s)