autogluon.tabular 1.2.1b20250218__py3-none-any.whl → 1.2.1b20250220__py3-none-any.whl

autogluon/tabular/predictor/predictor.py

@@ -57,7 +57,6 @@ from ..learner import AbstractTabularLearner, DefaultLearner
 from ..trainer.abstract_trainer import AbstractTabularTrainer
 from ..trainer.model_presets.presets import MODEL_TYPES
 from ..version import __version__
-from ._deprecated_methods import TabularPredictorDeprecatedMixin
 
 logger = logging.getLogger(__name__)  # return autogluon root logger
 
@@ -68,7 +67,7 @@ logger = logging.getLogger(__name__)  # return autogluon root logger
 # TODO: consider adding kwarg option for data which has already been preprocessed by feature generator to skip feature generation.
 # TODO: Resolve raw text feature usage in default feature generator
 # TODO: num_bag_sets -> ag_args
-class TabularPredictor(TabularPredictorDeprecatedMixin):
+class TabularPredictor:
     """
     AutoGluon TabularPredictor predicts values in a column of a tabular dataset (classification or regression).
 
@@ -3793,6 +3792,80 @@ class TabularPredictor(TabularPredictorDeprecatedMixin):
         self._assert_is_fit("info")
         return self._learner.get_info(include_model_info=True, include_model_failures=True)
 
+    def model_info(self, model: str) -> dict:
+        """
+        Returns metadata information about the given model.
+        Equivalent output to `predictor.info()["model_info"][model]`
+
+        Parameters
+        ----------
+        model: str
+            The name of the model to get info for.
+
+        Returns
+        -------
+        model_info: dict
+            Model info dictionary
+
+        """
+        return self._trainer.get_model_info(model=model)
+
+    # TODO: Add entire `hyperparameters` dict method for multiple models (including stack ensemble)
+    # TODO: Add unit test
+    def model_hyperparameters(
+        self,
+        model: str,
+        include_ag_args_ensemble: bool = True,
+        output_format: Literal["user", "all"] = "user",
+    ) -> dict:
+        """
+        Returns the hyperparameters of a given model.
+
+        Parameters
+        ----------
+        model: str
+            The name of the model to get hyperparameters for.
+        include_ag_args_ensemble: bool, default True
+            If True, includes the ag_args_ensemble parameters if they exist (for example, when bagging is enabled).
+        output_format: {"user", "all"}, default "user"
+            If "user", returns the same hyperparameters specified by the user (only non-defaults).
+            If "all", returns all hyperparameters used by the model (including default hyperparameters not specified by the user)
+            Regardless of the output_format, they both are functionally equivalent if passed to AutoGluon.
+
+        Returns
+        -------
+        model_hyperparameters: dict
+            Dictionary of model hyperparameters.
+            Equivalent to the model_hyperparameters specified by the user for this model in:
+                `predictor.fit(..., hyperparameters={..., model_key: [..., model_hyperparameters]})`
+
+        """
+        # TODO: Move logic into trainer?
+        info_model = self.model_info(model=model)
+        if output_format == "user":
+            if "bagged_info" in info_model:
+                hyperparameters = info_model["bagged_info"]["child_hyperparameters_user"].copy()
+                if include_ag_args_ensemble and info_model["hyperparameters_user"]:
+                    hyperparameters["ag_args_ensemble"] = info_model["hyperparameters_user"]
+            else:
+                hyperparameters = info_model["hyperparameters_user"]
+        elif output_format == "all":
+            if "bagged_info" in info_model:
+                hyperparameters = info_model["bagged_info"]["child_hyperparameters"].copy()
+                if info_model["bagged_info"]["child_ag_args_fit"]:
+                    hyperparameters["ag_args_fit"] = info_model["bagged_info"]["child_ag_args_fit"]
+                if include_ag_args_ensemble:
+                    bag_hyperparameters = info_model["hyperparameters"].copy()
+                    if info_model["ag_args_fit"]:
+                        bag_hyperparameters["ag_args_fit"] = info_model["ag_args_fit"]
+                    if bag_hyperparameters:
+                        hyperparameters["ag_args_ensemble"] = bag_hyperparameters
+            else:
+                hyperparameters = info_model["hyperparameters"]
+        else:
+            raise ValueError(f"output_format={output_format} is unknown!")
+        return hyperparameters
+
     # TODO: Add data argument
     # TODO: Add option to disable OOF generation of newly fitted models
     # TODO: Move code logic to learner/trainer

autogluon/tabular/version.py

@@ -1,4 +1,4 @@
 """This is the autogluon version file."""
 
-__version__ = "1.2.1b20250218"
+__version__ = "1.2.1b20250220"
 __lite__ = False

{autogluon.tabular-1.2.1b20250218.dist-info → autogluon.tabular-1.2.1b20250220.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: autogluon.tabular
-Version: 1.2.1b20250218
+Version: 1.2.1b20250220
 Summary: Fast and Accurate ML in 3 Lines of Code
 Home-page: https://github.com/autogluon/autogluon
 Author: AutoGluon Community
@@ -41,19 +41,19 @@ Requires-Dist: scipy<1.16,>=1.5.4
 Requires-Dist: pandas<2.3.0,>=2.0.0
 Requires-Dist: scikit-learn<1.5.3,>=1.4.0
 Requires-Dist: networkx<4,>=3.0
-Requires-Dist: autogluon.core==1.2.1b20250218
-Requires-Dist: autogluon.features==1.2.1b20250218
+Requires-Dist: autogluon.core==1.2.1b20250220
+Requires-Dist: autogluon.features==1.2.1b20250220
 Provides-Extra: all
-Requires-Dist: huggingface-hub[torch]; extra == "all"
-Requires-Dist: xgboost<2.2,>=1.6; extra == "all"
+Requires-Dist: catboost<1.3,>=1.2; extra == "all"
+Requires-Dist: fastai<2.8,>=2.3.1; extra == "all"
+Requires-Dist: autogluon.core[all]==1.2.1b20250220; extra == "all"
 Requires-Dist: lightgbm<4.6,>=4.0; extra == "all"
-Requires-Dist: spacy<3.8; extra == "all"
-Requires-Dist: autogluon.core[all]==1.2.1b20250218; extra == "all"
+Requires-Dist: huggingface-hub[torch]; extra == "all"
 Requires-Dist: numpy<2.0.0,>=1.25; extra == "all"
-Requires-Dist: einops<0.9,>=0.7; extra == "all"
-Requires-Dist: catboost<1.3,>=1.2; extra == "all"
+Requires-Dist: xgboost<2.2,>=1.6; extra == "all"
 Requires-Dist: torch<2.6,>=2.2; extra == "all"
-Requires-Dist: fastai<2.8,>=2.3.1; extra == "all"
+Requires-Dist: einops<0.9,>=0.7; extra == "all"
+Requires-Dist: spacy<3.8; extra == "all"
 Provides-Extra: catboost
 Requires-Dist: numpy<2.0.0,>=1.25; extra == "catboost"
 Requires-Dist: catboost<1.3,>=1.2; extra == "catboost"
@@ -66,7 +66,7 @@ Requires-Dist: imodels<1.4.0,>=1.3.10; extra == "imodels"
 Provides-Extra: lightgbm
 Requires-Dist: lightgbm<4.6,>=4.0; extra == "lightgbm"
 Provides-Extra: ray
-Requires-Dist: autogluon.core[all]==1.2.1b20250218; extra == "ray"
+Requires-Dist: autogluon.core[all]==1.2.1b20250220; extra == "ray"
 Provides-Extra: skex
 Requires-Dist: scikit-learn-intelex<2025.1,>=2024.0; extra == "skex"
 Provides-Extra: skl2onnx

{autogluon.tabular-1.2.1b20250218.dist-info → autogluon.tabular-1.2.1b20250220.dist-info}/RECORD

@@ -1,6 +1,6 @@
-autogluon.tabular-1.2.1b20250218-py3.9-nspkg.pth,sha256=cQGwpuGPqg1GXscIwt-7PmME1OnSpD-7ixkikJ31WAY,554
+autogluon.tabular-1.2.1b20250220-py3.9-nspkg.pth,sha256=cQGwpuGPqg1GXscIwt-7PmME1OnSpD-7ixkikJ31WAY,554
 autogluon/tabular/__init__.py,sha256=2OXpJCvENRHubBTYNIPpHX93WWuFZzsJBtTZbNVHVas,400
-autogluon/tabular/version.py,sha256=7H9aiBFc3yZ4VAfYTXCxWQ-TNBEjD1nB5tqyO9XpoOs,91
+autogluon/tabular/version.py,sha256=5_5isKRJ9Kd7emAdEPGzl72mtp4GDkqLCtc4C6IuV6k,91
 autogluon/tabular/configs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 autogluon/tabular/configs/config_helper.py,sha256=Pb2aW9Z9w77pYKPRVZ3nBzHY3KJaiEJSJ747zZcJIVk,21132
 autogluon/tabular/configs/feature_generator_presets.py,sha256=EV5Ym8VW15q92MwOUpTi7wZFS2QooM51fLg3RdUsn-M,1223
@@ -142,9 +142,8 @@ autogluon/tabular/models/xgboost/hyperparameters/searchspaces.py,sha256=lFwI34pc
 autogluon/tabular/models/xt/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 autogluon/tabular/models/xt/xt_model.py,sha256=gimCfMeTmhAJTy4ekCI_dbK1FluJ7EQMoHt0pGMvVgs,759
 autogluon/tabular/predictor/__init__.py,sha256=zCMgjxQlWpDWnr1l1xjBCiK3rWC3N3RoD8UXBnazT74,107
-autogluon/tabular/predictor/_deprecated_methods.py,sha256=cBZjVYxY7blOj2eH1y9JsdW0n-AZtnsK4B6dzUqrTAw,3476
 autogluon/tabular/predictor/interpretable_predictor.py,sha256=5UeKgnMFsfY65tiO3kxfHBPr03lyswLrgdtjPhI0Y7Q,6934
-autogluon/tabular/predictor/predictor.py,sha256=cObeqYL75aqf2UNVbbY6HnO9nnJqmqyAYqgZdBYKfpM,352467
+autogluon/tabular/predictor/predictor.py,sha256=nJu66FgSjjKUrHmflj90eq0SlPfVluz-uI84E7zHL-k,355670
 autogluon/tabular/trainer/__init__.py,sha256=PW_PGL-tWoQzx3ES2S53bQEZOtsRWTYiM9QdOqsk0dI,38
 autogluon/tabular/trainer/abstract_trainer.py,sha256=daz6_IfYX9bvQ5c5RpbxZ9f5JytUDq2-XDO1wAXpXtk,231155
 autogluon/tabular/trainer/auto_trainer.py,sha256=FyRWM8iUJuDvw_aqV5EV_xdh_pb-nHzAvG1sbEhvs0g,8680
@@ -153,11 +152,11 @@ autogluon/tabular/trainer/model_presets/presets.py,sha256=1E-Z1FxUpyydaoEdxcTCg7
 autogluon/tabular/trainer/model_presets/presets_distill.py,sha256=MnFC2GJc6RmDBNAGbsO2XMfo3PjR8cUrZoilWW8gTYQ,3295
 autogluon/tabular/tuning/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 autogluon/tabular/tuning/feature_pruner.py,sha256=9iNku8gVbYEkjuKlyITPJDicsNkoraaQOlINQq9iZlQ,6877
-autogluon.tabular-1.2.1b20250218.dist-info/LICENSE,sha256=CeipvOyAZxBGUsFoaFqwkx54aPnIKEtm9a5u2uXxEws,10142
-autogluon.tabular-1.2.1b20250218.dist-info/METADATA,sha256=T4lgfczkCeVP2H9DrCFruDc6VrvKALXjVI8wW6En6aw,14386
-autogluon.tabular-1.2.1b20250218.dist-info/NOTICE,sha256=7nPQuj8Kp-uXsU0S5so3-2dNU5EctS5hDXvvzzehd7E,114
-autogluon.tabular-1.2.1b20250218.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-autogluon.tabular-1.2.1b20250218.dist-info/namespace_packages.txt,sha256=giERA4R78OkJf2ijn5slgjURlhRPzfLr7waIcGkzYAo,10
-autogluon.tabular-1.2.1b20250218.dist-info/top_level.txt,sha256=giERA4R78OkJf2ijn5slgjURlhRPzfLr7waIcGkzYAo,10
-autogluon.tabular-1.2.1b20250218.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-autogluon.tabular-1.2.1b20250218.dist-info/RECORD,,
+autogluon.tabular-1.2.1b20250220.dist-info/LICENSE,sha256=CeipvOyAZxBGUsFoaFqwkx54aPnIKEtm9a5u2uXxEws,10142
+autogluon.tabular-1.2.1b20250220.dist-info/METADATA,sha256=GX_UkgUo4nTLg-VL4ztu90fgUD9_kCreN-GF6Fj0nVg,14386
+autogluon.tabular-1.2.1b20250220.dist-info/NOTICE,sha256=7nPQuj8Kp-uXsU0S5so3-2dNU5EctS5hDXvvzzehd7E,114
+autogluon.tabular-1.2.1b20250220.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+autogluon.tabular-1.2.1b20250220.dist-info/namespace_packages.txt,sha256=giERA4R78OkJf2ijn5slgjURlhRPzfLr7waIcGkzYAo,10
+autogluon.tabular-1.2.1b20250220.dist-info/top_level.txt,sha256=giERA4R78OkJf2ijn5slgjURlhRPzfLr7waIcGkzYAo,10
+autogluon.tabular-1.2.1b20250220.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+autogluon.tabular-1.2.1b20250220.dist-info/RECORD,,

autogluon/tabular/predictor/_deprecated_methods.py

@@ -1,65 +0,0 @@
-from __future__ import annotations
-
-import numpy as np
-import pandas as pd
-
-from autogluon.common.utils import Deprecated
-
-
-class TabularPredictorDeprecatedMixin:
-    """Contains deprecated methods from TabularPredictor that shouldn't show up in API documentation."""
-
-    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="persist")
-    def persist_models(self, *args, **kwargs) -> list[str]:
-        """Deprecated method. Use `persist` instead."""
-        return self.persist(*args, **kwargs)
-
-    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="unpersist")
-    def unpersist_models(self, *args, **kwargs) -> list[str]:
-        """Deprecated method. Use `unpersist` instead."""
-        return self.unpersist(*args, **kwargs)
-
-    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="model_names")
-    def get_model_names(self, *args, **kwargs) -> list[str]:
-        """Deprecated method. Use `model_names` instead."""
-        return self.model_names(*args, **kwargs)
-
-    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="model_best")
-    def get_model_best(self) -> str:
-        """Deprecated method. Use `model_best` instead."""
-        return self.model_best
-
-    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="predict_from_proba")
-    def get_pred_from_proba(self, *args, **kwargs) -> pd.Series | np.array:
-        """Deprecated method. Use `predict_from_proba` instead."""
-        return self.predict_from_proba(*args, **kwargs)
-
-    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="model_refit_map")
-    def get_model_full_dict(self, *args, **kwargs) -> dict[str, str]:
-        """Deprecated method. Use `model_refit_map` instead."""
-        return self.model_refit_map(*args, **kwargs)
-
-    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="predict_proba_oof")
-    def get_oof_pred_proba(self, *args, **kwargs) -> pd.DataFrame | pd.Series:
-        """Deprecated method. Use `predict_proba_oof` instead."""
-        return self.predict_proba_oof(*args, **kwargs)
-
-    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="predict_oof")
-    def get_oof_pred(self, *args, **kwargs) -> pd.Series:
-        """Deprecated method. Use `predict_oof` instead."""
-        return self.predict_oof(*args, **kwargs)
-
-    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="disk_usage_per_file")
-    def get_size_disk_per_file(self, *args, **kwargs) -> pd.Series:
-        """Deprecated method. Use `disk_usage_per_file` instead."""
-        return self.disk_usage_per_file(*args, **kwargs)
-
-    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="disk_usage")
-    def get_size_disk(self) -> int:
-        """Deprecated method. Use `disk_usage` instead."""
-        return self.disk_usage()
-
-    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="model_names(persisted=True)")
-    def get_model_names_persisted(self) -> list[str]:
-        """Deprecated method. Use `model_names(persisted=True)` instead."""
-        return self.model_names(persisted=True)