diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 9c7b3a5..fe1346d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -28,7 +28,9 @@ jobs: - name: Render & Publish Docs shell: bash -l {0} run: | + set -e source .venv/bin/activate + bash docs/marimo_examples_to_quarto.sh quartodoc build --config docs/_quarto.yml quarto render docs/ diff --git a/README.md b/README.md index 3d89f2f..59b1e11 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
-CaML Logo +CaML Logo [![image](https://img.shields.io/pypi/v/caml.svg)](https://pypi.python.org/pypi/caml) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) diff --git a/docs/03_Examples/Synthetic Data Generation.qmd b/docs/03_Examples/Synthetic Data Generation.qmd index 8350a51..e8c8fa1 100644 --- a/docs/03_Examples/Synthetic Data Generation.qmd +++ b/docs/03_Examples/Synthetic Data Generation.qmd @@ -25,13 +25,13 @@ data = CamlSyntheticDataGenerator(n_obs=10_000, n_cont_confounders=1, n_binary_confounders=1, n_discrete_confounders=1, - n_cont_heterogeneity_covariates=1, - n_binary_heterogeneity_covariates=1, - n_discrete_heterogeneity_covariates=1, - n_heterogeneity_confounders=1, + n_cont_modifiers=1, + n_binary_modifiers=1, + n_discrete_modifiers=1, + n_confounding_modifiers=1, stddev_outcome_noise=3, stddev_treatment_noise=3, - causal_model_functional_form="fully_nonlinear", + causal_model_functional_form="linear", n_nonlinear_transformations=10, n_nonlinear_interactions=5, seed=15) @@ -46,7 +46,9 @@ data.df ## DGP ```{python} -data.dgp +for k,v in data.dgp.items(): + print(k) + print(v) ``` ## True Conditional Average Treatment Effects (CATEs) @@ -60,3 +62,4 @@ data.cates ```{python} data.ates ``` + diff --git a/docs/_quarto.yml b/docs/_quarto.yml index e45eb20..ee55ed3 100644 --- a/docs/_quarto.yml +++ b/docs/_quarto.yml @@ -12,6 +12,9 @@ format: table-scroll: true code-fold: true +execute: + error: halt + website: title: CaML - Causal ML favicon: assets/logo_no_text.svg diff --git a/docs/assets/marimo/Synthetic Data Generation.ipynb b/docs/assets/marimo/Synthetic Data Generation.ipynb index 4564b4d..6059955 100644 --- a/docs/assets/marimo/Synthetic Data Generation.ipynb +++ b/docs/assets/marimo/Synthetic Data Generation.ipynb @@ -12,7 +12,9 @@ } }, "outputs": [], - "source": [] + "source": [ + "import marimo as mo" + ] }, { "cell_type": "markdown", @@ -47,27 +49,25 @@ "metadata": {}, "outputs": [], "source": [ - "data = CamlSyntheticDataGenerator(\n", - " n_obs=10_000,\n", - " n_cont_outcomes=1,\n", - " n_binary_outcomes=1,\n", - " n_cont_treatments=1,\n", - " n_binary_treatments=1,\n", - " n_discrete_treatments=1,\n", - " n_cont_confounders=1,\n", - " n_binary_confounders=1,\n", - " n_discrete_confounders=1,\n", - " n_cont_heterogeneity_covariates=1,\n", - " n_binary_heterogeneity_covariates=1,\n", - " n_discrete_heterogeneity_covariates=1,\n", - " n_heterogeneity_confounders=1,\n", - " stddev_outcome_noise=3,\n", - " stddev_treatment_noise=3,\n", - " causal_model_functional_form=\"fully_nonlinear\",\n", - " n_nonlinear_transformations=10,\n", - " n_nonlinear_interactions=5,\n", - " seed=15,\n", - ")" + "data = CamlSyntheticDataGenerator(n_obs=10_000,\n", + " n_cont_outcomes=1,\n", + " n_binary_outcomes=1,\n", + " n_cont_treatments=1,\n", + " n_binary_treatments=1,\n", + " n_discrete_treatments=1,\n", + " n_cont_confounders=1,\n", + " n_binary_confounders=1,\n", + " n_discrete_confounders=1,\n", + " n_cont_modifiers=1,\n", + " n_binary_modifiers=1,\n", + " n_discrete_modifiers=1,\n", + " n_confounding_modifiers=1,\n", + " stddev_outcome_noise=3,\n", + " stddev_treatment_noise=3,\n", + " causal_model_functional_form=\"linear\",\n", + " n_nonlinear_transformations=10,\n", + " n_nonlinear_interactions=5,\n", + " seed=15)" ] }, { @@ -103,7 +103,9 @@ "metadata": {}, "outputs": [], "source": [ - "data.dgp" + "for k,v in data.dgp.items():\n", + " print(k)\n", + " print(v)" ] }, { diff --git a/notebooks/examples/Synthetic Data Generation.py b/notebooks/examples/Synthetic Data Generation.py index f4c2ea2..eec65ab 100644 --- a/notebooks/examples/Synthetic Data Generation.py +++ b/notebooks/examples/Synthetic Data Generation.py @@ -1,6 +1,6 @@ import marimo -__generated_with = "0.10.4" +__generated_with = "0.10.15" app = marimo.App(width="medium") @@ -39,13 +39,13 @@ def _(CamlSyntheticDataGenerator): n_cont_confounders=1, n_binary_confounders=1, n_discrete_confounders=1, - n_cont_heterogeneity_covariates=1, - n_binary_heterogeneity_covariates=1, - n_discrete_heterogeneity_covariates=1, - n_heterogeneity_confounders=1, + n_cont_modifiers=1, + n_binary_modifiers=1, + n_discrete_modifiers=1, + n_confounding_modifiers=1, stddev_outcome_noise=3, stddev_treatment_noise=3, - causal_model_functional_form="fully_nonlinear", + causal_model_functional_form="linear", n_nonlinear_transformations=10, n_nonlinear_interactions=5, seed=15) @@ -102,10 +102,5 @@ def _(data): return -@app.cell -def _(): - return - - if __name__ == "__main__": app.run()