DOC: replace '*' with '\cdot' in LaTeX formulæ

BCG-X-Official · May 17, 2023 · b921823 · b921823
1 parent c1169a7
commit b921823
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/src/facet/data/partition/_partition.py b/src/facet/data/partition/_partition.py
@@ -215,7 +215,7 @@ def fit(  # type: ignore[override]
         as optional arguments.
         If no bounds are provided, the partitioner automatically chooses the lower
         and upper outlier thresholds based on the Tukey test, i.e.,
-        :math:`[- 1.5 * \mathit{iqr}, 1.5 * \mathit{iqr}]`
+        :math:`[- 1.5 \cdot \mathit{iqr}, 1.5 \cdot \mathit{iqr}]`
         where :math:`\mathit{iqr}` is the inter-quartile range.
 
         :param values: a sequence of observed values as the empirical basis for

diff --git a/src/facet/inspection/shap/_shap.py b/src/facet/inspection/shap/_shap.py
@@ -200,7 +200,7 @@ def fit(
     def shap_values(self) -> pd.DataFrame:
         r"""
         The SHAP values per observation and feature, with shape
-        :math:`(n_\mathrm{observations}, n_\mathrm{outputs} * n_\mathrm{features})`
+        :math:`(n_\mathrm{observations}, n_\mathrm{outputs} \cdot n_\mathrm{features})`
         """
 
         assert self.shap_ is not None, ASSERTION__CALCULATOR_IS_FITTED
@@ -214,8 +214,8 @@ def shap_values(self) -> pd.DataFrame:
     def shap_interaction_values(self) -> pd.DataFrame:
         r"""
         The SHAP interaction values per observation and feature pair, with shape
-        :math:`(n_\mathrm{observations} * n_\mathrm{features}, n_\mathrm{outputs} *
-        n_\mathrm{features})`
+        :math:`(n_\mathrm{observations} \cdot n_\mathrm{features}, n_\mathrm{outputs}
+        \cdot n_\mathrm{features})`
 
         :raise AttributeError: this SHAP calculator does not support interaction values
         """
@@ -231,7 +231,7 @@ def main_effects(self) -> pd.DataFrame:
         r"""
         The main effects per observation and featuren (i.e., the diagonals of the
         interaction matrices), with shape
-        :math:`(n_\mathrm{observations}, n_\mathrm{outputs} * n_\mathrm{features})`.
+        :math:`(n_\mathrm{observations}, n_\mathrm{outputs} \cdot n_\mathrm{features})`.
 
         :raise AttributeError: this SHAP calculator does not support interaction values
         """