Skip to content
Submodule
causalis.data_contracts.panel_did_estimate

panel_did_estimate

Submodule causalis.data_contracts.panel_did_estimate with no child pages and 80 documented members.

Symbol indexAPI membersPanelDIDDiagnosticDatamodel_configunit_idsd

Classes

Jump directly into the documented classes for this page.

3 items
PanelDIDDiagnosticDataclassPanelDIDEstimateclassCallawaySantAnnaDIDEstimateclass
class
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData

PanelDIDDiagnosticData

Bases: pydantic.BaseModel

Diagnostic payload for scalar panel DID estimators.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData

Sections

Initialization
Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.model_config

model_config

Value: 'ConfigDict(...)'

‘ConfigDict(…)’

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.model_config

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.unit_ids

unit_ids

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.unit_ids

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.d

d

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.d

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.delta_y

delta_y

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.delta_y

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.x

x

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.x

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.covariate_names

covariate_names

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.covariate_names

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.propensity_score

propensity_score

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.propensity_score

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.control_outcome_evolution

control_outcome_evolution

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.control_outcome_evolution

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.treated_weights

treated_weights

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.treated_weights

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.control_weights

control_weights

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.control_weights

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.influence_scores

influence_scores

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.influence_scores

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.gamma_hat

gamma_hat

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.gamma_hat

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.beta_hat

beta_hat

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.beta_hat

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.overlap

overlap

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.overlap

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.balance

balance

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.balance

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.cluster_scores

cluster_scores

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDDiagnosticData.cluster_scores

Link to this symbol
class
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate

PanelDIDEstimate

Bases: pydantic.BaseModel

Result contract for scalar panel difference-in-differences estimates.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate

Sections

Initialization
Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.model_config

model_config

Value: 'ConfigDict(...)'

‘ConfigDict(…)’

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.model_config

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.estimand

estimand

Value: 'ATT'

‘ATT’

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.estimand

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.model

model

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.model

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.treatment_start

treatment_start

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.treatment_start

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.pre_time

pre_time

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.pre_time

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.post_time

post_time

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.post_time

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.att

att

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.att

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.se

se

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.se

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.ci_lower

ci_lower

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.ci_lower

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.ci_upper

ci_upper

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.ci_upper

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.p_value

p_value

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.p_value

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.is_significant

is_significant

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.is_significant

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.alpha

alpha

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.alpha

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.n_units

n_units

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.n_units

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.n_treated

n_treated

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.n_treated

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.n_control

n_control

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.n_control

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.treatment_mean_delta

treatment_mean_delta

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.treatment_mean_delta

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.control_mean_delta

control_mean_delta

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.control_mean_delta

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.outcome

outcome

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.outcome

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.treatment

treatment

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.treatment

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.covariates

covariates

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.covariates

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.cluster_col

cluster_col

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.cluster_col

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.inference

inference

Value: 'influence'

‘influence’

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.inference

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.diagnostic_data

diagnostic_data

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.diagnostic_data

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.created_at

created_at

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.created_at

Link to this symbol
property
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.value

value

CausalEstimate-style alias for the ATT.

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.value

Link to this symbol
property
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.std_error

std_error

Readable alias for the influence-function standard error.

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.std_error

Link to this symbol
method
causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.summary

summary

Return a compact scalar panel-DID summary table.

Canonical target

causalis.data_contracts.panel_did_estimate.PanelDIDEstimate.summary

Link to this symbol
class
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate

CallawaySantAnnaDIDEstimate

Bases: pydantic.BaseModel

Result contract for Callaway-Sant’Anna staggered-adoption DID estimates.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate

Sections

Initialization
Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.model_config

model_config

Value: 'ConfigDict(...)'

‘ConfigDict(…)’

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.model_config

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.estimand

estimand

Value: 'group_time_att'

‘group_time_att’

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.estimand

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.model

model

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.model

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.estimator

estimator

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.estimator

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.control_group

control_group

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.control_group

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.anticipation

anticipation

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.anticipation

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.base_period

base_period

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.base_period

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.include_pre_periods

include_pre_periods

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.include_pre_periods

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.alpha

alpha

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.alpha

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.att_gt

att_gt

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.att_gt

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.aggregates

aggregates

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.aggregates

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.support

support

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.support

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.skipped_cells

skipped_cells

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.skipped_cells

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.outcome

outcome

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.outcome

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.treatment

treatment

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.treatment

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.unit_col

unit_col

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.unit_col

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.time_col

time_col

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.time_col

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.covariates

covariates

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.covariates

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.cluster_col

cluster_col

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.cluster_col

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.inference

inference

Value: None

None

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.inference

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.diagnostics

diagnostics

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.diagnostics

Link to this symbol
attribute
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.created_at

created_at

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.created_at

Link to this symbol
property
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.att

att

Simple overall ATT, weighting each treated cohort-time observation equally.

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.att

Link to this symbol
property
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.value

value

Alias for the simple overall ATT.

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.value

Link to this symbol
property
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.se

se

Standard error for the simple overall ATT.

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.se

Link to this symbol
property
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.std_error

std_error

Alias for the simple overall ATT standard error.

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.std_error

Link to this symbol
property
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.ci_lower

ci_lower

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.ci_lower

Link to this symbol
property
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.ci_upper

ci_upper

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.ci_upper

Link to this symbol
property
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.p_value

p_value

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.p_value

Link to this symbol
property
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.diagnostic_data

diagnostic_data

Compatibility alias for callers moving from older DID result objects.

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.diagnostic_data

Link to this symbol
method
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.aggregate

aggregate

Return an aggregate table: simple, cohort, calendar, or event.

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.aggregate

Link to this symbol
method
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.event_study

event_study

Return dynamic effects by event time.

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.event_study

Link to this symbol
method
causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.summary

summary

Return a compact summary of the simple overall ATT.

Canonical target

causalis.data_contracts.panel_did_estimate.CallawaySantAnnaDIDEstimate.summary

Link to this symbol