Add text about models

Quantco · Jun 24, 2024 · 24c1a03 · 24c1a03
1 parent 6444e57
commit 24c1a03
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/examples/example_basic.ipynb b/docs/examples/example_basic.ipynb
@@ -215,6 +215,14 @@
     "model a nuisance model, the initialization parameters for it are separated from the other\n",
     "nuisance parameters to allow a more understandable user interface, see the next code prompt.\n",
     "\n",
+    "In general, when initializing a MetaLearner the ``nuisance_model_factory`` parameter will\n",
+    "be used to create all the nuisance models which are not a propensity model,  the\n",
+    "``propensity_model_factory`` will be used for the propensity model if the MetaLearner\n",
+    "contains one, and the ``treatment_model_factory`` will be used for the models predicting\n",
+    "the CATE. To see the models present in each MetaLearner type see\n",
+    "{meth}`~metalearners.metalearner.MetaLearner.nuisance_model_specifications` and\n",
+    "{meth}`~metalearners.metalearner.MetaLearner.treatment_model_specifications`.\n",
+    "\n",
     "In the {class}`~metalearners.RLearner` case, the ``nuisance_model_factory`` parameter will\n",
     "be used to create the outcome model, the ``propensity_model_factory`` will be used for the\n",
     "propensity model and the ``treatment_model_factory`` will be used for the model predicting\n",