aplr 10.9.0__cp311-cp311-macosx_11_0_x86_64.whl

aplr/__init__.py

@@ -0,0 +1 @@
+from .aplr import *

aplr/aplr.py

@@ -0,0 +1,608 @@
+from typing import List, Callable, Optional, Dict, Union
+import numpy as np
+import aplr_cpp
+import itertools
+
+FloatVector = np.ndarray
+FloatMatrix = np.ndarray
+IntVector = np.ndarray
+IntMatrix = np.ndarray
+
+
+class APLRRegressor:
+    def __init__(
+        self,
+        m: int = 3000,
+        v: float = 0.5,
+        random_state: int = 0,
+        loss_function: str = "mse",
+        link_function: str = "identity",
+        n_jobs: int = 0,
+        cv_folds: int = 5,
+        bins: int = 300,
+        max_interaction_level: int = 1,
+        max_interactions: int = 100000,
+        min_observations_in_split: int = 4,
+        ineligible_boosting_steps_added: int = 15,
+        max_eligible_terms: int = 7,
+        verbosity: int = 0,
+        dispersion_parameter: float = 1.5,
+        validation_tuning_metric: str = "default",
+        quantile: float = 0.5,
+        calculate_custom_validation_error_function: Optional[
+            Callable[
+                [
+                    FloatVector,
+                    FloatVector,
+                    FloatVector,
+                    FloatVector,
+                    FloatMatrix,
+                ],
+                float,
+            ]
+        ] = None,
+        calculate_custom_loss_function: Optional[
+            Callable[
+                [
+                    FloatVector,
+                    FloatVector,
+                    FloatVector,
+                    FloatVector,
+                    FloatMatrix,
+                ],
+                float,
+            ]
+        ] = None,
+        calculate_custom_negative_gradient_function: Optional[
+            Callable[
+                [FloatVector, FloatVector, FloatVector, FloatMatrix],
+                FloatVector,
+            ]
+        ] = None,
+        calculate_custom_transform_linear_predictor_to_predictions_function: Optional[
+            Callable[[FloatVector], FloatVector]
+        ] = None,
+        calculate_custom_differentiate_predictions_wrt_linear_predictor_function: Optional[
+            Callable[[FloatVector], FloatVector]
+        ] = None,
+        boosting_steps_before_interactions_are_allowed: int = 0,
+        monotonic_constraints_ignore_interactions: bool = False,
+        group_mse_by_prediction_bins: int = 10,
+        group_mse_cycle_min_obs_in_bin: int = 30,
+        early_stopping_rounds: int = 200,
+        num_first_steps_with_linear_effects_only: int = 0,
+        penalty_for_non_linearity: float = 0.0,
+        penalty_for_interactions: float = 0.0,
+        max_terms: int = 0,
+        ridge_penalty: float = 0.0001,
+    ):
+        self.m = m
+        self.v = v
+        self.random_state = random_state
+        self.loss_function = loss_function
+        self.link_function = link_function
+        self.n_jobs = n_jobs
+        self.cv_folds = cv_folds
+        self.bins = bins
+        self.max_interaction_level = max_interaction_level
+        self.max_interactions = max_interactions
+        self.min_observations_in_split = min_observations_in_split
+        self.ineligible_boosting_steps_added = ineligible_boosting_steps_added
+        self.max_eligible_terms = max_eligible_terms
+        self.verbosity = verbosity
+        self.dispersion_parameter = dispersion_parameter
+        self.validation_tuning_metric = validation_tuning_metric
+        self.quantile = quantile
+        self.calculate_custom_validation_error_function = (
+            calculate_custom_validation_error_function
+        )
+        self.calculate_custom_loss_function = calculate_custom_loss_function
+        self.calculate_custom_negative_gradient_function = (
+            calculate_custom_negative_gradient_function
+        )
+        self.calculate_custom_transform_linear_predictor_to_predictions_function = (
+            calculate_custom_transform_linear_predictor_to_predictions_function
+        )
+        self.calculate_custom_differentiate_predictions_wrt_linear_predictor_function = (
+            calculate_custom_differentiate_predictions_wrt_linear_predictor_function
+        )
+        self.boosting_steps_before_interactions_are_allowed = (
+            boosting_steps_before_interactions_are_allowed
+        )
+        self.monotonic_constraints_ignore_interactions = (
+            monotonic_constraints_ignore_interactions
+        )
+        self.group_mse_by_prediction_bins = group_mse_by_prediction_bins
+        self.group_mse_cycle_min_obs_in_bin = group_mse_cycle_min_obs_in_bin
+        self.early_stopping_rounds = early_stopping_rounds
+        self.num_first_steps_with_linear_effects_only = (
+            num_first_steps_with_linear_effects_only
+        )
+        self.penalty_for_non_linearity = penalty_for_non_linearity
+        self.penalty_for_interactions = penalty_for_interactions
+        self.max_terms = max_terms
+        self.ridge_penalty = ridge_penalty
+
+        # Creating aplr_cpp and setting parameters
+        self.APLRRegressor = aplr_cpp.APLRRegressor()
+        self.__set_params_cpp()
+
+    # Sets parameters for aplr_cpp.APLRRegressor cpp object
+    def __set_params_cpp(self):
+        self.APLRRegressor.m = self.m
+        self.APLRRegressor.v = self.v
+        self.APLRRegressor.random_state = self.random_state
+        self.APLRRegressor.loss_function = self.loss_function
+        self.APLRRegressor.link_function = self.link_function
+        self.APLRRegressor.n_jobs = self.n_jobs
+        self.APLRRegressor.cv_folds = self.cv_folds
+        self.APLRRegressor.bins = self.bins
+        self.APLRRegressor.max_interaction_level = self.max_interaction_level
+        self.APLRRegressor.max_interactions = self.max_interactions
+        self.APLRRegressor.min_observations_in_split = self.min_observations_in_split
+        self.APLRRegressor.ineligible_boosting_steps_added = (
+            self.ineligible_boosting_steps_added
+        )
+        self.APLRRegressor.max_eligible_terms = self.max_eligible_terms
+        self.APLRRegressor.verbosity = self.verbosity
+        self.APLRRegressor.dispersion_parameter = self.dispersion_parameter
+        self.APLRRegressor.validation_tuning_metric = self.validation_tuning_metric
+        self.APLRRegressor.quantile = self.quantile
+        self.APLRRegressor.calculate_custom_validation_error_function = (
+            self.calculate_custom_validation_error_function
+        )
+        self.APLRRegressor.calculate_custom_loss_function = (
+            self.calculate_custom_loss_function
+        )
+        self.APLRRegressor.calculate_custom_negative_gradient_function = (
+            self.calculate_custom_negative_gradient_function
+        )
+        self.APLRRegressor.calculate_custom_transform_linear_predictor_to_predictions_function = (
+            self.calculate_custom_transform_linear_predictor_to_predictions_function
+        )
+        self.APLRRegressor.calculate_custom_differentiate_predictions_wrt_linear_predictor_function = (
+            self.calculate_custom_differentiate_predictions_wrt_linear_predictor_function
+        )
+        self.APLRRegressor.boosting_steps_before_interactions_are_allowed = (
+            self.boosting_steps_before_interactions_are_allowed
+        )
+        self.APLRRegressor.monotonic_constraints_ignore_interactions = (
+            self.monotonic_constraints_ignore_interactions
+        )
+        self.APLRRegressor.group_mse_by_prediction_bins = (
+            self.group_mse_by_prediction_bins
+        )
+        self.APLRRegressor.group_mse_cycle_min_obs_in_bin = (
+            self.group_mse_cycle_min_obs_in_bin
+        )
+        self.APLRRegressor.early_stopping_rounds = self.early_stopping_rounds
+        self.APLRRegressor.num_first_steps_with_linear_effects_only = (
+            self.num_first_steps_with_linear_effects_only
+        )
+        self.APLRRegressor.penalty_for_non_linearity = self.penalty_for_non_linearity
+        self.APLRRegressor.penalty_for_interactions = self.penalty_for_interactions
+        self.APLRRegressor.max_terms = self.max_terms
+        self.APLRRegressor.ridge_penalty = self.ridge_penalty
+
+    def fit(
+        self,
+        X: FloatMatrix,
+        y: FloatVector,
+        sample_weight: FloatVector = np.empty(0),
+        X_names: List[str] = [],
+        cv_observations: IntMatrix = np.empty([0, 0]),
+        prioritized_predictors_indexes: List[int] = [],
+        monotonic_constraints: List[int] = [],
+        group: FloatVector = np.empty(0),
+        interaction_constraints: List[List[int]] = [],
+        other_data: FloatMatrix = np.empty([0, 0]),
+        predictor_learning_rates: List[float] = [],
+        predictor_penalties_for_non_linearity: List[float] = [],
+        predictor_penalties_for_interactions: List[float] = [],
+        predictor_min_observations_in_split: List[int] = [],
+    ):
+        self.__set_params_cpp()
+        self.APLRRegressor.fit(
+            X,
+            y,
+            sample_weight,
+            X_names,
+            cv_observations,
+            prioritized_predictors_indexes,
+            monotonic_constraints,
+            group,
+            interaction_constraints,
+            other_data,
+            predictor_learning_rates,
+            predictor_penalties_for_non_linearity,
+            predictor_penalties_for_interactions,
+            predictor_min_observations_in_split,
+        )
+
+    def predict(
+        self, X: FloatMatrix, cap_predictions_to_minmax_in_training: bool = True
+    ) -> FloatVector:
+        if self.link_function == "custom_function":
+            self.APLRRegressor.calculate_custom_transform_linear_predictor_to_predictions_function = (
+                self.calculate_custom_transform_linear_predictor_to_predictions_function
+            )
+        return self.APLRRegressor.predict(X, cap_predictions_to_minmax_in_training)
+
+    def set_term_names(self, X_names: List[str]):
+        self.APLRRegressor.set_term_names(X_names)
+
+    def calculate_feature_importance(
+        self, X: FloatMatrix, sample_weight: FloatVector = np.empty(0)
+    ) -> FloatVector:
+        return self.APLRRegressor.calculate_feature_importance(X, sample_weight)
+
+    def calculate_term_importance(
+        self, X: FloatMatrix, sample_weight: FloatVector = np.empty(0)
+    ) -> FloatVector:
+        return self.APLRRegressor.calculate_term_importance(X, sample_weight)
+
+    def calculate_local_feature_contribution(self, X: FloatMatrix) -> FloatMatrix:
+        return self.APLRRegressor.calculate_local_feature_contribution(X)
+
+    def calculate_local_term_contribution(self, X: FloatMatrix) -> FloatMatrix:
+        return self.APLRRegressor.calculate_local_term_contribution(X)
+
+    def calculate_local_contribution_from_selected_terms(
+        self, X: FloatMatrix, predictor_indexes: List[int]
+    ) -> FloatVector:
+        return self.APLRRegressor.calculate_local_contribution_from_selected_terms(
+            X, predictor_indexes
+        )
+
+    def calculate_terms(self, X: FloatMatrix) -> FloatMatrix:
+        return self.APLRRegressor.calculate_terms(X)
+
+    def get_term_names(self) -> List[str]:
+        return self.APLRRegressor.get_term_names()
+
+    def get_term_affiliations(self) -> List[str]:
+        return self.APLRRegressor.get_term_affiliations()
+
+    def get_unique_term_affiliations(self) -> List[str]:
+        return self.APLRRegressor.get_unique_term_affiliations()
+
+    def get_base_predictors_in_each_unique_term_affiliation(self) -> List[List[int]]:
+        return self.APLRRegressor.get_base_predictors_in_each_unique_term_affiliation()
+
+    def get_term_coefficients(self) -> FloatVector:
+        return self.APLRRegressor.get_term_coefficients()
+
+    def get_validation_error_steps(self) -> FloatMatrix:
+        return self.APLRRegressor.get_validation_error_steps()
+
+    def get_feature_importance(self) -> FloatVector:
+        return self.APLRRegressor.get_feature_importance()
+
+    def get_term_importance(self) -> FloatVector:
+        return self.APLRRegressor.get_term_importance()
+
+    def get_term_main_predictor_indexes(self) -> IntVector:
+        return self.APLRRegressor.get_term_main_predictor_indexes()
+
+    def get_term_interaction_levels(self) -> IntVector:
+        return self.APLRRegressor.get_term_interaction_levels()
+
+    def get_intercept(self) -> float:
+        return self.APLRRegressor.get_intercept()
+
+    def get_optimal_m(self) -> int:
+        return self.APLRRegressor.get_optimal_m()
+
+    def get_validation_tuning_metric(self) -> str:
+        return self.APLRRegressor.get_validation_tuning_metric()
+
+    def get_main_effect_shape(self, predictor_index: int) -> Dict[float, float]:
+        return self.APLRRegressor.get_main_effect_shape(predictor_index)
+
+    def get_unique_term_affiliation_shape(
+        self, unique_term_affiliation: str, max_rows_before_sampling: int = 100000
+    ) -> FloatMatrix:
+        return self.APLRRegressor.get_unique_term_affiliation_shape(
+            unique_term_affiliation, max_rows_before_sampling
+        )
+
+    def get_cv_error(self) -> float:
+        return self.APLRRegressor.get_cv_error()
+
+    def set_intercept(self, value: float):
+        self.APLRRegressor.set_intercept(value)
+
+    # For sklearn
+    def get_params(self, deep=True):
+        return {
+            "m": self.m,
+            "v": self.v,
+            "random_state": self.random_state,
+            "loss_function": self.loss_function,
+            "link_function": self.link_function,
+            "n_jobs": self.n_jobs,
+            "cv_folds": self.cv_folds,
+            "bins": self.bins,
+            "max_interaction_level": self.max_interaction_level,
+            "max_interactions": self.max_interactions,
+            "verbosity": self.verbosity,
+            "min_observations_in_split": self.min_observations_in_split,
+            "ineligible_boosting_steps_added": self.ineligible_boosting_steps_added,
+            "max_eligible_terms": self.max_eligible_terms,
+            "dispersion_parameter": self.dispersion_parameter,
+            "validation_tuning_metric": self.validation_tuning_metric,
+            "quantile": self.quantile,
+            "calculate_custom_validation_error_function": self.calculate_custom_validation_error_function,
+            "calculate_custom_loss_function": self.calculate_custom_loss_function,
+            "calculate_custom_negative_gradient_function": self.calculate_custom_negative_gradient_function,
+            "calculate_custom_transform_linear_predictor_to_predictions_function": self.calculate_custom_transform_linear_predictor_to_predictions_function,
+            "calculate_custom_differentiate_predictions_wrt_linear_predictor_function": self.calculate_custom_differentiate_predictions_wrt_linear_predictor_function,
+            "boosting_steps_before_interactions_are_allowed": self.boosting_steps_before_interactions_are_allowed,
+            "monotonic_constraints_ignore_interactions": self.monotonic_constraints_ignore_interactions,
+            "group_mse_by_prediction_bins": self.group_mse_by_prediction_bins,
+            "group_mse_cycle_min_obs_in_bin": self.group_mse_cycle_min_obs_in_bin,
+            "early_stopping_rounds": self.early_stopping_rounds,
+            "num_first_steps_with_linear_effects_only": self.num_first_steps_with_linear_effects_only,
+            "penalty_for_non_linearity": self.penalty_for_non_linearity,
+            "penalty_for_interactions": self.penalty_for_interactions,
+            "max_terms": self.max_terms,
+            "ridge_penalty": self.ridge_penalty,
+        }
+
+    # For sklearn
+    def set_params(self, **parameters):
+        for parameter, value in parameters.items():
+            setattr(self, parameter, value)
+        self.__set_params_cpp()
+        return self
+
+
+class APLRClassifier:
+    def __init__(
+        self,
+        m: int = 3000,
+        v: float = 0.5,
+        random_state: int = 0,
+        n_jobs: int = 0,
+        cv_folds: int = 5,
+        bins: int = 300,
+        verbosity: int = 0,
+        max_interaction_level: int = 1,
+        max_interactions: int = 100000,
+        min_observations_in_split: int = 4,
+        ineligible_boosting_steps_added: int = 15,
+        max_eligible_terms: int = 7,
+        boosting_steps_before_interactions_are_allowed: int = 0,
+        monotonic_constraints_ignore_interactions: bool = False,
+        early_stopping_rounds: int = 200,
+        num_first_steps_with_linear_effects_only: int = 0,
+        penalty_for_non_linearity: float = 0.0,
+        penalty_for_interactions: float = 0.0,
+        max_terms: int = 0,
+        ridge_penalty: float = 0.0001,
+    ):
+        self.m = m
+        self.v = v
+        self.random_state = random_state
+        self.n_jobs = n_jobs
+        self.cv_folds = cv_folds
+        self.bins = bins
+        self.verbosity = verbosity
+        self.max_interaction_level = max_interaction_level
+        self.max_interactions = max_interactions
+        self.min_observations_in_split = min_observations_in_split
+        self.ineligible_boosting_steps_added = ineligible_boosting_steps_added
+        self.max_eligible_terms = max_eligible_terms
+        self.boosting_steps_before_interactions_are_allowed = (
+            boosting_steps_before_interactions_are_allowed
+        )
+        self.monotonic_constraints_ignore_interactions = (
+            monotonic_constraints_ignore_interactions
+        )
+        self.early_stopping_rounds = early_stopping_rounds
+        self.num_first_steps_with_linear_effects_only = (
+            num_first_steps_with_linear_effects_only
+        )
+        self.penalty_for_non_linearity = penalty_for_non_linearity
+        self.penalty_for_interactions = penalty_for_interactions
+        self.max_terms = max_terms
+        self.ridge_penalty = ridge_penalty
+
+        # Creating aplr_cpp and setting parameters
+        self.APLRClassifier = aplr_cpp.APLRClassifier()
+        self.__set_params_cpp()
+
+    # Sets parameters for aplr_cpp.APLRClassifier cpp object
+    def __set_params_cpp(self):
+        self.APLRClassifier.m = self.m
+        self.APLRClassifier.v = self.v
+        self.APLRClassifier.random_state = self.random_state
+        self.APLRClassifier.n_jobs = self.n_jobs
+        self.APLRClassifier.cv_folds = self.cv_folds
+        self.APLRClassifier.bins = self.bins
+        self.APLRClassifier.verbosity = self.verbosity
+        self.APLRClassifier.max_interaction_level = self.max_interaction_level
+        self.APLRClassifier.max_interactions = self.max_interactions
+        self.APLRClassifier.min_observations_in_split = self.min_observations_in_split
+        self.APLRClassifier.ineligible_boosting_steps_added = (
+            self.ineligible_boosting_steps_added
+        )
+        self.APLRClassifier.max_eligible_terms = self.max_eligible_terms
+        self.APLRClassifier.boosting_steps_before_interactions_are_allowed = (
+            self.boosting_steps_before_interactions_are_allowed
+        )
+        self.APLRClassifier.monotonic_constraints_ignore_interactions = (
+            self.monotonic_constraints_ignore_interactions
+        )
+        self.APLRClassifier.early_stopping_rounds = self.early_stopping_rounds
+        self.APLRClassifier.num_first_steps_with_linear_effects_only = (
+            self.num_first_steps_with_linear_effects_only
+        )
+        self.APLRClassifier.penalty_for_non_linearity = self.penalty_for_non_linearity
+        self.APLRClassifier.penalty_for_interactions = self.penalty_for_interactions
+        self.APLRClassifier.max_terms = self.max_terms
+        self.APLRClassifier.ridge_penalty = self.ridge_penalty
+
+    def fit(
+        self,
+        X: FloatMatrix,
+        y: List[str],
+        sample_weight: FloatVector = np.empty(0),
+        X_names: List[str] = [],
+        cv_observations: IntMatrix = np.empty([0, 0]),
+        prioritized_predictors_indexes: List[int] = [],
+        monotonic_constraints: List[int] = [],
+        interaction_constraints: List[List[int]] = [],
+        predictor_learning_rates: List[float] = [],
+        predictor_penalties_for_non_linearity: List[float] = [],
+        predictor_penalties_for_interactions: List[float] = [],
+        predictor_min_observations_in_split: List[int] = [],
+    ):
+        self.__set_params_cpp()
+        self.APLRClassifier.fit(
+            X,
+            y,
+            sample_weight,
+            X_names,
+            cv_observations,
+            prioritized_predictors_indexes,
+            monotonic_constraints,
+            interaction_constraints,
+            predictor_learning_rates,
+            predictor_penalties_for_non_linearity,
+            predictor_penalties_for_interactions,
+            predictor_min_observations_in_split,
+        )
+        # For sklearn
+        self.classes_ = np.arange(len(self.APLRClassifier.get_categories()))
+
+    def predict_class_probabilities(
+        self, X: FloatMatrix, cap_predictions_to_minmax_in_training: bool = False
+    ) -> FloatMatrix:
+        return self.APLRClassifier.predict_class_probabilities(
+            X, cap_predictions_to_minmax_in_training
+        )
+
+    def predict(
+        self, X: FloatMatrix, cap_predictions_to_minmax_in_training: bool = False
+    ) -> List[str]:
+        return self.APLRClassifier.predict(X, cap_predictions_to_minmax_in_training)
+
+    def calculate_local_feature_contribution(self, X: FloatMatrix) -> FloatMatrix:
+        return self.APLRClassifier.calculate_local_feature_contribution(X)
+
+    def get_categories(self) -> List[str]:
+        return self.APLRClassifier.get_categories()
+
+    def get_logit_model(self, category: str) -> APLRRegressor:
+        return self.APLRClassifier.get_logit_model(category)
+
+    def get_validation_error_steps(self) -> FloatMatrix:
+        return self.APLRClassifier.get_validation_error_steps()
+
+    def get_cv_error(self) -> float:
+        return self.APLRClassifier.get_cv_error()
+
+    def get_feature_importance(self) -> FloatVector:
+        return self.APLRClassifier.get_feature_importance()
+
+    def get_unique_term_affiliations(self) -> List[str]:
+        return self.APLRClassifier.get_unique_term_affiliations()
+
+    def get_base_predictors_in_each_unique_term_affiliation(self) -> List[List[int]]:
+        return self.APLRClassifier.get_base_predictors_in_each_unique_term_affiliation()
+
+    # For sklearn
+    def get_params(self, deep=True):
+        return {
+            "m": self.m,
+            "v": self.v,
+            "random_state": self.random_state,
+            "n_jobs": self.n_jobs,
+            "cv_folds": self.cv_folds,
+            "bins": self.bins,
+            "verbosity": self.verbosity,
+            "max_interaction_level": self.max_interaction_level,
+            "max_interactions": self.max_interactions,
+            "min_observations_in_split": self.min_observations_in_split,
+            "ineligible_boosting_steps_added": self.ineligible_boosting_steps_added,
+            "max_eligible_terms": self.max_eligible_terms,
+            "boosting_steps_before_interactions_are_allowed": self.boosting_steps_before_interactions_are_allowed,
+            "monotonic_constraints_ignore_interactions": self.monotonic_constraints_ignore_interactions,
+            "early_stopping_rounds": self.early_stopping_rounds,
+            "num_first_steps_with_linear_effects_only": self.num_first_steps_with_linear_effects_only,
+            "penalty_for_non_linearity": self.penalty_for_non_linearity,
+            "penalty_for_interactions": self.penalty_for_interactions,
+            "max_terms": self.max_terms,
+            "ridge_penalty": self.ridge_penalty,
+        }
+
+    # For sklearn
+    def set_params(self, **parameters):
+        for parameter, value in parameters.items():
+            setattr(self, parameter, value)
+        self.__set_params_cpp()
+        return self
+
+    # For sklearn
+    def predict_proba(self, X: FloatMatrix) -> FloatMatrix:
+        return self.predict_class_probabilities(X)
+
+
+class APLRTuner:
+    def __init__(
+        self,
+        parameters: Union[Dict[str, List[float]], List[Dict[str, List[float]]]] = {
+            "max_interaction_level": [0, 1],
+            "min_observations_in_split": [4, 10, 20, 100, 500, 1000],
+        },
+        is_regressor: bool = True,
+    ):
+        self.parameters = parameters
+        self.is_regressor = is_regressor
+        self.parameter_grid = self._create_parameter_grid()
+
+    def _create_parameter_grid(self) -> List[Dict[str, float]]:
+        items = sorted(self.parameters.items())
+        keys, values = zip(*items)
+        combinations = list(itertools.product(*values))
+        grid = [dict(zip(keys, combination)) for combination in combinations]
+        return grid
+
+    def fit(self, X: FloatMatrix, y: FloatVector, **kwargs):
+        self.cv_results: List[Dict[str, float]] = []
+        best_validation_result = np.inf
+        for params in self.parameter_grid:
+            if self.is_regressor:
+                model = APLRRegressor(**params)
+            else:
+                model = APLRClassifier(**params)
+            model.fit(X, y, **kwargs)
+            cv_error_for_this_model = model.get_cv_error()
+            cv_results_for_this_model = model.get_params()
+            cv_results_for_this_model["cv_error"] = cv_error_for_this_model
+            self.cv_results.append(cv_results_for_this_model)
+            if cv_error_for_this_model < best_validation_result:
+                best_validation_result = cv_error_for_this_model
+                self.best_model = model
+        self.cv_results = sorted(self.cv_results, key=lambda x: x["cv_error"])
+
+    def predict(self, X: FloatMatrix, **kwargs) -> Union[FloatVector, List[str]]:
+        return self.best_model.predict(X, **kwargs)
+
+    def predict_class_probabilities(self, X: FloatMatrix, **kwargs) -> FloatMatrix:
+        if self.is_regressor == False:
+            return self.best_model.predict_class_probabilities(X, **kwargs)
+        else:
+            raise TypeError(
+                "predict_class_probabilities is only possible when is_regressor is False"
+            )
+
+    def predict_proba(self, X: FloatMatrix, **kwargs) -> FloatMatrix:
+        return self.predict_class_probabilities(X, **kwargs)
+
+    def get_best_estimator(self) -> Union[APLRClassifier, APLRRegressor]:
+        return self.best_model
+
+    def get_cv_results(self) -> List[Dict[str, float]]:
+        return self.cv_results

