Skip to content
Submodule
causalis.scenarios.synthetic_control.model

model

Submodule causalis.scenarios.synthetic_control.model with no child pages and 5 documented members.

Classes

Jump directly into the documented classes for this page.

1 items

Data

Jump directly into the documented data for this page.

1 items
class
causalis.scenarios.synthetic_control.model.AugmentedSyntheticControl

AugmentedSyntheticControl

Ridge-augmented synthetic control with simplex anchor and aggregate-first inference.

Notes

Average ATT t-test inference is the default post-treatment inference layer. Pointwise conformal intervals/p-values are optional and can be enabled for dynamic path uncertainty quantification.

Initialization

Initialize ASCM hyperparameters.

Parameters

lambda_augfloat, default=1.0

Ridge regularization for augmented weights.

lambda_scfloat, default=1e-6

Numerical regularization for simplex SCM weights.

max_iterint, default=2000

Maximum iterations for constrained optimization routines.

tolfloat, default=1e-9

Optimization tolerance.

enforce_sum_to_one_augmentedbool, default=True

Enforce sum-to-one constraint on augmented weights.

alphafloat, default=0.05

Default significance level used by estimate() inference.

conformal_grid_sizeint, default=401

Default number of grid points used in pointwise conformal inversion.

conformal_grid_minfloat or None, default=None

Optional default fixed lower bound for conformal grid.

conformal_grid_maxfloat or None, default=None

Optional default fixed upper bound for conformal grid.

conformal_grid_scale_multfloat, default=6.0

Default scale multiplier for automatic conformal grid width.

average_att_n_foldsint, default=3

Default requested number of folds for average ATT t-test inference.

compute_average_att_ttestbool, default=True

Default toggle for average ATT t-test inference in estimate().

compute_pointwise_conformalbool, default=False

Default toggle for pointwise conformal CIs/p-values in estimate().

Raises

ValueError

If any hyperparameter is invalid.

Canonical target

causalis.scenarios.synthetic_control.model.AugmentedSyntheticControl

Sections

NotesInitializationParametersRaises
Link to this symbol
method
causalis.scenarios.synthetic_control.model.AugmentedSyntheticControl.fit

fit

Fit ASCM and compute inference outputs.

Parameters

dataPanelDataSCM

Validated synthetic-control panel data.

Returns

AugmentedSyntheticControl

Fitted estimator instance.

Raises

ValueError

If input type is invalid or panel requirements are violated.

Canonical target

causalis.scenarios.synthetic_control.model.AugmentedSyntheticControl.fit

Sections

ParametersReturnsRaises
Link to this symbol
method
causalis.scenarios.synthetic_control.model.AugmentedSyntheticControl.estimate

estimate

Return dynamic-path estimate object.

Parameters

alphafloat or None, default=None

Optional per-call significance level override.

conformal_grid_sizeint or None, default=None

Optional per-call pointwise conformal grid size override.

conformal_grid_minfloat or None, default=None

Optional per-call lower conformal grid bound override.

conformal_grid_maxfloat or None, default=None

Optional per-call upper conformal grid bound override.

conformal_grid_scale_multfloat or None, default=None

Optional per-call automatic conformal grid scale override.

average_att_n_foldsint or None, default=None

Optional per-call fold-count override for average ATT inference.

compute_average_att_ttestbool or None, default=None

Optional per-call toggle for average ATT t-test inference.

compute_pointwise_conformalbool or None, default=None

Optional per-call toggle for pointwise conformal inference.

Returns

PanelEstimate

Dynamic path estimates with pointwise inference fields. Aggregate average ATT t-test outputs are provided in diagnostics and are the default formal inference layer. If pointwise conformal is not computed, pointwise p-values/CIs are returned as NaN placeholders.

Raises

RuntimeError

If the model is not fitted.

Canonical target

causalis.scenarios.synthetic_control.model.AugmentedSyntheticControl.estimate

Sections

ParametersReturnsRaises
Link to this symbol
method
causalis.scenarios.synthetic_control.model.AugmentedSyntheticControl.__repr__

__repr__

Canonical target

causalis.scenarios.synthetic_control.model.AugmentedSyntheticControl.__repr__

Link to this symbol
data
causalis.scenarios.synthetic_control.model.ASCM

ASCM

Value: None

None

Canonical target

causalis.scenarios.synthetic_control.model.ASCM

Link to this symbol