Skip to content

Commit 22554b1

Browse files
committed
Hide advanced sorting configuration options from help
Simplifies the user interface by hiding detailed sorting config options. Users only see --no-sort as the main control, but advanced options remain functional if you know about them. Hidden from help (but still work): - --skip-sgd, --skip-groom, --skip-topo - --sgd-iter-max, --sgd-eta-max - --sgd-theta, --sgd-eps, --sgd-cooling-start Visible: - --no-sort (simple on/off for all sorting) This keeps the interface clean for most users while preserving advanced configuration for developers and power users.
1 parent c785c34 commit 22554b1

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/seqrush.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -87,35 +87,35 @@ pub struct Args {
8787
pub no_sort: bool,
8888

8989
/// Skip the path-guided SGD phase (Y) of the Ygs pipeline
90-
#[arg(long = "skip-sgd", default_value = "false")]
90+
#[arg(long = "skip-sgd", default_value = "false", hide = true)]
9191
pub skip_sgd: bool,
9292

9393
/// Skip the grooming phase (g) of the Ygs pipeline
94-
#[arg(long = "skip-groom", default_value = "false")]
94+
#[arg(long = "skip-groom", default_value = "false", hide = true)]
9595
pub skip_groom: bool,
9696

9797
/// Skip the topological sort phase (s) of the Ygs pipeline
98-
#[arg(long = "skip-topo", default_value = "false")]
98+
#[arg(long = "skip-topo", default_value = "false", hide = true)]
9999
pub skip_topo: bool,
100100

101101
/// Number of SGD iterations (default: 100, matching ODGI)
102-
#[arg(long = "sgd-iter-max", default_value = "100")]
102+
#[arg(long = "sgd-iter-max", default_value = "100", hide = true)]
103103
pub sgd_iter_max: u64,
104104

105105
/// SGD learning rate parameter eta_max (default: calculated from graph)
106-
#[arg(long = "sgd-eta-max")]
106+
#[arg(long = "sgd-eta-max", hide = true)]
107107
pub sgd_eta_max: Option<f64>,
108108

109109
/// SGD cooling/momentum parameter theta (default: 0.99)
110-
#[arg(long = "sgd-theta", default_value = "0.99")]
110+
#[arg(long = "sgd-theta", default_value = "0.99", hide = true)]
111111
pub sgd_theta: f64,
112112

113113
/// SGD convergence parameter eps (default: 0.01)
114-
#[arg(long = "sgd-eps", default_value = "0.01")]
114+
#[arg(long = "sgd-eps", default_value = "0.01", hide = true)]
115115
pub sgd_eps: f64,
116116

117117
/// SGD cooling start (default: 0.5)
118-
#[arg(long = "sgd-cooling-start", default_value = "0.5")]
118+
#[arg(long = "sgd-cooling-start", default_value = "0.5", hide = true)]
119119
pub sgd_cooling_start: f64,
120120

121121
/// [DEPRECATED] Use sort-groom-sort strategy (use --skip-* flags instead)

0 commit comments

Comments
 (0)