Elbow Helper
API Reference
elbow_helper
Elbow Helper
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
|
W
|
X
|
Y
|
Z
A
Abstain
ALL_CANDIDATES_WEAK (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
all_elbows (elbow_helper.KneeLocator property)
(elbow_helper.locator.KneeLocator property)
all_norm_elbows (elbow_helper.KneeLocator property)
(elbow_helper.locator.KneeLocator property)
B
bic() (in module elbow_helper.numerics)
bic_improvement (elbow_helper.ClearKnee attribute)
,
[1]
(elbow_helper.types.ClearKnee attribute)
,
[1]
(elbow_helper.types.SegmentEvidence attribute)
,
[1]
bootstrap_knee() (in module elbow_helper.bootstrap)
BOOTSTRAP_MULTIMODAL (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
bootstrap_replicates (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
BOOTSTRAP_UNSTABLE (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
BootstrapEvidence (class in elbow_helper.types)
boundaries (elbow_helper.multi_segmentation.Segmentation attribute)
boundary_distance (elbow_helper.types.KneeCandidate attribute)
,
[1]
BOUNDARY_KNEE (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
boundary_margin (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
breakpoints (elbow_helper.multi_segmentation.Segmentation attribute)
build_parser() (in module elbow_helper.cli_argparse)
build_server() (in module elbow_helper.mcp_server)
C
CandidateCluster (class in elbow_helper.types)
ci90 (elbow_helper.ClearKnee attribute)
,
[1]
(elbow_helper.types.BootstrapEvidence attribute)
,
[1]
(elbow_helper.types.ClearKnee attribute)
,
[1]
ci90_width (elbow_helper.types.BootstrapEvidence attribute)
,
[1]
CLEAR_KNEE (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
ClearKnee (class in elbow_helper)
(class in elbow_helper.types)
cluster (elbow_helper.search.SearchResult attribute)
cluster_candidates() (in module elbow_helper.clustering)
cluster_tolerance (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
config_overrides (elbow_helper.api.CurveRequest attribute)
(elbow_helper.api.ElbowRequest attribute)
confirm_segmented_model() (in module elbow_helper.segmented)
consecutive_scales (elbow_helper.types.CandidateCluster attribute)
,
[1]
cost() (elbow_helper.multi_segmentation.SegmentCostTable method)
create_app() (in module elbow_helper.api)
curve (elbow_helper.api.CurveRequest attribute)
(elbow_helper.api.LocatorRequest attribute)
(elbow_helper.types.PreparedCurve attribute)
CurveRequest (class in elbow_helper.api)
cv_folds (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
cv_improvement (elbow_helper.types.SegmentEvidence attribute)
,
[1]
D
denormalize_x() (elbow_helper.types.PreparedCurve method)
detected (elbow_helper.search.SearchResult attribute)
detection_rate (elbow_helper.ClearKnee attribute)
,
[1]
(elbow_helper.types.BootstrapEvidence attribute)
,
[1]
(elbow_helper.types.ClearKnee attribute)
,
[1]
diagnostics (elbow_helper.KneeResult attribute)
(elbow_helper.MultiKneeResult attribute)
(elbow_helper.types.KneeResult attribute)
(elbow_helper.types.MultiKneeResult attribute)
DiagnosticsRequest (class in elbow_helper.api)
direction (elbow_helper.api.CurveRequest attribute)
(elbow_helper.api.LocatorRequest attribute)
(elbow_helper.types.PreparedCurve attribute)
dp_optimal_partition() (in module elbow_helper.multi_segmentation)
E
elbow (elbow_helper.KneeLocator property)
(elbow_helper.locator.KneeLocator property)
elbow_helper
module
elbow_helper.api
module
elbow_helper.bootstrap
module
elbow_helper.candidates
module
elbow_helper.cli_argparse
module
elbow_helper.cli_click
module
elbow_helper.clustering
module
elbow_helper.config
module
elbow_helper.locator
module
elbow_helper.mcp_server
module
elbow_helper.metrics
module
elbow_helper.multi_criteria
module
elbow_helper.multi_fwer
module
elbow_helper.multi_pipeline
module
elbow_helper.multi_segmentation
module
elbow_helper.null_test
module
elbow_helper.numerics
module
elbow_helper.pipeline
module
elbow_helper.plotting
module
elbow_helper.preprocessing
module
elbow_helper.search
module
elbow_helper.segmented
module
elbow_helper.smoothing
module
elbow_helper.types
module
ElbowRequest (class in elbow_helper.api)
evaluate_candidate() (in module elbow_helper.metrics)
F
find_knee() (elbow_helper.KneeLocator method)
(elbow_helper.locator.KneeLocator method)
fit() (elbow_helper.multi_segmentation.SegmentCostTable method)
fwer_alpha (elbow_helper.config.RobustKneesConfig attribute)
(elbow_helper.RobustKneesConfig attribute)
fwer_p_value (elbow_helper.KneeEstimate attribute)
,
[1]
(elbow_helper.types.KneeEstimate attribute)
,
[1]
fwer_permutations (elbow_helper.config.RobustKneesConfig attribute)
(elbow_helper.RobustKneesConfig attribute)
G
generate_candidates() (in module elbow_helper.candidates)
I
INCOMPATIBLE_GLOBAL_SHAPE (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
index (elbow_helper.KneeEstimate attribute)
,
[1]
(elbow_helper.types.KneeEstimate attribute)
,
[1]
inertia (elbow_helper.api.ElbowRequest attribute)
infer_curve_direction() (in module elbow_helper.preprocessing)
INSUFFICIENT_DATA (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
INTERNAL_NUMERICAL_FAILURE (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
INVALID_INPUT (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
InvalidKnees (class in elbow_helper)
(class in elbow_helper.types)
is_clear (elbow_helper.KneeResult property)
(elbow_helper.types.KneeResult property)
is_valid (elbow_helper.MultiKneeResult property)
(elbow_helper.types.MultiKneeResult property)
K
k (elbow_helper.api.ElbowRequest attribute)
(elbow_helper.Knees property)
(elbow_helper.multi_segmentation.Segmentation property)
(elbow_helper.types.Knees property)
k_max (elbow_helper.config.RobustKneesConfig attribute)
(elbow_helper.RobustKneesConfig attribute)
knee_index (elbow_helper.ClearKnee attribute)
,
[1]
(elbow_helper.types.ClearKnee attribute)
,
[1]
(elbow_helper.types.KneeCandidate attribute)
,
[1]
knee_x (elbow_helper.ClearKnee attribute)
,
[1]
(elbow_helper.types.ClearKnee attribute)
,
[1]
knee_x_norm (elbow_helper.ClearKnee attribute)
,
[1]
(elbow_helper.search.SearchResult attribute)
(elbow_helper.types.ClearKnee attribute)
,
[1]
(elbow_helper.types.KneeCandidate attribute)
,
[1]
KneeCandidate (class in elbow_helper.types)
KneeEstimate (class in elbow_helper)
(class in elbow_helper.types)
KneeLocator (class in elbow_helper)
(class in elbow_helper.locator)
KneeResult (class in elbow_helper)
(class in elbow_helper.types)
Knees (class in elbow_helper)
(class in elbow_helper.types)
knees (elbow_helper.Knees attribute)
(elbow_helper.types.BootstrapEvidence attribute)
,
[1]
(elbow_helper.types.Knees attribute)
KNEES_FOUND (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
L
language (elbow_helper.api.DiagnosticsRequest attribute)
local_noise (elbow_helper.types.KneeCandidate attribute)
,
[1]
LocatorRequest (class in elbow_helper.api)
M
m_left (elbow_helper.types.SegmentEvidence attribute)
m_right (elbow_helper.types.SegmentEvidence attribute)
mad (elbow_helper.types.CandidateCluster attribute)
,
[1]
main() (in module elbow_helper.cli_argparse)
(in module elbow_helper.cli_click)
(in module elbow_helper.mcp_server)
max_bootstrap_median_shift (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
max_ci90_width (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
max_cluster_mad (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
max_direction_violation_rate (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
max_neighbor_shift (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
max_null_p_value (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
max_secondary_cluster_rate (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
median_knee (elbow_helper.types.CandidateCluster attribute)
,
[1]
median_noise_prominence_ratio (elbow_helper.types.CandidateCluster attribute)
,
[1]
median_prominence (elbow_helper.types.CandidateCluster attribute)
,
[1]
median_shift (elbow_helper.types.BootstrapEvidence attribute)
,
[1]
members (elbow_helper.types.CandidateCluster attribute)
,
[1]
min_bic_improvement (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
min_bootstrap_detection_rate (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
min_consecutive_scales (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
min_cv_improvement (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
min_dominance_ratio (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
min_noise_prominence_ratio (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
min_primary_cluster_rate (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
min_prominence (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
min_samples (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.config.RobustKneesConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
(elbow_helper.RobustKneesConfig attribute)
min_seg_fraction (elbow_helper.config.RobustKneesConfig attribute)
(elbow_helper.RobustKneesConfig attribute)
min_sensitivity_support (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
min_side_points (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
min_slope_contrast (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
min_spearman_abs (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
model_config (elbow_helper.api.CurveRequest attribute)
(elbow_helper.api.DiagnosticsRequest attribute)
(elbow_helper.api.ElbowRequest attribute)
(elbow_helper.api.LocatorRequest attribute)
modified_bic() (in module elbow_helper.multi_criteria)
module
elbow_helper
elbow_helper.api
elbow_helper.bootstrap
elbow_helper.candidates
elbow_helper.cli_argparse
elbow_helper.cli_click
elbow_helper.clustering
elbow_helper.config
elbow_helper.locator
elbow_helper.mcp_server
elbow_helper.metrics
elbow_helper.multi_criteria
elbow_helper.multi_fwer
elbow_helper.multi_pipeline
elbow_helper.multi_segmentation
elbow_helper.null_test
elbow_helper.numerics
elbow_helper.pipeline
elbow_helper.plotting
elbow_helper.preprocessing
elbow_helper.search
elbow_helper.segmented
elbow_helper.smoothing
elbow_helper.types
MultiKneeResult (class in elbow_helper)
(class in elbow_helper.types)
MULTIPLE_PLAUSIBLE_KNEES (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
N
n (elbow_helper.multi_segmentation.Segmentation attribute)
(elbow_helper.types.PreparedCurve attribute)
,
[1]
n_candidates (elbow_helper.search.SearchResult attribute)
n_filtered (elbow_helper.search.SearchResult attribute)
n_windows (elbow_helper.types.CandidateCluster attribute)
,
[1]
neighbor_shift (elbow_helper.types.CandidateCluster attribute)
,
[1]
NO_KNEE_CANDIDATES (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
no_knee_null_test() (in module elbow_helper.null_test)
NO_PERSISTENT_CLUSTER (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
NoClearKnee (class in elbow_helper)
(class in elbow_helper.types)
noise_prominence_ratio (elbow_helper.types.KneeCandidate attribute)
,
[1]
norm_elbow (elbow_helper.KneeLocator property)
(elbow_helper.locator.KneeLocator property)
NULL_NOT_REJECTED (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
null_p_value (elbow_helper.ClearKnee attribute)
,
[1]
(elbow_helper.types.ClearKnee attribute)
,
[1]
null_replicates (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
(elbow_helper.types.NullEvidence attribute)
,
[1]
NullEvidence (class in elbow_helper.types)
O
observed_statistic (elbow_helper.types.NullEvidence attribute)
,
[1]
ols_rss() (in module elbow_helper.numerics)
online (elbow_helper.api.LocatorRequest attribute)
P
p_value (elbow_helper.types.NullEvidence attribute)
,
[1]
passes (elbow_helper.types.BootstrapEvidence attribute)
,
[1]
(elbow_helper.types.NullEvidence attribute)
,
[1]
(elbow_helper.types.SegmentEvidence attribute)
,
[1]
passes_basic_filters() (in module elbow_helper.metrics)
peak_prominence() (in module elbow_helper.numerics)
persistent (elbow_helper.types.CandidateCluster attribute)
,
[1]
plot_diagnostics() (in module elbow_helper.plotting)
plot_diagnostics_panels() (in module elbow_helper.plotting)
plot_multi_diagnostics() (in module elbow_helper.plotting)
prepare_curve() (in module elbow_helper.preprocessing)
prepare_curve_unconstrained() (in module elbow_helper.preprocessing)
PreparedCurve (class in elbow_helper.types)
primary_cluster_rate (elbow_helper.types.BootstrapEvidence attribute)
,
[1]
prominence (elbow_helper.ClearKnee attribute)
,
[1]
(elbow_helper.types.ClearKnee attribute)
,
[1]
(elbow_helper.types.KneeCandidate attribute)
,
[1]
R
random_seed (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.config.RobustKneesConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
(elbow_helper.RobustKneesConfig attribute)
rankdata() (in module elbow_helper.numerics)
Reason (class in elbow_helper)
(class in elbow_helper.types)
reason (elbow_helper.KneeResult attribute)
(elbow_helper.MultiKneeResult attribute)
(elbow_helper.search.SearchResult attribute)
(elbow_helper.types.BootstrapEvidence attribute)
,
[1]
(elbow_helper.types.KneeResult attribute)
(elbow_helper.types.MultiKneeResult attribute)
(elbow_helper.types.NullEvidence attribute)
,
[1]
(elbow_helper.types.SegmentEvidence attribute)
,
[1]
rejected (elbow_helper.types.KneeCandidate attribute)
,
[1]
render_svg() (in module elbow_helper.plotting)
render_svg_multi() (in module elbow_helper.plotting)
render_svg_panels() (in module elbow_helper.plotting)
require_fwer_confirmation (elbow_helper.config.RobustKneesConfig attribute)
(elbow_helper.RobustKneesConfig attribute)
robust_elbow() (in module elbow_helper)
(in module elbow_helper.pipeline)
robust_knee() (in module elbow_helper)
(in module elbow_helper.pipeline)
robust_knees() (in module elbow_helper)
(in module elbow_helper.multi_pipeline)
robust_sigma_from_diffs() (in module elbow_helper.numerics)
RobustKneeConfig (class in elbow_helper)
(class in elbow_helper.config)
RobustKneesConfig (class in elbow_helper)
(class in elbow_helper.config)
run_search() (in module elbow_helper.search)
S
SearchResult (class in elbow_helper.search)
secondary_cluster_rate (elbow_helper.types.BootstrapEvidence attribute)
,
[1]
secondary_support_frac (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
segment (elbow_helper.search.SearchResult attribute)
segment_lengths (elbow_helper.multi_segmentation.Segmentation property)
Segmentation (class in elbow_helper.multi_segmentation)
SegmentCostTable (class in elbow_helper.multi_segmentation)
SEGMENTED_MODEL_NOT_BETTER (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
SegmentEvidence (class in elbow_helper.types)
select_unique_cluster() (in module elbow_helper.clustering)
sensitivity (elbow_helper.api.LocatorRequest attribute)
(elbow_helper.ClearKnee attribute)
(elbow_helper.types.ClearKnee attribute)
(elbow_helper.types.KneeCandidate attribute)
,
[1]
sensitivity_fractions (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
sensitivity_grid() (in module elbow_helper.candidates)
sensitivity_support (elbow_helper.types.CandidateCluster attribute)
,
[1]
sequential_fwer_gate() (in module elbow_helper.multi_fwer)
slope_contrast (elbow_helper.ClearKnee attribute)
,
[1]
(elbow_helper.types.ClearKnee attribute)
,
[1]
(elbow_helper.types.SegmentEvidence attribute)
,
[1]
slope_left (elbow_helper.KneeEstimate attribute)
(elbow_helper.types.KneeEstimate attribute)
slope_left_window (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
slope_right (elbow_helper.KneeEstimate attribute)
(elbow_helper.types.KneeEstimate attribute)
slope_right_window (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
smooth_curve() (in module elbow_helper.smoothing)
smoothing_fractions (elbow_helper.config.RobustKneeConfig attribute)
(elbow_helper.RobustKneeConfig attribute)
smoothing_grid() (in module elbow_helper.smoothing)
smoothing_window (elbow_helper.ClearKnee attribute)
(elbow_helper.types.ClearKnee attribute)
spearman (elbow_helper.types.PreparedCurve attribute)
,
[1]
spearman() (in module elbow_helper.numerics)
sse (elbow_helper.multi_segmentation.Segmentation attribute)
stable_window (elbow_helper.types.CandidateCluster attribute)
,
[1]
statistic (elbow_helper.search.SearchResult attribute)
support (elbow_helper.types.CandidateCluster attribute)
,
[1]
support_frac (elbow_helper.types.CandidateCluster attribute)
,
[1]
T
theil_sen_slope() (in module elbow_helper.numerics)
transform_y() (elbow_helper.KneeLocator static method)
(elbow_helper.locator.KneeLocator static method)
V
violation_rate (elbow_helper.types.PreparedCurve attribute)
,
[1]
W
WEAK_SLOPE_CHANGE (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)
window (elbow_helper.search.SearchResult attribute)
(elbow_helper.types.KneeCandidate attribute)
,
[1]
with_() (elbow_helper.config.RobustKneeConfig method)
(elbow_helper.config.RobustKneesConfig method)
(elbow_helper.RobustKneeConfig method)
(elbow_helper.RobustKneesConfig method)
X
x (elbow_helper.api.CurveRequest attribute)
(elbow_helper.api.LocatorRequest attribute)
(elbow_helper.KneeEstimate attribute)
,
[1]
(elbow_helper.types.KneeEstimate attribute)
,
[1]
x_hi (elbow_helper.types.PreparedCurve attribute)
x_lo (elbow_helper.types.PreparedCurve attribute)
x_norm (elbow_helper.KneeEstimate attribute)
,
[1]
(elbow_helper.types.KneeEstimate attribute)
,
[1]
(elbow_helper.types.PreparedCurve attribute)
Y
y (elbow_helper.api.CurveRequest attribute)
(elbow_helper.api.LocatorRequest attribute)
y_hi (elbow_helper.types.PreparedCurve attribute)
y_lo (elbow_helper.types.PreparedCurve attribute)
y_scaled (elbow_helper.types.PreparedCurve attribute)
Z
ZERO_RANGE (elbow_helper.Reason attribute)
(elbow_helper.types.Reason attribute)