Results and assessment#

Use result objects to read estimates, uncertainty, influence curves, diagnostics, and provenance. Reports provide stable summaries and dataframe output for downstream analysis.

cleverly.CausalResult

Define operations shared by fitted causal-result families.

cleverly.estimators.TMLEResult

Store a fitted point-treatment TMLE result.

cleverly.longitudinal.LongitudinalResult

Store estimates and fitted artifacts for longitudinal regimens.

cleverly.fluctuation.Fluctuation

The result of a targeting step.

cleverly.fluctuation.FoldFluctuation

One validation fold's contribution to a cross-validated targeting step.

cleverly.ParameterEstimate

A point estimate with everything needed to do inference on it.

cleverly.ParameterKey

Describe the structured identity behind a parameter alias.

cleverly.AssessmentCapability

Describe whether and how a result supports one assessment operation.

cleverly.AssessmentReport

Collect validation, diagnostics, and sensitivity in one post-fit battery.

cleverly.AssessmentStatus

Status returned by a diagnostic or validation operation.

cleverly.DiagnosticReport

Collect statuses from a combined diagnostic or sensitivity run.

cleverly.ValidationReport

Collect results from the inexpensive validation battery.

cleverly.Replayability

Describe which post-fit actions a saved result can reproduce.

cleverly.VariableImportanceEntry

One candidate exposure's target estimate and declared adjustment set.

cleverly.VariableImportanceResult

Candidate-exposure estimates with multiplicity-adjusted null tests.

cleverly.variable_importance

Estimate one causal importance parameter per candidate exposure.

cleverly.load

Load a complete result from a trusted joblib artifact.

CausalResult is the protocol every fitted scalar result satisfies. The concrete classes are TMLEResult for a point-treatment fit and LongitudinalResult for a sequential one; estimate() returns one of those two.

TMLEResult.fluctuations returns one Fluctuation for each target group. A fold-targeted cross-validated fit fills that record’s folds field with one FoldFluctuation for each validation fold.