Subsampling design: services

NumericFiltersService

Typed service for persisted numeric filters in one subsampling design.

Returned by: SubsamplingDesign.numeric_filters

Member	Kind	Description
find	method	Return numeric filters matching a descriptor id and optional arm.
create	method	Create one numeric filter from a builder or dict escape hatch.
create_from_descriptor	method	Create one numeric filter without building it separately first.
create_eq	method
create_neq	method
create_lt	method
create_lte	method
create_gt	method
create_gte	method
list	method
get_by_immutable_id	method	Return one persisted item by immutable id.

find

find(
    descriptor: ScalarTrialDescriptor | str, *, arm: str | None = None
) -> list[NumericFilterHandle]

Return numeric filters matching a descriptor id and optional arm.

create

create(
    filter_builder: NumericFilterInput, *, version: str | dict | None = None
) -> NumericFilterHandle

Create one numeric filter from a builder or dict escape hatch.

create_from_descriptor

create_from_descriptor(
    descriptor: ScalarTrialDescriptor | str,
    *,
    operator: str,
    value: float,
    is_active: bool = True,
    arm: str | None = None,
    version: str | dict | None = None
) -> NumericFilterHandle

Create one numeric filter without building it separately first.

create_eq

create_eq(
    descriptor: ScalarTrialDescriptor | str,
    value: float,
    *,
    arm: str | None = None,
    version: str | dict | None = None
) -> NumericFilterHandle

create_neq

create_neq(
    descriptor: ScalarTrialDescriptor | str,
    value: float,
    *,
    arm: str | None = None,
    version: str | dict | None = None
) -> NumericFilterHandle

create_lt

create_lt(
    descriptor: ScalarTrialDescriptor | str,
    value: float,
    *,
    arm: str | None = None,
    version: str | dict | None = None
) -> NumericFilterHandle

create_lte

create_lte(
    descriptor: ScalarTrialDescriptor | str,
    value: float,
    *,
    arm: str | None = None,
    version: str | dict | None = None
) -> NumericFilterHandle

create_gt

create_gt(
    descriptor: ScalarTrialDescriptor | str,
    value: float,
    *,
    arm: str | None = None,
    version: str | dict | None = None
) -> NumericFilterHandle

create_gte

create_gte(
    descriptor: ScalarTrialDescriptor | str,
    value: float,
    *,
    arm: str | None = None,
    version: str | dict | None = None
) -> NumericFilterHandle

list

list() -> list[_HandleT]

get_by_immutable_id

get_by_immutable_id(immutable_id: str) -> _HandleT

Return one persisted item by immutable id.

CategoricalFiltersService

Typed service for persisted categorical filters in one design.

Returned by: SubsamplingDesign.categorical_filters

Member	Kind	Description
find	method	Return categorical filters matching a descriptor id and optional arm.
create	method	Create one categorical filter from a builder or dict escape hatch.
create_from_descriptor	method	Create one categorical filter without building it separately first.
list	method
get_by_immutable_id	method	Return one persisted item by immutable id.

find

find(
    descriptor: CategoricalTrialDescriptor | str, *, arm: str | None = None
) -> list[CategoricalFilterHandle]

Return categorical filters matching a descriptor id and optional arm.

create

create(
    filter_builder: CategoricalFilterInput, *, version: str | dict | None = None
) -> CategoricalFilterHandle

Create one categorical filter from a builder or dict escape hatch.

create_from_descriptor

create_from_descriptor(
    descriptor: CategoricalTrialDescriptor | str,
    *,
    levels: list[str] | tuple[str, ...],
    is_active: bool = True,
    arm: str | None = None,
    version: str | dict | None = None
) -> CategoricalFilterHandle

Create one categorical filter without building it separately first.

list

list() -> list[_HandleT]

get_by_immutable_id

get_by_immutable_id(immutable_id: str) -> _HandleT

Return one persisted item by immutable id.

MarginalsService

Typed service for persisted scalar target distributions.

Returned by: SubsamplingDesign.marginals

Member	Kind	Description
find	method	Return marginal targets matching a descriptor id and optional arm.
create	method	Create one marginal target from a builder or dict escape hatch.
create_uniform	method
create_normal	method
create_weibull	method
create_from_descriptor	method	Create a marginal target without building it separately first.
list	method
get_by_immutable_id	method	Return one persisted item by immutable id.

find

find(
    descriptor: ScalarTrialDescriptor | str, *, arm: str | None = None
) -> list[MarginalHandle]

Return marginal targets matching a descriptor id and optional arm.

create

create(
    marginal: MarginalInput, *, version: str | dict | None = None
) -> MarginalHandle

Create one marginal target from a builder or dict escape hatch.

create_uniform

create_uniform(
    descriptor: ScalarTrialDescriptor | str,
    *,
    low_bound: float,
    high_bound: float,
    subject_to: list[dict[str, Any]] | None = None,
    is_active: bool = True,
    weight: float | None = None,
    reference: str | None = None,
    arm: str | None = None,
    version: str | dict | None = None
) -> MarginalHandle

create_normal

create_normal(
    descriptor: ScalarTrialDescriptor | str,
    *,
    mean: float,
    standard_deviation: float,
    subject_to: list[dict[str, Any]] | None = None,
    is_active: bool = True,
    weight: float | None = None,
    reference: str | None = None,
    arm: str | None = None,
    version: str | dict | None = None
) -> MarginalHandle

create_weibull

