aplr 10.12.1__cp313-cp313-macosx_11_0_arm64.whl → 10.13.0__cp313-cp313-macosx_11_0_arm64.whl

aplr/aplr.py

@@ -315,6 +315,108 @@ class APLRRegressor:
     def set_intercept(self, value: float):
         self.APLRRegressor.set_intercept(value)
 
+    def plot_affiliation_shape(
+        self,
+        affiliation: str,
+        plot: bool = True,
+        save: bool = False,
+        path: str = "",
+    ):
+        """
+        Plots or saves the shape of a given unique term affiliation.
+
+        For main effects, it produces a line plot. For two-way interactions, it produces a heatmap.
+        Plotting for higher-order interactions is not supported.
+
+        :param affiliation: A string specifying which unique_term_affiliation to use.
+        :param plot: If True, displays the plot.
+        :param save: If True, saves the plot to a file.
+        :param path: The file path to save the plot. If empty and save is True, a default path will be used.
+        """
+        try:
+            import pandas as pd
+            import matplotlib.pyplot as plt
+        except ImportError:
+            raise ImportError(
+                "pandas and matplotlib are required for plotting. Please install them."
+            )
+
+        all_affiliations = self.get_unique_term_affiliations()
+        if affiliation not in all_affiliations:
+            raise ValueError(
+                f"Affiliation '{affiliation}' not found in model. "
+                f"Available affiliations are: {all_affiliations}"
+            )
+
+        affiliation_index = all_affiliations.index(affiliation)
+
+        predictors_in_each_affiliation = (
+            self.get_base_predictors_in_each_unique_term_affiliation()
+        )
+        predictor_indexes_used = predictors_in_each_affiliation[affiliation_index]
+
+        shape = self.get_unique_term_affiliation_shape(affiliation)
+        if shape.shape[0] == 0:
+            print(f"No shape data available for affiliation '{affiliation}'.")
+            return
+
+        predictor_names = affiliation.split(" & ")
+
+        shape_df = pd.DataFrame(shape, columns=predictor_names + ["contribution"])
+
+        is_main_effect: bool = len(predictor_indexes_used) == 1
+        is_two_way_interaction: bool = len(predictor_indexes_used) == 2
+
+        if is_main_effect:
+            fig = plt.figure()
+            plt.plot(shape_df.iloc[:, 0], shape_df.iloc[:, 1])
+            plt.xlabel(shape_df.columns[0])
+            plt.ylabel("Contribution to linear predictor")
+            plt.title(f"Main effect of {shape_df.columns[0]}")
+            plt.grid(True)
+        elif is_two_way_interaction:
+            fig = plt.figure(figsize=(8, 6))
+            pivot_table = shape_df.pivot_table(
+                index=shape_df.columns[0],
+                columns=shape_df.columns[1],
+                values=shape_df.columns[2],
+                aggfunc="mean",
+            )
+            plt.imshow(
+                pivot_table.values,
+                aspect="auto",
+                origin="lower",
+                extent=[
+                    pivot_table.columns.min(),
+                    pivot_table.columns.max(),
+                    pivot_table.index.min(),
+                    pivot_table.index.max(),
+                ],
+                cmap="Blues_r",
+            )
+            plt.colorbar(label="Contribution to the linear predictor")
+            plt.xlabel(shape_df.columns[1])
+            plt.ylabel(shape_df.columns[0])
+            plt.title(
+                f"Interaction between {shape_df.columns[0]} and {shape_df.columns[1]}"
+            )
+        else:
+            print(
+                f"Plotting for interaction level > 2 is not supported. Affiliation: {affiliation}"
+            )
+            return
+
+        if save:
+            save_path = (
+                path if path else f"shape_of_{affiliation.replace(' & ', '_')}.png"
+            )
+            plt.savefig(save_path)
+
+        if plot:
+            plt.show()
+
+        plt.close(fig)
+
     def remove_provided_custom_functions(self):
         self.APLRRegressor.remove_provided_custom_functions()
         self.calculate_custom_validation_error_function = None
@@ -504,7 +606,36 @@ class APLRClassifier:
         return self.APLRClassifier.get_categories()
 
     def get_logit_model(self, category: str) -> APLRRegressor:
