Subsampling design: items

NumericFilterItem

Member	Kind	Description
descriptor_id	attribute
operator	attribute
value	attribute
arm	attribute
immutable_id	attribute
is_active	attribute

descriptor_id

Type: str

operator

Type: str

value

Type: float

arm

Type: str | None

immutable_id

Type: str | None

is_active

Type: bool

NumericFilterHandle

Persisted numeric filter bound to one subsampling design.

Returned by: NumericFilterHandle.refresh, NumericFilterHandle.set_active, NumericFilterHandle.set_value, NumericFiltersService.create, NumericFiltersService.create_eq, NumericFiltersService.create_from_descriptor, NumericFiltersService.create_gt, NumericFiltersService.create_gte, NumericFiltersService.create_lt, NumericFiltersService.create_lte, NumericFiltersService.create_neq, NumericFiltersService.find

Also has every member of NumericFilterItem.

Member	Kind	Description
refresh	method	Reload this filter from the latest design state.
copy	method	Return a reusable dict payload for creating a similar filter.
set_value	method	Replace the numeric threshold for this filter.
set_active	method	Enable or disable this filter.
delete	method	Delete this filter from the design.

refresh

refresh() -> NumericFilterHandle

Reload this filter from the latest design state.

copy

copy() -> dict[str, Any]

Return a reusable dict payload for creating a similar filter.

set_value

set_value(
    value: float, *, version: str | dict | None = None
) -> NumericFilterHandle

Replace the numeric threshold for this filter.

set_active

set_active(
    is_active: bool, *, version: str | dict | None = None
) -> NumericFilterHandle

Enable or disable this filter.

delete

delete(*, version: str | dict | None = None) -> None

Delete this filter from the design.

CategoricalFilterItem

Member	Kind	Description
descriptor_id	attribute
levels	attribute
arm	attribute
immutable_id	attribute
is_active	attribute

descriptor_id

Type: str

levels

Type: tuple[str, ...]

arm

Type: str | None

immutable_id

Type: str | None

is_active

Type: bool

CategoricalFilterHandle

Persisted categorical filter bound to one subsampling design.

Returned by: CategoricalFilterHandle.refresh, CategoricalFilterHandle.set_active, CategoricalFilterHandle.set_levels, CategoricalFiltersService.create, CategoricalFiltersService.create_from_descriptor, CategoricalFiltersService.find

Also has every member of CategoricalFilterItem.

Member	Kind	Description
refresh	method	Reload this filter from the latest design state.
copy	method	Return a reusable dict payload for creating a similar filter.
set_levels	method	Replace the allowed levels for this filter.
set_active	method	Enable or disable this filter.
delete	method	Delete this filter from the design.

refresh

refresh() -> CategoricalFilterHandle

Reload this filter from the latest design state.

copy

copy() -> dict[str, Any]

Return a reusable dict payload for creating a similar filter.

set_levels

set_levels(
    levels: list[str] | tuple[str, ...], *, version: str | dict | None = None
) -> CategoricalFilterHandle

Replace the allowed levels for this filter.

set_active

set_active(
    is_active: bool, *, version: str | dict | None = None
) -> CategoricalFilterHandle

Enable or disable this filter.

delete

delete(*, version: str | dict | None = None) -> None

Delete this filter from the design.

MarginalItem

Member	Kind	Description
descriptor_id	attribute
distribution	attribute
arm	attribute
immutable_id	attribute
is_active	attribute
weight	attribute
subject_to	attribute
reference	attribute

descriptor_id

Type: str

distribution

Type: Any

arm

Type: str | None

immutable_id

Type: str | None

is_active

Type: bool | None

weight

Type: float | None

subject_to

Type: tuple[dict[str, Any], ...]

reference

Type: str | None

MarginalHandle

Persisted scalar target distribution bound to one subsampling design.

Returned by: MarginalHandle.refresh, MarginalHandle.set_active, MarginalHandle.set_distribution, MarginalHandle.set_distribution_log_normal, MarginalHandle.set_distribution_normal, MarginalHandle.set_distribution_normal_truncated, MarginalHandle.set_distribution_uniform, MarginalHandle.set_distribution_weibull, MarginalHandle.set_reference, MarginalHandle.set_subject_to, MarginalHandle.set_weight, MarginalsService.create, MarginalsService.create_from_descriptor, MarginalsService.create_normal, MarginalsService.create_uniform, MarginalsService.create_weibull, MarginalsService.find

