Skip to content
Submodule
causalis.data_contracts.iv_causal_estimate

iv_causal_estimate

Submodule causalis.data_contracts.iv_causal_estimate with no child pages and 23 documented members.

Symbol indexAPI membersIVCausalEstimatemodel_configestimandmodel

Classes

Jump directly into the documented classes for this page.

1 items
IVCausalEstimateclass
class
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate

IVCausalEstimate

Bases: pydantic.BaseModel

Result container for instrumental-variable causal effect 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.iv_causal_estimate.IVCausalEstimate

Sections

Initialization
Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.model_config

model_config

Value: 'ConfigDict(...)'

‘ConfigDict(…)’

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.model_config

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.estimand

estimand

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.estimand

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.model

model

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.model

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.model_options

model_options

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.model_options

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.value

value

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.value

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.std_error

std_error

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.std_error

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.t_stat

t_stat

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.t_stat

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.p_value

p_value

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.p_value

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.ci_lower_absolute

ci_lower_absolute

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.ci_lower_absolute

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.ci_upper_absolute

ci_upper_absolute

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.ci_upper_absolute

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.value_relative

value_relative

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.value_relative

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.ci_lower_relative

ci_lower_relative

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.ci_lower_relative

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.ci_upper_relative

ci_upper_relative

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.ci_upper_relative

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.alpha

alpha

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.alpha

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.is_significant

is_significant

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.is_significant

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.outcome

outcome

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.outcome

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.treatment

treatment

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.treatment

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.instrument

instrument

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.instrument

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.confounders

confounders

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.confounders

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.time

time

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.time

Link to this symbol
attribute
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.diagnostic_data

diagnostic_data

Value: None

None

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.diagnostic_data

Link to this symbol
method
causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.summary

summary

Return a vertical summary DataFrame of the results.

Canonical target

causalis.data_contracts.iv_causal_estimate.IVCausalEstimate.summary

Link to this symbol