Subsampling design: diagnostics

SubsamplingDesignDiagnostic

A single sanity diagnostic attached to a subsampling design item.

Returned by: SubsamplingDesignDiagnostics.by_field

Member	Kind	Description
descriptor_id	attribute
immutable_id	attribute
field	attribute
diagnostic	attribute
details	attribute	Resolved trial descriptor context (type, unit/levels, description), captured once when this diagnostics view was fetched. Used by SubsamplingDesignDiagnostics.explain.
component_kind	property
component	property

descriptor_id

Type: str

immutable_id

Type: str | None

field

Type: SubsamplingDesignDiagnosticField

diagnostic

Type: DiagnosticDetails

details

Type: str | None

Resolved trial descriptor context (type, unit/levels, description), captured once when this diagnostics view was fetched. Used by SubsamplingDesignDiagnostics.explain.

component_kind

Type: str

component

Type: _DescriptorRef

SubsamplingDesignDiagnostics

A filterable, printable, iterable view over subsampling design diagnostics.

Returned by: SubsamplingDesign.diagnostics, SubsamplingDesign.diagnostics_at, SubsamplingDesignDiagnostics.for_descriptor, SubsamplingDesignDiagnostics.for_field, SubsamplingDesignDiagnostics.for_immutable_id, SubsamplingDesignDiagnostics.for_item

Member	Kind	Description
for_descriptor	method
for_immutable_id	method
for_field	method
for_item	method
by_descriptor	method
by_field	method
explain	method	Render these diagnostics together with the corresponding trial descriptor's metadata (type, unit/levels, description), resolved from the design's source trial.
with_severity	method
with_code	method
errors	method
warnings	method
has_errors	method
by_severity	method

for_descriptor

for_descriptor(descriptor: str) -> SubsamplingDesignDiagnostics

for_immutable_id

for_immutable_id(immutable_id: str) -> SubsamplingDesignDiagnostics

for_field

for_field(*fields: SubsamplingDesignDiagnosticField = ()) -> SubsamplingDesignDiagnostics

for_item

for_item(item: object) -> SubsamplingDesignDiagnostics

by_descriptor

by_descriptor() -> dict[str, list[DiagnosticDetails]]

by_field

by_field() -> (
    dict[SubsamplingDesignDiagnosticField, list[SubsamplingDesignDiagnostic]]
)

explain

explain() -> str

Render these diagnostics together with the corresponding trial descriptor's metadata (type, unit/levels, description), resolved from the design's source trial.

This resolved context was captured once, when this diagnostics view was fetched (i.e. when design.diagnostics / design.diagnostics_at() was accessed) - calling .explain() itself makes no network request. Re-access design.diagnostics for an updated view. Composes with existing filters, e.g.::

design.diagnostics.errors().for_field("numericFilters").explain()

with_severity

with_severity(*severities: SeverityLiteral = ())

with_code

with_code(*codes: str = ())

errors

errors()

warnings

warnings()

has_errors

has_errors() -> bool

by_severity

by_severity() -> dict[str, list[EntryT]]