Also has every member of MarginalItem.

Member	Kind	Description
refresh	method	Reload this marginal from the latest design state.
copy	method	Return a reusable dict payload for creating a similar marginal.
set_distribution	method	Replace the raw distribution payload for this marginal.
set_distribution_normal	method	Replace this marginal with a Normal distribution.
set_distribution_uniform	method	Replace this marginal with a Uniform distribution.
set_distribution_normal_truncated	method	Replace this marginal with a truncated Normal distribution.
set_distribution_log_normal	method	Replace this marginal with a LogNormal distribution.
set_distribution_weibull	method	Replace this marginal with a Weibull distribution.
set_weight	method	Replace the outer weight attached to this marginal.
set_subject_to	method	Replace the conditions attached to this marginal.
set_reference	method	Replace the reference link attached to this marginal.
set_active	method	Enable or disable this marginal.
delete	method	Delete this marginal from the design.

refresh

refresh() -> MarginalHandle

Reload this marginal from the latest design state.

copy

copy() -> dict[str, Any]

Return a reusable dict payload for creating a similar marginal.

set_distribution

set_distribution(
    distribution: dict[str, Any] | float | str,
    *,
    version: str | dict | None = None
) -> MarginalHandle

Replace the raw distribution payload for this marginal.

set_distribution_normal

set_distribution_normal(
    *, mean: float, standard_deviation: float, version: str | dict | None = None
) -> MarginalHandle

Replace this marginal with a Normal distribution.

set_distribution_uniform

set_distribution_uniform(
    *, low_bound: float, high_bound: float, version: str | dict | None = None
) -> MarginalHandle

Replace this marginal with a Uniform distribution.

set_distribution_normal_truncated

set_distribution_normal_truncated(
    *,
    mean: float,
    standard_deviation: float,
    low_bound: float,
    high_bound: float,
    version: str | dict | None = None
) -> MarginalHandle

Replace this marginal with a truncated Normal distribution.

set_distribution_log_normal

set_distribution_log_normal(
    *,
    mean: float,
    standard_deviation: float,
    base: float,
    version: str | dict | None = None
) -> MarginalHandle

Replace this marginal with a LogNormal distribution.

set_distribution_weibull

set_distribution_weibull(
    *, lambda_: float, k: float, version: str | dict | None = None
) -> MarginalHandle

Replace this marginal with a Weibull distribution.

set_weight

set_weight(
    weight: float | None, *, version: str | dict | None = None
) -> MarginalHandle

Replace the outer weight attached to this marginal.

set_subject_to

set_subject_to(
    subject_to: list[dict[str, Any]], *, version: str | dict | None = None
) -> MarginalHandle

Replace the conditions attached to this marginal.

set_reference

set_reference(
    reference: str | None, *, version: str | dict | None = None
) -> MarginalHandle

Replace the reference link attached to this marginal.

set_active

set_active(
    is_active: bool, *, version: str | dict | None = None
) -> MarginalHandle

Enable or disable this marginal.

delete

delete(*, version: str | dict | None = None) -> None

Delete this marginal from the design.

CategoricalTargetItem

Member	Kind	Description
descriptor_id	attribute
distribution	attribute
arm	attribute
immutable_id	attribute
is_active	attribute
weight	attribute
subject_to	attribute
reference	attribute

descriptor_id

Type: str

distribution

Type: dict[str, Any]

arm

Type: str | None

immutable_id

Type: str | None

is_active

Type: bool | None

weight

Type: float | None

subject_to

Type: tuple[dict[str, Any], ...]

reference

Type: str | None

CategoricalTargetHandle

Persisted categorical target distribution bound to one design.

Returned by: CategoricalTargetHandle.refresh, CategoricalTargetHandle.set_active, CategoricalTargetHandle.set_distribution, CategoricalTargetHandle.set_reference, CategoricalTargetHandle.set_subject_to, CategoricalTargetHandle.set_weight, CategoricalsService.create, CategoricalsService.find

Also has every member of CategoricalTargetItem.

Member	Kind	Description
refresh	method	Reload this target from the latest design state.
copy	method	Return a reusable dict payload for creating a similar target.
set_distribution	method	Replace the raw categorical distribution payload.
set_weight	method	Replace the weight attached to this target.
set_subject_to	method	Replace the conditions attached to this target.
set_reference	method	Replace the reference link attached to this target.
set_active	method	Enable or disable this target.
delete	method	Delete this target from the design.

