cleverly.validation.ReplicationRecord#

class cleverly.validation.ReplicationRecord(replicate: int, seed: int, estimand: str, truth: float, estimate: float, std_error: float, covered: bool, rejected: bool, inference_estimate: float, alpha: float, inference: Literal['influence_curve', 'working_mechanism_plugin', 'generated_design_plugin', 'estimated_weight_plugin', 'adaptive_baseline_plugin', 'no_cluster_variance_plugin', 'few_cluster_plugin', 'constant_node_plugin', 'stack_failure_plugin'] = 'influence_curve', support: str = 'experimental')[source]#

One estimand from one successful repeated-sampling draw.

Parameters:
replicateint

Index of the draw.

seedint

Seed that produced it.

estimandstr

Alias this record is for.

truthfloat

The estimand’s true value under the process.

estimatefloat

What the estimator reported.

std_errorfloat

The standard error it reported.

coveredbool

Whether the interval contained truth.

rejectedbool

Whether the null was rejected at alpha.

inference_estimatefloat

The estimate on the inference scale.

alphafloat

Significance level the interval was built at.

inferencestr

Which quantity std_error, covered and rejected measured. One of InferenceStatus, which the inference reference lists. "influence_curve" says the estimator’s own reported inference. Any other status says the estimator supplies none, and the study measured its retained plug-in diagnostic instead.

support{“supported”, “experimental”}

The support label of the replicate’s estimate.

Methods#

Attributes#

ReplicationRecord.inference: Literal['influence_curve', 'working_mechanism_plugin', 'generated_design_plugin', 'estimated_weight_plugin', 'adaptive_baseline_plugin', 'no_cluster_variance_plugin', 'few_cluster_plugin', 'constant_node_plugin', 'stack_failure_plugin'] = 'influence_curve'#
ReplicationRecord.support: str = 'experimental'#
ReplicationRecord.replicate: int#
ReplicationRecord.seed: int#
ReplicationRecord.estimand: str#
ReplicationRecord.truth: float#
ReplicationRecord.estimate: float#
ReplicationRecord.std_error: float#
ReplicationRecord.covered: bool#
ReplicationRecord.rejected: bool#
ReplicationRecord.inference_estimate: float#
ReplicationRecord.alpha: float#