Add deprecation warning to train method

gretelai · May 22, 2023 · 8360d3a · 8360d3a
1 parent 28626af
commit 8360d3a
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/src/gretel_trainer/relational/multi_table.py b/src/gretel_trainer/relational/multi_table.py
@@ -803,7 +803,13 @@ def _train_synthetics_models(self, training_data: dict[str, Path]) -> None:
                 )
 
     def train(self) -> None:
-        """Train synthetic data models on each table in the relational dataset"""
+        """
+        DEPRECATED: Please use `train_synthetics` instead.
+        """
+        logger.warning(
+            "This method is deprecated and will be removed in a future release. "
+            "Please use `train_synthetics` instead."
+        )
         tables = self.relational_data.list_all_tables()
         self._synthetics_train = SyntheticsTrain()