refresh

refresh() -> CategoricalTargetHandle

Reload this target from the latest design state.

copy

copy() -> dict[str, Any]

Return a reusable dict payload for creating a similar target.

set_distribution

set_distribution(
    distribution: dict[str, Any], *, version: str | dict | None = None
) -> CategoricalTargetHandle

Replace the raw categorical distribution payload.

set_weight

set_weight(
    weight: float | None, *, version: str | dict | None = None
) -> CategoricalTargetHandle

Replace the weight attached to this target.

set_subject_to

set_subject_to(
    subject_to: list[dict[str, Any]], *, version: str | dict | None = None
) -> CategoricalTargetHandle

Replace the conditions attached to this target.

set_reference

set_reference(
    reference: str | None, *, version: str | dict | None = None
) -> CategoricalTargetHandle

Replace the reference link attached to this target.

set_active

set_active(
    is_active: bool, *, version: str | dict | None = None
) -> CategoricalTargetHandle

Enable or disable this target.

delete

delete(*, version: str | dict | None = None) -> None

Delete this target from the design.

CorrelationItem

Member	Kind	Description
descriptor_id	attribute
correlated_variable	attribute
correlation_coefficient	attribute
arm	attribute
level	attribute
immutable_id	attribute
is_active	attribute
weight	attribute
subject_to	attribute
reference	attribute

descriptor_id

Type: str

correlated_variable

Type: dict[str, Any]

correlation_coefficient

Type: float

arm

Type: str | None

level

Type: str | None

immutable_id

Type: str | None

is_active

Type: bool | None

weight

Type: float | None

subject_to

Type: tuple[dict[str, Any], ...]

reference

Type: str | None

CorrelationHandle

Persisted correlation target bound to one subsampling design.

Returned by: CorrelationHandle.refresh, CorrelationHandle.set_active, CorrelationHandle.set_correlation_coefficient, CorrelationHandle.set_reference, CorrelationHandle.set_subject_to, CorrelationsService.create, CorrelationsService.find

Also has every member of CorrelationItem.

Member	Kind	Description
refresh	method	Reload this correlation from the latest design state.
copy	method	Return a reusable dict payload for creating a similar correlation.
set_correlation_coefficient	method	Replace the Pearson correlation coefficient.
set_subject_to	method	Replace the conditions attached to this correlation.
set_reference	method	Replace the reference link attached to this correlation.
set_active	method	Enable or disable this correlation.
delete	method	Delete this correlation from the design.

refresh

refresh() -> CorrelationHandle

Reload this correlation from the latest design state.

copy

copy() -> dict[str, Any]

Return a reusable dict payload for creating a similar correlation.

set_correlation_coefficient

set_correlation_coefficient(
    coefficient: float, *, version: str | dict | None = None
) -> CorrelationHandle

Replace the Pearson correlation coefficient.

set_subject_to

set_subject_to(
    subject_to: list[dict[str, Any]], *, version: str | dict | None = None
) -> CorrelationHandle

Replace the conditions attached to this correlation.

set_reference

set_reference(
    reference: str | None, *, version: str | dict | None = None
) -> CorrelationHandle

Replace the reference link attached to this correlation.

set_active

set_active(
    is_active: bool, *, version: str | dict | None = None
) -> CorrelationHandle

Enable or disable this correlation.

delete

delete(*, version: str | dict | None = None) -> None

Delete this correlation from the design.

SummaryStatisticItem

Member	Kind	Description
descriptor_id	attribute
mean	attribute
arm	attribute
immutable_id	attribute
is_active	attribute
weight	attribute
subject_to	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

descriptor_id

Type: str

mean

Type: float

arm

Type: str | None

immutable_id

Type: str | None

is_active

Type: bool

weight

Type: float

subject_to

Type: tuple[dict[str, Any], ...]

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

SummaryStatisticHandle

Persisted summary-statistic target bound to one design.

Returned by: SummaryStatisticHandle.refresh, SummaryStatisticHandle.set_active, SummaryStatisticHandle.set_mean, SummaryStatisticHandle.set_standard_deviation, SummaryStatisticHandle.set_subject_to, SummaryStatisticHandle.set_weight, SummaryStatisticsService.create, SummaryStatisticsService.find

Also has every member of SummaryStatisticItem.

