Merge pull request #211 from KhiopsML/176-add-deprecation-warnings-for-removals-in-khiops-v11

176 add deprecation warnings for removals in khiops v11

Author: folmos-at-orange

.github/workflows/release.yml

@@ -0,0 +1,35 @@
+---
+name: Release
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Version of the release
+jobs:
+  release:
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          # Get Git tags so that versioneer can function correctly
+          # See issue https://github.com/actions/checkout/issues/701
+          fetch-depth: 0
+      - name: Update "main" branch
+        run: |-
+          # Merge dev into main, tag the merge commit
+          git merge --no-ff -m'Merge branch 'dev' for release ${{ inputs.version }}' dev
+          git tag ${{ inputs.version }}
+
+          # Make dev point to main
+          git switch dev
+          git reset --hard main
+
+          # Update remotes
+          git switch dev
+          git push
+          git switch main
+          git push

khiops/core/api.py

@@ -199,7 +199,7 @@ def _preprocess_task_arguments(task_args):
         else:
             if not task_args["target_variable"] and task_args[
                 "discretization_method"
-            ] not in ("EqualWidth", "EqualLenght", "None"):
+            ] not in ("EqualWidth", "EqualFrequency", "None"):
                 raise ValueError(
                     "'discretization_method' must be either "
                     "'EqualWidth', 'EqualFrequency' or 'None'."
@@ -261,6 +261,44 @@ def _preprocess_task_arguments(task_args):
         if isinstance(task_args["selection_value"], (int, float)):
             task_args["selection_value"] = str(task_args["selection_value"])
 
+    # Warn the simple deprecations for Khiops 11
+    simple_khiops_11_deprecations = [
+        ("max_groups", "the upcoming 'max_parts' parameter", 0),
+        ("max_intervals", "the upcoming 'max_parts' parameter", 0),
+        ("min_group_frequency", None, 0),
+        ("min_interval_frequency", None, 0),
+        ("results_prefix", None, ""),
+        ("snb_predictor", None, True),
+        ("univariate_predictor_number", None, 0),
+    ]
+    for param, replacement_param, param_default_value in simple_khiops_11_deprecations:
+        if param in task_args and task_args[param] != param_default_value:
+            warnings.warn(
+                deprecation_message(
+                    f"'{param}'", "11.0.0", replacement=replacement_param, quote=False
+                )
+            )
+
+    # Warn the grouping/interval supervised method deprecation values for Khiops 11
+    if "target_variable" in task_args and task_args["target_variable"] != "":
+        if "grouping_method" in task_args and task_args["grouping_method"] != "MODL":
+            warnings.warn(
+                deprecation_message(
+                    "'grouping_method' on supervised learning", "11.0.0", quote=False
+                )
+            )
+        if (
+            "discretization_method" in task_args
+            and task_args["discretization_method"] != "MODL"
+        ):
+            warnings.warn(
+                deprecation_message(
+                    f"'discretization_method' on supervised learning",
+                    "11.0.0",
+                    quote=False,
+                )
+            )
+
     return task_called_with_domain
 
 
@@ -679,8 +717,8 @@ def train_predictor(
         Maximum number of variables pairs to construct.
     specific_pairs : list of tuple, optional
         User-specified pairs as a list of 2-tuples of variable names. If a given tuple
-        contains only one non-empty string generated within the maximum limit
-        ``max_pairs``.
+        contains only one non-empty variable name, then it generates all the pairs
+        containing it (within the limit ``max_pairs``).
     all_possible_pairs : bool, default ``True``
         If ``True`` tries to create all possible pairs within the limit ``max_pairs``.
         The pairs and variables given in ``specific_pairs`` have priority.
@@ -989,8 +1027,8 @@ def train_recoder(
         Maximum number of variables pairs to construct.
     specific_pairs : list of tuple, optional
         User-specified pairs as a list of 2-tuples of variable names. If a given tuple
-        contains only one non-empty string generated within the maximum limit
-        ``max_pairs``.
+        contains only one non-empty variable name, then it generates all the pairs
+        containing it (within the limit ``max_pairs``).
     all_possible_pairs : bool, default ``True``
         If ``True`` tries to create all possible pairs within the limit ``max_pairs``.
         The pairs and variables given in ``specific_pairs`` have priority.