Docs

Author: jmafoster1

causal_testing/discovery/hill_climber_discovery.py

@@ -68,8 +68,7 @@ def evaluate_fitness(
         Evaluate the fitness of a given causal DAG by evaluating the corresponding test cases using a tier based
         fitness metric.
         lexicographical order (max pass, minimise failure, minimise unknown)
-         e.g. (X pass, Y fail, Z+1 unknown) is better than (X pass, Y+1 fail, Z unknown)
-
+        e.g. (X pass, Y fail, Z+1 unknown) is better than (X pass, Y+1 fail, Z unknown)
 
         :param individual: The candidate individual to evaluate.
         :returns: Tuple of the form (X, Y), where X is a triple containing the number of passing, failing, and

docs/source/modules/estimators.rst

@@ -30,6 +30,18 @@ LogisticRegressionEstimator
    :show-inheritance:
    :noindex:
 
+MultinomialRegressionEstimator
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Recommended use:** For categorical outcomes (e.g. colurs: Red, Green, Blue).
+
+.. autoclass:: causal_testing.estimation.multinomial_regression_estimator.MultinomialRegressionEstimator
+   :members:
+   :exclude-members: from_formula, regressor
+   :undoc-members:
+   :show-inheritance:
+   :noindex:
+
 CubicSplineRegressionEstimator
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~