Member	Kind	Description
refresh	method	Reload this target from the latest design state.
copy	method	Return a reusable dict payload for creating a similar target.
set_mean	method	Replace the target mean value.
set_standard_deviation	method	Replace the optional standard deviation value.
set_weight	method	Replace the weight attached to this target.
set_subject_to	method	Replace the conditions attached to this target.
set_active	method	Enable or disable this target.
delete	method	Delete this target from the design.

refresh

refresh() -> SummaryStatisticHandle

Reload this target from the latest design state.

copy

copy() -> dict[str, Any]

Return a reusable dict payload for creating a similar target.

set_mean

set_mean(
    mean: float, *, version: str | dict | None = None
) -> SummaryStatisticHandle

Replace the target mean value.

set_standard_deviation

set_standard_deviation(
    standard_deviation: float | None, *, version: str | dict | None = None
) -> SummaryStatisticHandle

Replace the optional standard deviation value.

set_weight

set_weight(
    weight: float, *, version: str | dict | None = None
) -> SummaryStatisticHandle

Replace the weight attached to this target.

set_subject_to

set_subject_to(
    subject_to: list[dict[str, Any]], *, version: str | dict | None = None
) -> SummaryStatisticHandle

Replace the conditions attached to this target.

set_active

set_active(
    is_active: bool, *, version: str | dict | None = None
) -> SummaryStatisticHandle

Enable or disable this target.

delete

delete(*, version: str | dict | None = None) -> None

Delete this target from the design.

SurvivalItem

Member	Kind	Description
descriptor_id	attribute
time_vals	attribute
survival_rates	attribute
arm	attribute
immutable_id	attribute
is_active	attribute
weight	attribute
subject_to	attribute
time_unit	attribute
reference	attribute

descriptor_id

Type: str

time_vals

Type: tuple[float, ...]

survival_rates

Type: tuple[float, ...]

arm

Type: str | None

immutable_id

Type: str | None

is_active

Type: bool

weight

Type: float

subject_to

Type: tuple[dict[str, Any], ...]

time_unit

Type: Any

reference

Type: str | None

SurvivalHandle

Persisted survival target bound to one subsampling design.

Returned by: SurvivalHandle.refresh, SurvivalHandle.set_active, SurvivalHandle.set_points, SurvivalHandle.set_subject_to, SurvivalHandle.set_weight, SurvivalsService.create, SurvivalsService.find

Also has every member of SurvivalItem.

Member	Kind	Description
refresh	method	Reload this target from the latest design state.
copy	method	Return a reusable dict payload for creating a similar target.
set_points	method	Replace the survival curve using a list or dict of points.
set_weight	method	Replace the weight attached to this target.
set_subject_to	method	Replace the conditions attached to this target.
set_active	method	Enable or disable this target.
delete	method	Delete this target from the design.

refresh

refresh() -> SurvivalHandle

Reload this target from the latest design state.

copy

copy() -> dict[str, Any]

Return a reusable dict payload for creating a similar target.

set_points

set_points(
    points: list[tuple[float, float]] | dict[float, float],
    *,
    version: str | dict | None = None
) -> SurvivalHandle

Replace the survival curve using a list or dict of points.

set_weight

set_weight(
    weight: float, *, version: str | dict | None = None
) -> SurvivalHandle

Replace the weight attached to this target.

set_subject_to

set_subject_to(
    subject_to: list[dict[str, Any]], *, version: str | dict | None = None
) -> SurvivalHandle

Replace the conditions attached to this target.

set_active

set_active(
    is_active: bool, *, version: str | dict | None = None
) -> SurvivalHandle

Enable or disable this target.

delete

delete(*, version: str | dict | None = None) -> None

Delete this target from the design.

ObservableItem

Member	Kind	Description
descriptor_id	attribute
arm	attribute
immutable_id	attribute

descriptor_id

Type: str

arm

Type: str | None

immutable_id

Type: str | None

ObservableHandle

Persisted extra scalar observable bound to one design.

Returned by: ObservableHandle.refresh, ObservablesService.create, ObservablesService.find

Also has every member of ObservableItem.

Member	Kind	Description
refresh	method	Reload this observable from the latest design state.
copy	method	Return a reusable dict payload for creating a similar observable.
delete	method	Delete this observable from the design.

refresh

refresh() -> ObservableHandle

Reload this observable from the latest design state.

copy

copy() -> dict[str, Any]

Return a reusable dict payload for creating a similar observable.

delete

delete(*, version: str | dict | None = None) -> None

Delete this observable from the design.