create_weibull(
    descriptor: ScalarTrialDescriptor | str,
    *,
    lambda_: float,
    k: float,
    subject_to: list[dict[str, Any]] | None = None,
    is_active: bool = True,
    weight: float | None = None,
    reference: str | None = None,
    arm: str | None = None,
    version: str | dict | None = None
) -> MarginalHandle

create_from_descriptor

create_from_descriptor(
    descriptor: ScalarTrialDescriptor | str,
    *,
    distribution: str,
    params: dict[str, Any],
    subject_to: list[dict[str, Any]] | None = None,
    is_active: bool = True,
    weight: float | None = None,
    reference: str | None = None,
    arm: str | None = None,
    version: str | dict | None = None
) -> MarginalHandle

Create a marginal target without building it separately first.

params depends on distribution:

• uniform: {"low_bound", "high_bound"}
• normal: {"mean", "standard_deviation"}
• normal_truncated: {"mean", "standard_deviation", "low_bound", "high_bound"}
• log_normal: {"mean", "standard_deviation", "base"}
• weibull: {"lambda_", "k"}
• mixture: {"components": [...]}

list

list() -> list[_HandleT]

get_by_immutable_id

get_by_immutable_id(immutable_id: str) -> _HandleT

Return one persisted item by immutable id.

CategoricalsService

Typed service for persisted categorical target distributions.

Returned by: SubsamplingDesign.categoricals

Member	Kind	Description
find	method	Return categorical targets matching a descriptor id and optional arm.
create	method	Create one categorical target from a builder or dict escape hatch.
list	method
get_by_immutable_id	method	Return one persisted item by immutable id.

find

find(
    descriptor: CategoricalTrialDescriptor | str, *, arm: str | None = None
) -> list[CategoricalTargetHandle]

Return categorical targets matching a descriptor id and optional arm.

create

create(
    categorical: CategoricalTargetInput, *, version: str | dict | None = None
) -> CategoricalTargetHandle

Create one categorical target from a builder or dict escape hatch.

list

list() -> list[_HandleT]

get_by_immutable_id

get_by_immutable_id(immutable_id: str) -> _HandleT

Return one persisted item by immutable id.

CorrelationsService

Typed service for persisted correlation targets.

Returned by: SubsamplingDesign.correlations, VpopDesign.correlations

Member	Kind	Description
find	method	Return correlation targets matching a descriptor id and optional arm.
create	method	Create one correlation target from a builder or dict escape hatch.
list	method
get_by_immutable_id	method	Return one persisted item by immutable id.

find

find(
    descriptor: ScalarTrialDescriptor | str, *, arm: str | None = None
) -> list[CorrelationHandle]

Return correlation targets matching a descriptor id and optional arm.

create

create(
    correlation: CorrelationInput, *, version: str | dict | None = None
) -> CorrelationHandle

Create one correlation target from a builder or dict escape hatch.

list

list() -> list[_HandleT]

get_by_immutable_id

get_by_immutable_id(immutable_id: str) -> _HandleT

Return one persisted item by immutable id.

SummaryStatisticsService

Typed service for persisted summary-statistic targets.

Returned by: SubsamplingDesign.summary_statistics

Member	Kind	Description
find	method	Return summary-statistic targets matching a descriptor id and optional arm.
create	method	Create one summary-statistic target from a builder or dict escape hatch.
list	method
get_by_immutable_id	method	Return one persisted item by immutable id.

find

find(
    descriptor: ScalarTrialDescriptor | str, *, arm: str | None = None
) -> list[SummaryStatisticHandle]

Return summary-statistic targets matching a descriptor id and optional arm.

create

create(
    statistic: SummaryStatisticInput, *, version: str | dict | None = None
) -> SummaryStatisticHandle

Create one summary-statistic target from a builder or dict escape hatch.

list

list() -> list[_HandleT]

get_by_immutable_id

get_by_immutable_id(immutable_id: str) -> _HandleT

Return one persisted item by immutable id.

SurvivalsService

Typed service for persisted survival targets.

Returned by: SubsamplingDesign.survivals

Member	Kind	Description
find	method	Return survival targets matching a descriptor id and optional arm.
create	method	Create one survival target from a builder or dict escape hatch.
list	method
get_by_immutable_id	method	Return one persisted item by immutable id.

find

find(
    descriptor: ScalarTrialDescriptor | str, *, arm: str | None = None
) -> list[SurvivalHandle]

Return survival targets matching a descriptor id and optional arm.

create

create(
    survival: SurvivalInput, *, version: str | dict | None = None
) -> SurvivalHandle

Create one survival target from a builder or dict escape hatch.

list

list() -> list[_HandleT]

get_by_immutable_id

get_by_immutable_id(immutable_id: str) -> _HandleT

Return one persisted item by immutable id.

ObservablesService

Typed service for persisted extra scalar observables.

Returned by: SubsamplingDesign.observables

Member	Kind	Description
find	method	Return observables matching a descriptor id and optional arm.
create	method	Create one observable from a builder, string id, or dict escape hatch.
list	method
get_by_immutable_id	method	Return one persisted item by immutable id.

find

find(
    descriptor: ScalarTrialDescriptor | str, *, arm: str | None = None
) -> list[ObservableHandle]

Return observables matching a descriptor id and optional arm.

create

create(
    observable: ObservableInput, *, version: str | dict | None = None
) -> ObservableHandle

Create one observable from a builder, string id, or dict escape hatch.

list

list() -> list[_HandleT]

get_by_immutable_id

get_by_immutable_id(immutable_id: str) -> _HandleT

Return one persisted item by immutable id.