Skip to content
Submodule
causalis.data_contracts.causaldata

causaldata

Submodule causalis.data_contracts.causaldata with no child pages and 15 documented members.

Symbol indexAPI membersCausalDatamodel_configdftreatment_name

Classes

Jump directly into the documented classes for this page.

1 items
CausalDataclass
class
causalis.data_contracts.causaldata.CausalData

CausalData

Bases: pydantic.BaseModel

Container for causal inference datasets.

Wraps a pandas DataFrame and stores the names of treatment, outcome, and optional confounder columns. The stored DataFrame is restricted to only those columns. Uses Pydantic for validation and as a data_contracts contract.

Attributes

dfpd.DataFrame

The DataFrame containing the data_contracts restricted to outcome, treatment, and confounder columns. NaN values are not allowed in the used columns.

treatment_namestr

Column name representing the treatment variable.

outcome_namestr

Column name representing the outcome variable.

confounders_namesList[str]

Names of the confounder columns (may be empty).

user_id_namestr, optional

Column name representing the unique identifier for each observation/user.

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.causaldata.CausalData

Sections

AttributesInitialization
Link to this symbol
attribute
causalis.data_contracts.causaldata.CausalData.model_config

model_config

Value: 'ConfigDict(...)'

‘ConfigDict(…)’

Canonical target

causalis.data_contracts.causaldata.CausalData.model_config

Link to this symbol
attribute
causalis.data_contracts.causaldata.CausalData.df

df

Value: None

None

Canonical target

causalis.data_contracts.causaldata.CausalData.df

Link to this symbol
attribute
causalis.data_contracts.causaldata.CausalData.treatment_name

treatment_name

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.causaldata.CausalData.treatment_name

Link to this symbol
attribute
causalis.data_contracts.causaldata.CausalData.outcome_name

outcome_name

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.causaldata.CausalData.outcome_name

Link to this symbol
attribute
causalis.data_contracts.causaldata.CausalData.confounders_names

confounders_names

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.causaldata.CausalData.confounders_names

Link to this symbol
attribute
causalis.data_contracts.causaldata.CausalData.user_id_name

user_id_name

Value: 'Field(...)'

‘Field(…)’

Canonical target

causalis.data_contracts.causaldata.CausalData.user_id_name

Link to this symbol
method
causalis.data_contracts.causaldata.CausalData.from_df

from_df

Friendly constructor for CausalData.

Parameters

dfpd.DataFrame

The DataFrame containing the data_contracts.

treatmentstr

Column name representing the treatment variable.

outcomestr

Column name representing the outcome variable.

confoundersUnion[str, List[str]], optional

Column name(s) representing the confounders/covariates.

user_idstr, optional

Column name representing the unique identifier for each observation/user.

**kwargsAny

Additional arguments passed to the Pydantic model constructor.

Returns

CausalData

A validated CausalData instance.

Canonical target

causalis.data_contracts.causaldata.CausalData.from_df

Sections

ParametersReturns
Link to this symbol
property
causalis.data_contracts.causaldata.CausalData.outcome

outcome

Outcome column as a Series.

Returns

pd.Series

The outcome column.

Canonical target

causalis.data_contracts.causaldata.CausalData.outcome

Sections

Returns
Link to this symbol
property
causalis.data_contracts.causaldata.CausalData.treatment

treatment

Treatment column as a Series.

Returns

pd.Series

The treatment column.

Canonical target

causalis.data_contracts.causaldata.CausalData.treatment

Sections

Returns
Link to this symbol
property
causalis.data_contracts.causaldata.CausalData.confounders

confounders

List of confounder column names.

Returns

List[str]

Names of the confounder columns.

Canonical target

causalis.data_contracts.causaldata.CausalData.confounders

Sections

Returns
Link to this symbol
property
causalis.data_contracts.causaldata.CausalData.user_id

user_id

user_id column as a Series.

Returns

pd.Series

The user_id column.

Canonical target

causalis.data_contracts.causaldata.CausalData.user_id

Sections

Returns
Link to this symbol
property
causalis.data_contracts.causaldata.CausalData.X

X

Design matrix of confounders.

Returns

pd.DataFrame

The DataFrame containing only confounder columns.

Canonical target

causalis.data_contracts.causaldata.CausalData.X

Sections

Returns
Link to this symbol
method
causalis.data_contracts.causaldata.CausalData.get_df

get_df

Get a DataFrame with specified columns.

Parameters

columnsList[str], optional

Specific column names to include.

include_treatmentbool, default True

Whether to include the treatment column.

include_outcomebool, default True

Whether to include the outcome column.

include_confoundersbool, default True

Whether to include confounder columns.

include_user_idbool, default False

Whether to include the user_id column.

Returns

pd.DataFrame

A copy of the internal DataFrame with selected columns.

Raises

ValueError

If any specified columns do not exist.

Canonical target

causalis.data_contracts.causaldata.CausalData.get_df

Sections

ParametersReturnsRaises
Link to this symbol
method
causalis.data_contracts.causaldata.CausalData.__repr__

__repr__

Canonical target

causalis.data_contracts.causaldata.CausalData.__repr__

Link to this symbol