Skip to content
Submodule
causalis.data_contracts.gate_contrast_estimate

gate_contrast_estimate

Submodule causalis.data_contracts.gate_contrast_estimate with no child pages and 24 documented members.

Symbol indexAPI membersGateContrastEstimatemodel_configestimandmodel

Classes

Jump directly into the documented classes for this page.

1 items
GateContrastEstimateclass
class
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate

GateContrastEstimate

Bases: pydantic.BaseModel

Result contract for a post-estimation subgroup-effect contrast.

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.gate_contrast_estimate.GateContrastEstimate

Sections

Initialization
Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.model_config

model_config

Value: 'ConfigDict(...)'

‘ConfigDict(…)’

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.model_config

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.estimand

estimand

Value: 'GATE_CONTRAST'

‘GATE_CONTRAST’

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.estimand

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.model

model

Value: 'IRM'

‘IRM’

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.model

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.model_options

model_options

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.model_options

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.left_group

left_group

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.left_group

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.right_group

right_group

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.right_group

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.contrast_label

contrast_label

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.contrast_label

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.value

value

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.value

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.std_error

std_error

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.std_error

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.test_stat

test_stat

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.test_stat

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.p_value

p_value

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.p_value

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.ci_lower

ci_lower

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.ci_lower

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.ci_upper

ci_upper

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.ci_upper

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.alpha

alpha

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.alpha

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.alternative

alternative

Value: 'two-sided'

‘two-sided’

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.alternative

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.is_significant

is_significant

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.is_significant

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.left_value

left_value

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.left_value

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.right_value

right_value

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.right_value

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.n_left

n_left

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.n_left

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.n_right

n_right

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.n_right

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.time

time

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.time

Link to this symbol
attribute
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.diagnostic_data

diagnostic_data

Value: None

None

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.diagnostic_data

Link to this symbol
method
causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.summary

summary

Return a CausalEstimate-style summary for the requested contrast.

Canonical target

causalis.data_contracts.gate_contrast_estimate.GateContrastEstimate.summary

Link to this symbol