unifiedbooster 0.2.1__py3-none-any.whl → 0.2.2__py3-none-any.whl

unifiedbooster/__init__.py

@@ -1,4 +1,5 @@
+from .gbdt import GBDT
 from .gbdt_classification import GBDTClassifier
 from .gbdt_regression import GBDTRegressor
 
-__all__ = ["GBDTClassifier", "GBDTRegressor"]
+__all__ = ["GBDT", "GBDTClassifier", "GBDTRegressor"]

unifiedbooster/gbdt.py

@@ -1,69 +1,131 @@
-import numpy as np 
+import numpy as np
 from sklearn.base import BaseEstimator
 
 
 class GBDT(BaseEstimator):
-    def __init__(self, 
-                 model_type='xgboost', 
-                 n_estimators=100, 
-                 learning_rate=0.1, 
-                 max_depth=3, 
-                 rowsample=1.0,
-                 colsample=1.0,    
-                 verbose=0,    
-                 seed=123,          
-                 **kwargs):  
-        
+    """Gradient Boosted Decision Trees (GBDT) base class
+
+    Attributes:
+
+        n_estimators: int
+            maximum number of trees that can be built
+
+        learning_rate: float
+            shrinkage rate; used for reducing the gradient step
+
+        rowsample: float
+            subsample ratio of the training instances
+
+        colsample: float
+            percentage of features to use at each node split
+
+        verbose: int
+            controls verbosity (default=0)
+
+        seed: int
+            reproducibility seed
+    """
+
+    def __init__(
+        self,
+        model_type="xgboost",
+        n_estimators=100,
+        learning_rate=0.1,
+        max_depth=3,
+        rowsample=1.0,
+        colsample=1.0,
+        verbose=0,
+        seed=123,
+        **kwargs
+    ):
+
         self.model_type = model_type
         self.n_estimators = n_estimators
         self.learning_rate = learning_rate
         self.max_depth = max_depth
         self.rowsample = rowsample
-        self.colsample = colsample        
-        self.verbose = verbose 
-        self.seed = seed         
+        self.colsample = colsample
+        self.verbose = verbose
+        self.seed = seed
 
-        if self.model_type == "xgboost": 
+        if self.model_type == "xgboost":
             self.params = {
-                'n_estimators': self.n_estimators,
-                'learning_rate': self.learning_rate,
-                'subsample': self.rowsample, 
-                'colsample_bynode': self.colsample,                
-                'max_depth': self.max_depth,
-                'verbosity': self.verbose, 
-                'seed': self.seed,
-                **kwargs
+                "n_estimators": self.n_estimators,
+                "learning_rate": self.learning_rate,
+                "subsample": self.rowsample,
+                "colsample_bynode": self.colsample,
+                "max_depth": self.max_depth,
+                "verbosity": self.verbose,
+                "seed": self.seed,
+                **kwargs,
             }
         elif self.model_type == "lightgbm":
