Add a new note to mention unsupported GPU case

optuna · Aug 20, 2022 · f90e6e5 · f90e6e5
1 parent 5a1bb75
commit f90e6e5
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/optuna/integration/catboost.py b/optuna/integration/catboost.py
@@ -32,6 +32,11 @@ class CatBoostPruningCallback:
         after training manually unlike other pruning callbacks
         to raise :class:`optuna.TrialPruned`.
 
+    .. note::
+        This callback cannot be used with CatBoost on GPUs because CatBoost doesn't support
+        a user-defined callback for GPU.
+        Please refer to `CatBoost issue <https://github.com/catboost/catboost/issues/1792>`_.
+
     Args:
         trial:
             A :class:`~optuna.trial.Trial` corresponding to the current evaluation of the