Trial: builders

NumericFilterBuilder

Inert specification for one numeric subsampling filter.

Returned by: ScalarTrialDescriptor.eq, ScalarTrialDescriptor.gt, ScalarTrialDescriptor.gte, ScalarTrialDescriptor.lt, ScalarTrialDescriptor.lte, ScalarTrialDescriptor.neq

Member	Kind	Description
descriptor_id	attribute
operator	attribute
value	attribute
arm	attribute
is_active	attribute
to_payload	method	Return the public snake_case payload for this filter.
to_condition	method	Return the camelCase result-query condition for this filter.

descriptor_id

Type: str

operator

Type: NumericFilterOperator

value

Type: float

arm

Type: str | None

is_active

Type: bool

to_payload

to_payload() -> dict[str, object]

Return the public snake_case payload for this filter.

to_condition

to_condition() -> dict[str, object]

Return the camelCase result-query condition for this filter.

CategoricalFilterBuilder

Inert specification for one categorical subsampling filter.

Returned by: CategoricalTrialDescriptor.in_levels

Member	Kind	Description
descriptor_id	attribute
levels	attribute
arm	attribute
is_active	attribute
to_payload	method	Return the public snake_case payload for this filter.
to_condition	method	Return the camelCase result-query condition for this filter.

descriptor_id

Type: str

levels

Type: tuple[str, ...]

arm

Type: str | None

is_active

Type: bool

to_payload

to_payload() -> dict[str, object]

Return the public snake_case payload for this filter.

to_condition

to_condition() -> dict[str, object]

Return the camelCase result-query condition for this filter.

MarginalBuilder

Inert specification for one scalar target distribution.

Returned by: ScalarTrialDescriptor.log_normal, ScalarTrialDescriptor.mixture, ScalarTrialDescriptor.normal, ScalarTrialDescriptor.normal_truncated, ScalarTrialDescriptor.uniform, ScalarTrialDescriptor.weibull

Member	Kind	Description
descriptor_id	attribute
distribution	attribute
arm	attribute
subject_to	attribute
is_active	attribute
weight	attribute
reference	attribute
to_payload	method	Return the public snake_case payload for this marginal.

descriptor_id

Type: str

distribution

Type: MarginalDistribution

arm

Type: str | None

subject_to

Type: tuple[SubjectToBuilder, ...]

is_active

Type: bool

weight

Type: float | None

reference

Type: str | None

to_payload

to_payload() -> dict[str, object]

Return the public snake_case payload for this marginal.

CategoricalTargetBuilder

Inert specification for one categorical target distribution.

Returned by: CategoricalTrialDescriptor.categorical

Member	Kind	Description
descriptor_id	attribute
category_weights	attribute
arm	attribute
subject_to	attribute
is_active	attribute
weight	attribute
reference	attribute
to_payload	method	Return the public snake_case payload for this categorical target.

descriptor_id

Type: str

category_weights

Type: dict[str, float]

arm

Type: str | None

subject_to

Type: tuple[SubjectToBuilder, ...]

is_active

Type: bool

weight

Type: float | None

reference

Type: str | None

to_payload

to_payload() -> dict[str, object]

Return the public snake_case payload for this categorical target.

CorrelatedVariableBuilder

Reference to the second variable used by a correlation target.

Returned by: CorrelationBuilder.correlated_variable

Member	Kind	Description
descriptor_id	attribute
arm	attribute
level	attribute
to_payload	method	Return the public snake_case payload for this correlated variable.

descriptor_id

Type: str

arm

Type: str | None

level

Type: str | None

to_payload

to_payload() -> dict[str, object]

Return the public snake_case payload for this correlated variable.

CorrelationBuilder

Inert specification for one correlation target.

Returned by: ScalarTrialDescriptor.correlate_with

Member	Kind	Description
descriptor_id	attribute
correlated_variable	attribute
correlation_coefficient	attribute
arm	attribute
level	attribute
subject_to	attribute
is_active	attribute
weight	attribute
reference	attribute
to_payload	method	Return the public snake_case payload for this correlation.

descriptor_id

Type: str

correlated_variable

Type: CorrelatedVariableBuilder

correlation_coefficient

Type: float

arm

Type: str | None

level

Type: str | None

subject_to

Type: tuple[SubjectToBuilder, ...]

is_active

Type: bool

weight

Type: float | None

reference

Type: str | None

to_payload

to_payload() -> dict[str, object]

Return the public snake_case payload for this correlation.

SummaryStatisticBuilder

Inert specification for one summary-statistic target.

Returned by: ScalarTrialDescriptor.summary_statistic

Member	Kind	Description
descriptor_id	attribute
mean	attribute
subject_to	attribute
weight	attribute
arm	attribute
is_active	attribute
standard_deviation	attribute
mean_wide_range_low_bound	attribute
mean_wide_range_high_bound	attribute
std_wide_range_low_bound	attribute
std_wide_range_high_bound	attribute
reference	attribute
to_payload	method	Return the public snake_case payload for this summary statistic.

descriptor_id

Type: str

mean

Type: float

subject_to

Type: tuple[SubjectToBuilder, ...]

weight

Type: float

arm

Type: str | None

is_active

Type: bool

standard_deviation

Type: float | None

mean_wide_range_low_bound

Type: float | None

mean_wide_range_high_bound

Type: float | None

std_wide_range_low_bound

Type: float | None

std_wide_range_high_bound

Type: float | None

reference

Type: str | None

to_payload

to_payload() -> dict[str, object]

Return the public snake_case payload for this summary statistic.

SurvivalBuilder

Inert specification for one survival target.

Returned by: ScalarTrialDescriptor.survival

Member	Kind	Description
descriptor_id	attribute
time_vals	attribute
survival_rates	attribute
subject_to	attribute
weight	attribute
arm	attribute
is_active	attribute
time_unit	attribute
reference	attribute
to_payload	method	Return the public snake_case payload for this survival target.

descriptor_id

Type: str

time_vals

Type: tuple[float, ...]

survival_rates

Type: tuple[float, ...]

subject_to

Type: tuple[SubjectToBuilder, ...]

weight

Type: float

arm

Type: str | None

is_active

Type: bool

time_unit

Type: object | None

reference

Type: str | None

to_payload

to_payload() -> dict[str, object]

Return the public snake_case payload for this survival target.

ObservableBuilder

Inert specification for one extra scalar observable.

Returned by: ScalarTrialDescriptor.observable

Member	Kind	Description
descriptor_id	attribute
arm	attribute
to_payload	method	Return the public snake_case payload for this observable.

descriptor_id

Type: str

arm

Type: str | None

to_payload

to_payload() -> dict[str, object]

Return the public snake_case payload for this observable.