-        return self.APLRClassifier.get_logit_model(category)
+        logit_model_cpp = self.APLRClassifier.get_logit_model(category)
+
+        logit_model_py = APLRRegressor(
+            m=self.m,
+            v=self.v,
+            random_state=self.random_state,
+            loss_function="binomial",
+            link_function="logit",
+            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,
+            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,
+            verbosity=self.verbosity,
+            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,
+        )
+
+        logit_model_py.APLRRegressor = logit_model_cpp
+
+        return logit_model_py
 
     def get_validation_error_steps(self) -> FloatMatrix:
         return self.APLRClassifier.get_validation_error_steps()

{aplr-10.12.1.dist-info → aplr-10.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aplr
-Version: 10.12.1
+Version: 10.13.0
 Summary: Automatic Piecewise Linear Regression
 Home-page: https://github.com/ottenbreit-data-science/aplr
 Author: Mathias von Ottenbreit
@@ -14,6 +14,9 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy>=1.11
+Provides-Extra: plots
+Requires-Dist: pandas; extra == "plots"
+Requires-Dist: matplotlib; extra == "plots"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -23,6 +26,7 @@ Dynamic: home-page
 Dynamic: license
 Dynamic: license-file
 Dynamic: platform
+Dynamic: provides-extra
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
@@ -42,6 +46,12 @@ To install APLR, use the following command:
 pip install aplr
 ```
 
+To include dependencies for plotting, use this command instead:
+
+```bash
+pip install aplr[plots]
+```
+
 ## Availability
 APLR is available for Windows, most Linux distributions, and macOS.
 

aplr-10.13.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+aplr_cpp.cpython-313-darwin.so,sha256=AVg3Kh8LexjVj4LY4Gomzs-sNZU-lkYCSC8nnJwCYPI,1273280
+aplr-10.13.0.dist-info/RECORD,,
+aplr-10.13.0.dist-info/WHEEL,sha256=KreXLeNnYSLDPpk7qnNyKd0DQEhtY-je-mdlEpkBMmo,109
+aplr-10.13.0.dist-info/top_level.txt,sha256=DXVC0RIFGpzVnPeKWAZTXQdJheOEZL51Wip6Fx7zbR4,14
+aplr-10.13.0.dist-info/METADATA,sha256=T8C_-jreoBSoWJuQap5KassYfloS06hmEXKH5gdZxNw,2594
+aplr-10.13.0.dist-info/licenses/LICENSE,sha256=g4qcQtkSVPHtGRi3T93DoFCrssvW6ij_emU-2fj_xfY,1113
+aplr/__init__.py,sha256=rRfTgNWnYZlFatyA920lWqBcjwmQUI7FcvEPFUTJgzE,20
+aplr/aplr.py,sha256=m1Lv4I_tWoWSUqOgXzrM4vFiPcvmGOBZ1XIw_8bkKiA,32299

aplr-10.12.1.dist-info/RECORD

@@ -1,8 +0,0 @@
-aplr_cpp.cpython-313-darwin.so,sha256=c_WW9ZEflvjAjYoAwGb0fcAlz96XvHYJUo3Q64tUJgc,1273280
-aplr/__init__.py,sha256=rRfTgNWnYZlFatyA920lWqBcjwmQUI7FcvEPFUTJgzE,20
-aplr/aplr.py,sha256=Sgpwe0h22J_B8aZGK1uexgb1MVS_Pq4Ygr7YNj3kE_Q,27090
-aplr-10.12.1.dist-info/RECORD,,
-aplr-10.12.1.dist-info/WHEEL,sha256=KreXLeNnYSLDPpk7qnNyKd0DQEhtY-je-mdlEpkBMmo,109
-aplr-10.12.1.dist-info/top_level.txt,sha256=DXVC0RIFGpzVnPeKWAZTXQdJheOEZL51Wip6Fx7zbR4,14
-aplr-10.12.1.dist-info/METADATA,sha256=W8PrVP-Gjop24f06L2ml5guAd0bHhP48y7uhIBErFi8,2362
-aplr-10.12.1.dist-info/licenses/LICENSE,sha256=g4qcQtkSVPHtGRi3T93DoFCrssvW6ij_emU-2fj_xfY,1113