Skip to content
Submodule
causalis.data_contracts.causal_diagnostic_data

causal_diagnostic_data

Submodule causalis.data_contracts.causal_diagnostic_data with no child pages and 61 documented members.

Symbol indexAPI membersDiagnosticDatamodel_configUnconfoundednessDiagnosticDatam_hat

Classes

Jump directly into the documented classes for this page.

5 items
DiagnosticDataclassUnconfoundednessDiagnosticDataclassMultiUnconfoundednessDiagnosticDataclassDiffInMeansDiagnosticDataclassCUPEDDiagnosticDataclass
class
causalis.data_contracts.causal_diagnostic_data.DiagnosticData

DiagnosticData

Bases: pydantic.BaseModel

Base class for all diagnostic data_contracts.

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.causal_diagnostic_data.DiagnosticData

Sections

Initialization
Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.DiagnosticData.model_config

model_config

Value: 'ConfigDict(...)'

‘ConfigDict(…)’

Canonical target

causalis.data_contracts.causal_diagnostic_data.DiagnosticData.model_config

Link to this symbol
class
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData

UnconfoundednessDiagnosticData

Bases: causalis.data_contracts.causal_diagnostic_data.DiagnosticData

Fields common to all models assuming unconfoundedness.

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.causal_diagnostic_data.UnconfoundednessDiagnosticData

Sections

Initialization
Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.m_hat

m_hat

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.m_hat

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.m_hat_raw

m_hat_raw

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.m_hat_raw

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.d

d

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.d

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.y

y

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.y

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.x

x

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.x

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.g0_hat

g0_hat

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.g0_hat

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.g1_hat

g1_hat

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.g1_hat

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.w

w

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.w

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.w_bar

w_bar

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.w_bar

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.psi_b

psi_b

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.psi_b

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.folds

folds

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.folds

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.trimming_threshold

trimming_threshold

Value: 0.0

0.0

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.trimming_threshold

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.normalize_ipw

normalize_ipw

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.normalize_ipw

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.sigma2

sigma2

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.sigma2

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.nu2

nu2

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.nu2

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.psi_sigma2

psi_sigma2

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.psi_sigma2

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.psi_nu2

psi_nu2

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.psi_nu2

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.riesz_rep

riesz_rep

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.riesz_rep

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.m_alpha

m_alpha

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.m_alpha

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.psi

psi

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.psi

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.score

score

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.score

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.sensitivity_analysis

sensitivity_analysis

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.sensitivity_analysis

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.score_plot_cache

score_plot_cache

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.score_plot_cache

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.residual_plot_cache

residual_plot_cache

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.UnconfoundednessDiagnosticData.residual_plot_cache

Link to this symbol
class
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData

MultiUnconfoundednessDiagnosticData

Bases: causalis.data_contracts.causal_diagnostic_data.DiagnosticData

Fields common to all models assuming unconfoundedness with multi_unconfoundedness.

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.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData

Sections

Initialization
Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.m_hat

m_hat

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.m_hat

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.m_hat_raw

m_hat_raw

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.m_hat_raw

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.d

d

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.d

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.y

y

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.y

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.x

x

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.x

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.g_hat

g_hat

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.g_hat

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.psi_b

psi_b

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.psi_b

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.folds

folds

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.folds

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.trimming_threshold

trimming_threshold

Value: 0.0

0.0

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.trimming_threshold

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.normalize_ipw

normalize_ipw

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.normalize_ipw

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.sigma2

sigma2

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.sigma2

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.nu2

nu2

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.nu2

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.psi_sigma2

psi_sigma2

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.psi_sigma2

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.psi_nu2

psi_nu2

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.psi_nu2

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.riesz_rep

riesz_rep

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.riesz_rep

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.m_alpha

m_alpha

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.m_alpha

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.psi

psi

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.psi

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.score

score

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.score

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.sensitivity_analysis

sensitivity_analysis

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.sensitivity_analysis

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.residual_plot_cache

residual_plot_cache

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.MultiUnconfoundednessDiagnosticData.residual_plot_cache

Link to this symbol
class
causalis.data_contracts.causal_diagnostic_data.DiffInMeansDiagnosticData

DiffInMeansDiagnosticData

Bases: causalis.data_contracts.causal_diagnostic_data.DiagnosticData

Diagnostic data_contracts for Difference-in-Means model.

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.causal_diagnostic_data.DiffInMeansDiagnosticData

Sections

Initialization
Link to this symbol
class
causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData

CUPEDDiagnosticData

Bases: causalis.data_contracts.causal_diagnostic_data.DiagnosticData

Diagnostic data_contracts for CUPED-style (Lin-interacted OLS) adjustment.

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.causal_diagnostic_data.CUPEDDiagnosticData

Sections

Initialization
Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.ate_naive

ate_naive

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.ate_naive

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.se_naive

se_naive

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.se_naive

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.se_reduction_pct_same_cov

se_reduction_pct_same_cov

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.se_reduction_pct_same_cov

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.r2_naive

r2_naive

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.r2_naive

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.r2_adj

r2_adj

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.r2_adj

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.beta_covariates

beta_covariates

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.beta_covariates

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.gamma_interactions

gamma_interactions

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.gamma_interactions

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.covariate_outcome_corr

covariate_outcome_corr

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.covariate_outcome_corr

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.covariates

covariates

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.covariates

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.adj_type

adj_type

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.adj_type

Link to this symbol
attribute
causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.regression_checks

regression_checks

Value: None

None

Canonical target

causalis.data_contracts.causal_diagnostic_data.CUPEDDiagnosticData.regression_checks

Link to this symbol