aplr-10.9.0.dist-info/METADATA

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: aplr
+Version: 10.9.0
+Summary: Automatic Piecewise Linear Regression
+Home-page: https://github.com/ottenbreit-data-science/aplr
+Author: Mathias von Ottenbreit
+Author-email: ottenbreitdatascience@gmail.com
+License: MIT
+Platform: Windows
+Platform: Linux
+Platform: MacOS
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.11
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# APLR
+**Automatic Piecewise Linear Regression**
+
+## About
+APLR allows you to build predictive and interpretable regression or classification machine learning models in Python, using the Automatic Piecewise Linear Regression (APLR) methodology developed by Mathias von Ottenbreit. APLR often rivals tree-based methods in predictive accuracy, while offering smoother, more interpretable predictions. 
+
+For further details, see the [documentation](https://github.com/ottenbreit-data-science/aplr/tree/main/documentation). You may also read the published article for additional insights: [Link 1](https://link.springer.com/article/10.1007/s00180-024-01475-4) and [Link 2](https://rdcu.be/dz7bF). Additional functionality has been added since the article was published.
+
+## Installation
+To install APLR, use the following command:
+
+```bash
+pip install aplr
+```
+
+## Availability
+APLR is available for Windows, most Linux distributions, and macOS.
+
+## Usage
+Example Python scripts are available [here](https://github.com/ottenbreit-data-science/aplr/tree/main/examples).
+
+## Sponsorship
+Consider sponsoring Von Ottenbreit Data Science by clicking the **Sponsor** button on the repository. Sufficient funding will help maintain and further develop APLR.
+
+## API Reference
+- [API reference for regression](https://github.com/ottenbreit-data-science/aplr/blob/main/API_REFERENCE_FOR_REGRESSION.md)
+- [API reference for classification](https://github.com/ottenbreit-data-science/aplr/blob/main/API_REFERENCE_FOR_CLASSIFICATION.md)
+
+## Contact Information
+For inquiries, please email: [ottenbreitdatascience@gmail.com](mailto:ottenbreitdatascience@gmail.com)

aplr-10.9.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+aplr_cpp.cpython-311-darwin.so,sha256=xCE7U-xCzGrAQlr1IUFdd7DCR4_j8voC68bSGU5_rYA,1245712
+aplr-10.9.0.dist-info/RECORD,,
+aplr-10.9.0.dist-info/WHEEL,sha256=4yRL7i34iDMjEUoqD8VLw6c4rQ6B4MrCGI-TyFdAJTU,110
+aplr-10.9.0.dist-info/top_level.txt,sha256=DXVC0RIFGpzVnPeKWAZTXQdJheOEZL51Wip6Fx7zbR4,14
+aplr-10.9.0.dist-info/METADATA,sha256=YyVcDnXStzsAnm5KWfxaSYgd70qn6IqhqaoLpZI-3IM,2361
+aplr-10.9.0.dist-info/licenses/LICENSE,sha256=g4qcQtkSVPHtGRi3T93DoFCrssvW6ij_emU-2fj_xfY,1113
+aplr/__init__.py,sha256=rRfTgNWnYZlFatyA920lWqBcjwmQUI7FcvEPFUTJgzE,20
+aplr/aplr.py,sha256=18XnQy37U3AApCWESlfKysuHPsl9_LiF2kyubroFr_Q,26718

aplr-10.9.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (78.1.0)
+Root-Is-Purelib: false
+Tag: cp311-cp311-macosx_11_0_x86_64
+

aplr-10.9.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Mathias von Ottenbreit <ottenbreitdatascience@gmail.com>
+
+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.

aplr-10.9.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+aplr
+aplr_cpp