23075: Sets default value of use_sdm to True from None (#377)

Author: mkoistinen

howso/client/base.py

@@ -4039,7 +4039,7 @@ def analyze(
         targeted_model: t.Optional[TargetedModel] = None,
         use_case_weights: t.Optional[bool] = None,
         use_deviations: t.Optional[bool] = None,
-        use_sdm: t.Optional[bool] = None,
+        use_sdm: t.Optional[bool] = True,
         weight_feature: t.Optional[str] = None,
         **kwargs
     ):
@@ -4102,14 +4102,13 @@ def analyze(
             will be used if the Trainee has them.
         use_deviations : bool, optional
             When True, uses deviations for LK metric in queries.
-        use_sdm : bool, default None,
+        use_sdm : bool, default True,
             When True, Howso Engine will compute and use a sparse deviation
             matrix (SDM) for each nominal feature in all similarity queries.
             Enabling SDM will typically incur a small to moderate penalty on
             speed when using nominal features in inference in exchange for
             yielding higher quality inference. The magnitude of the changes are
             dependent on relationships among the data and the task at hand.
-            Howso Engine will default to True, if left unset.
         weight_feature : str, optional
             Name of feature whose values to use as case weights.
             When left unspecified uses the internally managed case weight.
@@ -4245,7 +4244,7 @@ def set_auto_analyze_params(
         targeted_model: t.Optional[TargetedModel] = None,
         use_deviations: t.Optional[bool] = None,
         use_case_weights: t.Optional[bool] = None,
-        use_sdm: t.Optional[bool] = None,
+        use_sdm: t.Optional[bool] = True,
         weight_feature: t.Optional[str] = None,
         **kwargs
     ):
@@ -4318,14 +4317,13 @@ def set_auto_analyze_params(
             If set to True, will scale influence weights by each case's
             `weight_feature` weight. If unspecified, case weights
             will be used if the Trainee has them.
-        use_sdm : bool, default None,
+        use_sdm : bool, default True,
             When True, Howso Engine will compute and use a sparse deviation
             matrix (SDM) for each nominal feature in all similarity queries.
             Enabling SDM will typically incur a small to moderate penalty on
             speed when using nominal features in inference in exchange for
             yielding higher quality inference. The magnitude of the changes are
             dependent on relationships among the data and the task at hand.
-            Howso Engine will default to True, if left unset.
         weight_feature : str
             Name of feature whose values to use as case weights.
             When left unspecified uses the internally managed case weight.

howso/engine/trainee.py

@@ -1050,14 +1050,13 @@ def analyze(
             be used if the Trainee has them.
         use_deviations : bool, default False
             When True, uses deviations for LK metric in queries.
-        use_sdm : bool, default None,
+        use_sdm : bool, default True,
             When True, Howso Engine will compute and use a sparse deviation
             matrix (SDM) for each nominal feature in all similarity queries.
             Enabling SDM will typically incur a small to moderate penalty on
             speed when using nominal features in inference in exchange for
             yielding higher quality inference. The magnitude of the changes are
             dependent on relationships among the data and the task at hand.
-            Howso Engine will default to True, if left unset.
         weight_feature : str, optional
             Name of feature whose values to use as case weights.
             When left unspecified uses the internally managed case weight.