# {py:mod}`causalis.scenarios.cuped.model`

```{py:module} causalis.scenarios.cuped.model
```

```{autodoc2-docstring} causalis.scenarios.cuped.model
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`CUPEDModel <causalis.scenarios.cuped.model.CUPEDModel>`
  - ```{autodoc2-docstring} causalis.scenarios.cuped.model.CUPEDModel
    :summary:
    ```
````

### API

`````{py:class} CUPEDModel(cov_type: str = 'HC2', alpha: float = 0.05, use_t: typing.Optional[bool] = None, use_t_auto_n_threshold: int = 5000, relative_ci_method: typing.Literal[delta, bootstrap] = 'delta', relative_denominator: typing.Literal[adjusted_control, raw_control] = 'adjusted_control', relative_ci_bootstrap_draws: int = 1000, relative_ci_bootstrap_seed: typing.Optional[int] = None, refutation_config: typing.Optional[causalis.scenarios.cuped.refutation.config.CUPEDRefutationConfig] = None, covariate_variance_min: float = 1e-12)
:canonical: causalis.scenarios.cuped.model.CUPEDModel

```{autodoc2-docstring} causalis.scenarios.cuped.model.CUPEDModel
```

```{rubric} Initialization
```

```{autodoc2-docstring} causalis.scenarios.cuped.model.CUPEDModel.__init__
```

````{py:method} fit(data: causalis.dgp.causaldata.CausalData, covariates: typing.Optional[typing.Sequence[str]] = None, run_checks: typing.Optional[bool] = None) -> causalis.scenarios.cuped.model.CUPEDModel
:canonical: causalis.scenarios.cuped.model.CUPEDModel.fit

```{autodoc2-docstring} causalis.scenarios.cuped.model.CUPEDModel.fit
```

````

````{py:method} estimate(alpha: typing.Optional[float] = None, diagnostic_data: bool = True) -> causalis.data_contracts.causal_estimate.CausalEstimate
:canonical: causalis.scenarios.cuped.model.CUPEDModel.estimate

```{autodoc2-docstring} causalis.scenarios.cuped.model.CUPEDModel.estimate
```

````

````{py:method} summary_dict(alpha: typing.Optional[float] = None) -> typing.Dict[str, typing.Any]
:canonical: causalis.scenarios.cuped.model.CUPEDModel.summary_dict

```{autodoc2-docstring} causalis.scenarios.cuped.model.CUPEDModel.summary_dict
```

````

````{py:method} assumptions_table() -> typing.Optional[pandas.DataFrame]
:canonical: causalis.scenarios.cuped.model.CUPEDModel.assumptions_table

```{autodoc2-docstring} causalis.scenarios.cuped.model.CUPEDModel.assumptions_table
```

````

````{py:method} __repr__() -> str
:canonical: causalis.scenarios.cuped.model.CUPEDModel.__repr__

````

`````