-             verbose = self.verbose - 1 if self.verbose==0 else self.verbose
-             self.params = {
-                'n_estimators': self.n_estimators, 
-                'learning_rate': self.learning_rate, 
-                'subsample': self.rowsample, 
-                'feature_fraction_bynode': self.colsample,                
-                'max_depth': self.max_depth,
-                'verbose': verbose, # keep this way
-                'seed': self.seed,
-                **kwargs
+            verbose = self.verbose - 1 if self.verbose == 0 else self.verbose
+            self.params = {
+                "n_estimators": self.n_estimators,
+                "learning_rate": self.learning_rate,
+                "subsample": self.rowsample,
+                "feature_fraction_bynode": self.colsample,
+                "max_depth": self.max_depth,
+                "verbose": verbose,  # keep this way
+                "seed": self.seed,
+                **kwargs,
             }
         elif self.model_type == "catboost":
-             self.params = {
-                'iterations': self.n_estimators, 
-                'learning_rate': self.learning_rate, 
-                'subsample': self.rowsample, 
-                'rsm': self.colsample, 
-                'depth': self.max_depth, 
-                'verbose': self.verbose,
-                'random_seed': self.seed, 
-                'bootstrap_type': 'Bernoulli',
-                **kwargs
-            }           
-        
+            self.params = {
+                "iterations": self.n_estimators,
+                "learning_rate": self.learning_rate,
+                "subsample": self.rowsample,
+                "rsm": self.colsample,
+                "depth": self.max_depth,
+                "verbose": self.verbose,
+                "random_seed": self.seed,
+                "bootstrap_type": "Bernoulli",
+                **kwargs,
+            }
+
     def fit(self, X, y, **kwargs):
+        """Fit custom model to training data (X, y).
+
+        Parameters:
+
+            X: {array-like}, shape = [n_samples, n_features]
+                Training vectors, where n_samples is the number
+                of samples and n_features is the number of features.
+
+            y: array-like, shape = [n_samples]
+                Target values.
+
+            **kwargs: additional parameters to be passed to
+                        self.cook_training_set or self.obj.fit
+
+        Returns:
+
+            self: object
+        """
+
         if getattr(self, "type_fit") == "classification":
-            self.classes_ = np.unique(y) # for compatibility with sklearn
-            self.n_classes_ = len(self.classes_)  # for compatibility with sklearn        
+            self.classes_ = np.unique(y)  # for compatibility with sklearn
+            self.n_classes_ = len(
+                self.classes_
+            )  # for compatibility with sklearn
         return getattr(self, "model").fit(X, y, **kwargs)
-    
+
     def predict(self, X):
-        return getattr(self, "model").predict(X)        
+        """Predict test data X.
+
+        Parameters:
+
+            X: {array-like}, shape = [n_samples, n_features]
+                Training vectors, where n_samples is the number
+                of samples and n_features is the number of features.
+
+            **kwargs: additional parameters to be passed to
+                    self.cook_test_set
+
+        Returns:
+
+            model predictions: {array-like}
+        """
+
+        return getattr(self, "model").predict(X)

unifiedbooster/gbdt_classification.py

@@ -1,7 +1,11 @@
 from .gbdt import GBDT
 from sklearn.base import ClassifierMixin
 from xgboost import XGBClassifier
-from catboost import CatBoostClassifier
+
+try:
+    from catboost import CatBoostClassifier
+except:
+    print("catboost package can't be built")
 from lightgbm import LGBMClassifier
 
 
@@ -11,7 +15,7 @@ class GBDTClassifier(GBDT, ClassifierMixin):
     Attributes:
 
         n_estimators: int
-            maximum number of trees that can be built 
+            maximum number of trees that can be built
 
         learning_rate: float
             shrinkage rate; used for reducing the gradient step
@@ -24,9 +28,9 @@ class GBDTClassifier(GBDT, ClassifierMixin):
 
         verbose: int
             controls verbosity (default=0)
-        
-        seed: int 
-            reproducibility seed 
+
+        seed: int
+            reproducibility seed
 
     Examples:
 
@@ -68,39 +72,57 @@ class GBDTClassifier(GBDT, ClassifierMixin):
     ```
     """
 
-    def __init__(self, 
-                 model_type='xgboost', 
-                 n_estimators=100, 
-                 learning_rate=0.1, 
-                 max_depth=3, 
-                 rowsample=1.0,  
-                 colsample=1.0,
-                 verbose=0,
-                 seed=123,
-                 **kwargs):
-        
+    def __init__(
+        self,
+        model_type="xgboost",
+        n_estimators=100,
+        learning_rate=0.1,
+        max_depth=3,
+        rowsample=1.0,
+        colsample=1.0,
+        verbose=0,
+        seed=123,
+        **kwargs,
+    ):
+
         self.type_fit = "classification"
-                        
+
         super().__init__(
-            model_type=model_type, 
-            n_estimators=n_estimators, 
-            learning_rate=learning_rate, 
-            max_depth=max_depth, 
+            model_type=model_type,
+            n_estimators=n_estimators,
+            learning_rate=learning_rate,
+            max_depth=max_depth,
             rowsample=rowsample,
-            colsample=colsample,    
-            verbose=verbose,    
-            seed=seed,          
-            **kwargs
+            colsample=colsample,
+            verbose=verbose,
+            seed=seed,
+            **kwargs,
         )
 
-        if model_type == 'xgboost':
+        if model_type == "xgboost":
             self.model = XGBClassifier(**self.params)
-        elif model_type == 'catboost':            
+        elif model_type == "catboost":
             self.model = CatBoostClassifier(**self.params)
-        elif model_type == 'lightgbm':
+        elif model_type == "lightgbm":
             self.model = LGBMClassifier(**self.params)
         else:
             raise ValueError(f"Unknown model_type: {model_type}")
-            
+
     def predict_proba(self, X):
-        return self.model.predict_proba(X)
+        """Predict probabilities for test data X.
+
+        Args:
+
+            X: {array-like}, shape = [n_samples, n_features]
+                Training vectors, where n_samples is the number
+                of samples and n_features is the number of features.
+
+            **kwargs: additional parameters to be passed to
+                    self.cook_test_set
+
+        Returns:
+
+            probability estimates for test data: {array-like}
+        """
+
+        return self.model.predict_proba(X)

unifiedbooster/gbdt_regression.py

@@ -1,7 +1,11 @@
 from .gbdt import GBDT
 from sklearn.base import RegressorMixin
 from xgboost import XGBRegressor
-from catboost import CatBoostRegressor
+
+try:
+    from catboost import CatBoostRegressor
+except:
+    print("catboost package can't be built")
 from lightgbm import LGBMRegressor
 
 
@@ -11,7 +15,7 @@ class GBDTRegressor(GBDT, RegressorMixin):
     Attributes:
 
         n_estimators: int
-            maximum number of trees that can be built 
+            maximum number of trees that can be built
 
         learning_rate: float
             shrinkage rate; used for reducing the gradient step
@@ -24,9 +28,9 @@ class GBDTRegressor(GBDT, RegressorMixin):
 
         verbose: int
             controls verbosity (default=0)
-        
-        seed: int 
-            reproducibility seed 
+
+        seed: int
+            reproducibility seed
 
     Examples:
 
@@ -68,36 +72,38 @@ class GBDTRegressor(GBDT, RegressorMixin):
     ```
     """
 
-    def __init__(self, 
-                 model_type='xgboost', 
-                 n_estimators=100, 
-                 learning_rate=0.1, 
-                 max_depth=3, 
-                 rowsample=1.0,
-                 colsample=1.0,    
-                 verbose=0,    
-                 seed=123,          
-                 **kwargs):
-        
+    def __init__(
+        self,
+        model_type="xgboost",
+        n_estimators=100,
+        learning_rate=0.1,
+        max_depth=3,
+        rowsample=1.0,
+        colsample=1.0,
+        verbose=0,
+        seed=123,
+        **kwargs,
+    ):
+
         self.type_fit = "regression"
-                        
+
         super().__init__(
-            model_type=model_type, 
-            n_estimators=n_estimators, 
-            learning_rate=learning_rate, 
-            max_depth=max_depth, 
+            model_type=model_type,
+            n_estimators=n_estimators,
+            learning_rate=learning_rate,
+            max_depth=max_depth,
             rowsample=rowsample,
-            colsample=colsample,    
-            verbose=verbose,    
-            seed=seed,          
-            **kwargs
+            colsample=colsample,
+            verbose=verbose,
+            seed=seed,
+            **kwargs,
         )
 
-        if model_type == 'xgboost':
+        if model_type == "xgboost":
             self.model = XGBRegressor(**self.params)
-        elif model_type == 'catboost':            
+        elif model_type == "catboost":
             self.model = CatBoostRegressor(**self.params)
-        elif model_type == 'lightgbm':
+        elif model_type == "lightgbm":
             self.model = LGBMRegressor(**self.params)
         else:
             raise ValueError(f"Unknown model_type: {model_type}")

unifiedbooster-0.2.2.dist-info/LICENSE

@@ -0,0 +1,7 @@
+Copyright <2024> <T. Moudiki>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

{unifiedbooster-0.2.1.dist-info → unifiedbooster-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unifiedbooster
-Version: 0.2.1
+Version: 0.2.2
 Summary: Unified interface for Gradient Boosted Decision Trees
 Home-page: https://github.com/thierrymoudiki/unifiedbooster
 Author: T. Moudiki
@@ -16,6 +16,7 @@ Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Requires-Python: >=3.6
+License-File: LICENSE
 Requires-Dist: Cython
 Requires-Dist: numpy
 Requires-Dist: scikit-learn

unifiedbooster-0.2.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+unifiedbooster/__init__.py,sha256=3d8wQVXaeVIxqtk_STM6nvIGZiGTxKn9aAWjuwiDYuo,169
+unifiedbooster/gbdt.py,sha256=Y5gweEEfI5DGMsuE_Z-gJlbteawolzk2uFyoGXGwgKA,3958
+unifiedbooster/gbdt_classification.py,sha256=sIdoeqOBYGmzeHV3Rk3DrBav-ebG2v-o9cv0X0LREXg,3634
+unifiedbooster/gbdt_regression.py,sha256=VE129JJ_DNoi3knLI5I_5QNRkW0M3KAKRmE-sfXrCLk,3127
+unifiedbooster-0.2.2.dist-info/LICENSE,sha256=3rWw63btcdqbC0XMnpzCQhxDP8Vx7yKkKS7EDgJiY_4,1061
+unifiedbooster-0.2.2.dist-info/METADATA,sha256=Y-BX935CwMCs4uD-mNoniEeU0F0yuySg97dhZF5NSEQ,930
+unifiedbooster-0.2.2.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+unifiedbooster-0.2.2.dist-info/entry_points.txt,sha256=OVNTsCzMYnaJ11WIByB7G8Lym_dj-ERKZyQxWFUcW30,59
+unifiedbooster-0.2.2.dist-info/top_level.txt,sha256=gOMxxpRtx8_nJXTWsXJDFkNeCsjSJQPs6aUXKK5_nI4,15
+unifiedbooster-0.2.2.dist-info/RECORD,,

unifiedbooster-0.2.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-unifiedbooster/__init__.py,sha256=urmH2DAkJ4e-idIh0oMZX9lP9rlqTPyZ-qHuNeJcEIc,137
-unifiedbooster/gbdt.py,sha256=MS8M71r9uXM2NsWj54bH8_k0labL2V4p_R55qgNqGIg,2630
-unifiedbooster/gbdt_classification.py,sha256=326I7d70nF__uOlynMU7IrS-8cyez4xlMYDNJMTSL6Y,3277
-unifiedbooster/gbdt_regression.py,sha256=wOT1iigiXELzQ_lL_SjgdiP2pm7RgMVXY89QMLMkhYk,3229
-unifiedbooster-0.2.1.dist-info/METADATA,sha256=YZdEVXeU2WWgtC7acTOvmbqyoXFPVofIjJur2IkKxRE,908
-unifiedbooster-0.2.1.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
-unifiedbooster-0.2.1.dist-info/entry_points.txt,sha256=OVNTsCzMYnaJ11WIByB7G8Lym_dj-ERKZyQxWFUcW30,59
-unifiedbooster-0.2.1.dist-info/top_level.txt,sha256=gOMxxpRtx8_nJXTWsXJDFkNeCsjSJQPs6aUXKK5_nI4,15
-unifiedbooster-0.2.1.dist-info/RECORD,,