Fixed docs warnings

mad-lab-fau · Sep 14, 2023 · a4518d0 · a4518d0
1 parent 6fbd288
commit a4518d0
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/tpcp/optimize/optuna.py b/tpcp/optimize/optuna.py
@@ -86,11 +86,11 @@ class _CustomOptunaOptimize(BaseOptimize[PipelineT, DatasetT]):
 
     @property
     def search_results_(self) -> Dict[str, Sequence[Any]]:
-        """Detailed results of the study.
+        r"""Detailed results of the study.
 
         This basically contains the same information as `self.study_.trials_dataframe()`, with some small modifications:
 
-        - columns starting with "params_" are renamed to "param_"
+        - columns starting with "params\_" are renamed to "param\_"
         - a new column called "params" containing all parameters as dict is added
         - "value" is renamed to score"
         - the score of pruned trials is set to `np.nan`