Skip to content

Diagnostic Beeswarm Analysis

Prepare bounded parameter samples for optimization-diagnostic beeswarm plots.

Request: FFieldOptimizationDiagnosticBeeswarmRequest

Configure bounded diagnostic sample preparation.

Fields

Field Type Default Help Choices
sort_by str parameter Sort parameter rows by numeric pointer, final value, or starting value. parameter, final, starting
global_objective_scale bool False Use one objective-function color range for every parameter row. True, False
top int 0 Keep the parameters with the widest objective ranges; zero keeps all.

Task: FFieldOptimizationDiagnosticBeeswarmTask

Prepare the bounded samples used by the diagnostic beeswarm renderer.

Method: run(data: ForceFieldOptimizationDiagnosticPlotData, request: FFieldOptimizationDiagnosticBeeswarmRequest, reporter=None)

Build plot-ready sample and parameter tables from typed inputs.

Result: FFieldOptimizationDiagnosticBeeswarmResult

Normalized diagnostic sample rows and parameter-level plot metadata.

Fields

Field Type Default Help Choices
table pd.DataFrame
parameters pd.DataFrame
excluded_parameters int
request FFieldOptimizationDiagnosticBeeswarmRequest