distclassipy 0.1.5__tar.gz → 0.1.6a0__tar.gz

{distclassipy-0.1.5 → distclassipy-0.1.6a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: distclassipy
-Version: 0.1.5
+Version: 0.1.6a0
 Summary: A python package for a distance-based classifier which can use several different distance metrics.
 Author-email: Siddharth Chaini <sidchaini@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -765,27 +765,30 @@ DistClassiPy is released under the [GNU General Public License v3.0](https://www
 ## Citation
 
 If you use DistClassiPy in your research or project, please consider citing the paper:
-> Chaini, S., Mahabal, A., Kembhavi, A., & Bianco, F. B. (2024). Light Curve Classification with DistClassiPy: a new distance-based classifier. arXiv. https://doi.org/10.48550/arXiv.2403.12120
+> Chaini, S., Mahabal, A., Kembhavi, A., & Bianco, F. B. (2024). Light Curve Classification with DistClassiPy: a new distance-based classifier. Astronomy and Computing. https://doi.org/10.1016/j.ascom.2024.100850.
 
 ### Bibtex
 
 
 ```bibtex
-@ARTICLE{chaini2024light,
-       author = {{Chaini}, Siddharth and {Mahabal}, Ashish and {Kembhavi}, Ajit and {Bianco}, Federica B.},
-       title = "{Light Curve Classification with DistClassiPy: a new distance-based classifier}",
-       journal = {arXiv e-prints},
-       keywords = {Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Solar and Stellar Astrophysics, Computer Science - Machine Learning},
-       year = 2024,
-       month = mar,
-       eid = {arXiv:2403.12120},
-       pages = {arXiv:2403.12120},
-       archivePrefix = {arXiv},
+@ARTICLE{2024A&C....4800850C,
+       author = {{Chaini}, S. and {Mahabal}, A. and {Kembhavi}, A. and {Bianco}, F.~B.},
+        title = "{Light curve classification with DistClassiPy: A new distance-based classifier}",
+      journal = {Astronomy and Computing},
+     keywords = {Variable stars (1761), Astronomy data analysis (1858), Open source software (1866), Astrostatistics (1882), Classification (1907), Light curve classification (1954), Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Solar and Stellar Astrophysics, Computer Science - Machine Learning},
+         year = 2024,
+        month = jul,
+       volume = {48},
+          eid = {100850},
+        pages = {100850},
+          doi = {10.1016/j.ascom.2024.100850},
+archivePrefix = {arXiv},
        eprint = {2403.12120},
-       primaryClass = {astro-ph.IM},
-       adsurl = {https://ui.adsabs.harvard.edu/abs/2024arXiv240312120C},
-       adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+ primaryClass = {astro-ph.IM},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2024A&C....4800850C},
+      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
 }
+
 ```
   
 

{distclassipy-0.1.5 → distclassipy-0.1.6a0}/README.md

@@ -65,27 +65,30 @@ DistClassiPy is released under the [GNU General Public License v3.0](https://www
 ## Citation
 
 If you use DistClassiPy in your research or project, please consider citing the paper:
-> Chaini, S., Mahabal, A., Kembhavi, A., & Bianco, F. B. (2024). Light Curve Classification with DistClassiPy: a new distance-based classifier. arXiv. https://doi.org/10.48550/arXiv.2403.12120
+> Chaini, S., Mahabal, A., Kembhavi, A., & Bianco, F. B. (2024). Light Curve Classification with DistClassiPy: a new distance-based classifier. Astronomy and Computing. https://doi.org/10.1016/j.ascom.2024.100850.
 
 ### Bibtex
 
 
 ```bibtex
-@ARTICLE{chaini2024light,
-       author = {{Chaini}, Siddharth and {Mahabal}, Ashish and {Kembhavi}, Ajit and {Bianco}, Federica B.},
-       title = "{Light Curve Classification with DistClassiPy: a new distance-based classifier}",
-       journal = {arXiv e-prints},
-       keywords = {Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Solar and Stellar Astrophysics, Computer Science - Machine Learning},
-       year = 2024,
-       month = mar,
-       eid = {arXiv:2403.12120},
-       pages = {arXiv:2403.12120},
-       archivePrefix = {arXiv},
+@ARTICLE{2024A&C....4800850C,
+       author = {{Chaini}, S. and {Mahabal}, A. and {Kembhavi}, A. and {Bianco}, F.~B.},
+        title = "{Light curve classification with DistClassiPy: A new distance-based classifier}",
+      journal = {Astronomy and Computing},
+     keywords = {Variable stars (1761), Astronomy data analysis (1858), Open source software (1866), Astrostatistics (1882), Classification (1907), Light curve classification (1954), Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Solar and Stellar Astrophysics, Computer Science - Machine Learning},
+         year = 2024,
+        month = jul,
+       volume = {48},
+          eid = {100850},
+        pages = {100850},
+          doi = {10.1016/j.ascom.2024.100850},
+archivePrefix = {arXiv},
        eprint = {2403.12120},
-       primaryClass = {astro-ph.IM},
-       adsurl = {https://ui.adsabs.harvard.edu/abs/2024arXiv240312120C},
-       adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+ primaryClass = {astro-ph.IM},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2024A&C....4800850C},
+      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
 }
+
 ```
   
 

{distclassipy-0.1.5 → distclassipy-0.1.6a0}/distclassipy/__init__.py

@@ -25,4 +25,4 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
 from .classifier import DistanceMetricClassifier  # noqa
 from .distances import Distance  # noqa
 
-__version__ = "0.1.5"
+__version__ = "0.1.6a0"

{distclassipy-0.1.5 → distclassipy-0.1.6a0}/distclassipy/classifier.py

@@ -19,6 +19,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 
+import warnings
 from typing import Callable
 
 import numpy as np
@@ -72,8 +73,15 @@ class DistanceMetricClassifier(BaseEstimator, ClassifierMixin):
 
     calculate_kde : bool, default=False
         Whether to calculate a kernel density estimate based confidence parameter.
+        .. deprecated:: 0.2.0
+            This parameter will be removed in a future version and only the
+            distance confidence parameter will be available.
     calculate_1d_dist : bool, default=False
         Whether to calculate the 1-dimensional distance based confidence parameter.
+        .. deprecated:: 0.2.0
+            This parameter will be removed in a future version and only the
+            distance confidence parameter will be available.
+        Whether to calculate the 1-dimensional distance based confidence parameter.
 
     Attributes
     ----------
@@ -87,8 +95,12 @@ class DistanceMetricClassifier(BaseEstimator, ClassifierMixin):
         The statistic used for calculating dispersion.
     calculate_kde : bool
         Indicates whether a kernel density estimate is calculated.
+        .. deprecated:: 0.2.0
+            This parameter will be removed in a future version.
     calculate_1d_dist : bool
         Indicates whether 1-dimensional distances are calculated.
+        .. deprecated:: 0.2.0
+            This parameter will be removed in a future version.
 
     See Also
     --------
@@ -126,15 +138,26 @@ class DistanceMetricClassifier(BaseEstimator, ClassifierMixin):
         scale: bool = True,
         central_stat: str = "median",
         dispersion_stat: str = "std",
-        calculate_kde: bool = True,
-        calculate_1d_dist: bool = True,
+        calculate_kde: bool = True,  # deprecated in 0.2.0
+        calculate_1d_dist: bool = True,  # deprecated in 0.2.0
     ):
         """Initialize the classifier with specified parameters."""
         self.metric = metric
         self.scale = scale
         self.central_stat = central_stat
         self.dispersion_stat = dispersion_stat
+        if calculate_kde:
+            warnings.warn(
+                "calculate_kde is deprecated and will be removed in version 0.2.0",
+                DeprecationWarning,
+            )
         self.calculate_kde = calculate_kde
+
+        if calculate_1d_dist:
+            warnings.warn(
+                "calculate_1d_dist is deprecated and will be removed in version 0.2.0",
+                DeprecationWarning,
+            )
         self.calculate_1d_dist = calculate_1d_dist
 
     def initialize_metric_function(self):
@@ -209,7 +232,9 @@ class DistanceMetricClassifier(BaseEstimator, ClassifierMixin):
         """
         X, y = check_X_y(X, y)
         self.classes_ = unique_labels(y)
-        self.n_features_in_ = X.shape[1]
+        self.n_features_in_ = X.shape[
+            1
+        ]  # Number of features seen during fit - required for sklearn compatibility.
 
         self.initialize_metric_function()
 
@@ -257,6 +282,10 @@ class DistanceMetricClassifier(BaseEstimator, ClassifierMixin):
             self.df_iqr_ = df_iqr
 
         if self.calculate_kde:
+            warnings.warn(
+                "KDE calculation is deprecated and will be removed in version 0.2.0",
+                DeprecationWarning,
+            )
             self.kde_dict_ = {}
 
             for cl in self.classes_:
@@ -271,7 +300,6 @@ class DistanceMetricClassifier(BaseEstimator, ClassifierMixin):
                 )
                 kde.fit(subX)
                 self.kde_dict_[cl] = kde
-
         self.is_fitted_ = True
 
         return self
@@ -382,6 +410,11 @@ class DistanceMetricClassifier(BaseEstimator, ClassifierMixin):
         y_pred = self.classes_[dist_arr.argmin(axis=1)]
 
         if self.calculate_kde:
+            warnings.warn(
+                "KDE calculation in predict_and_analyse is deprecated "
+                "and will be removed in version 0.2.0",
+                DeprecationWarning,
+            )
             # NEW: Rescale in terms of median likelihoods - calculate here
             scale_factors = np.exp(
                 [
@@ -401,8 +434,11 @@ class DistanceMetricClassifier(BaseEstimator, ClassifierMixin):
 
             # NEW: Rescale in terms of median likelihoods - rescale here
             self.likelihood_arr_ = self.likelihood_arr_ / scale_factors
-
         if self.calculate_1d_dist:
+            warnings.warn(
+                "calculate_1d_dist is deprecated and will be removed in version 0.2.0",
+                DeprecationWarning,
+            )
             conf_cl = []
             Xdf_temp = pd.DataFrame(data=X, columns=self.df_centroid_.columns)
             for cl in self.classes_:
@@ -425,7 +461,6 @@ class DistanceMetricClassifier(BaseEstimator, ClassifierMixin):
                 conf_cl.append(confs)
             conf_cl = np.array(conf_cl)
             self.conf_cl_ = conf_cl
-
         self.analyis_ = True
 
         return y_pred
@@ -439,10 +474,13 @@ class DistanceMetricClassifier(BaseEstimator, ClassifierMixin):
 
         Parameters
         ----------
-        method : {"distance_inverse", "1d_distance_inverse","kde_likelihood"},
+        method : {"distance_inverse", "1d_distance_inverse", "kde_likelihood"},
                  default="distance_inverse"
             The method to use for calculating confidence. Default is
             'distance_inverse'.
+            .. deprecated:: 0.2.0
+                The methods '1d_distance_inverse' and
+                'kde_likelihood' will be removed in version 0.2.0.
         """
         check_is_fitted(self, "is_fitted_")
         if not hasattr(self, "analyis_"):
@@ -461,6 +499,11 @@ class DistanceMetricClassifier(BaseEstimator, ClassifierMixin):
             ]
 
         elif method == "1d_distance_inverse":
+            warnings.warn(
+                "The '1d_distance_inverse' method is deprecated "
+                "and will be removed in version 0.2.0",
+                DeprecationWarning,
+            )
             if not self.calculate_1d_dist:
                 raise ValueError(
                     "method='1d_distance_inverse' is only valid if calculate_1d_dist "
@@ -471,6 +514,11 @@ class DistanceMetricClassifier(BaseEstimator, ClassifierMixin):
             )
 
         elif method == "kde_likelihood":
+            warnings.warn(
+                "The 'kde_likelihood' method is deprecated and will be "
+                "removed in version 0.2.0",
+                DeprecationWarning,
+            )
             if not self.calculate_kde:
                 raise ValueError(
                     "method='kde_likelihood' is only valid if calculate_kde is set "

{distclassipy-0.1.5 → distclassipy-0.1.6a0}/distclassipy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: distclassipy
-Version: 0.1.5
+Version: 0.1.6a0
 Summary: A python package for a distance-based classifier which can use several different distance metrics.
 Author-email: Siddharth Chaini <sidchaini@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -765,27 +765,30 @@ DistClassiPy is released under the [GNU General Public License v3.0](https://www
 ## Citation
 
 If you use DistClassiPy in your research or project, please consider citing the paper:
-> Chaini, S., Mahabal, A., Kembhavi, A., & Bianco, F. B. (2024). Light Curve Classification with DistClassiPy: a new distance-based classifier. arXiv. https://doi.org/10.48550/arXiv.2403.12120
+> Chaini, S., Mahabal, A., Kembhavi, A., & Bianco, F. B. (2024). Light Curve Classification with DistClassiPy: a new distance-based classifier. Astronomy and Computing. https://doi.org/10.1016/j.ascom.2024.100850.
 
 ### Bibtex
 
 
 ```bibtex
-@ARTICLE{chaini2024light,
-       author = {{Chaini}, Siddharth and {Mahabal}, Ashish and {Kembhavi}, Ajit and {Bianco}, Federica B.},
-       title = "{Light Curve Classification with DistClassiPy: a new distance-based classifier}",
-       journal = {arXiv e-prints},
-       keywords = {Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Solar and Stellar Astrophysics, Computer Science - Machine Learning},
-       year = 2024,
-       month = mar,
-       eid = {arXiv:2403.12120},
-       pages = {arXiv:2403.12120},
-       archivePrefix = {arXiv},
+@ARTICLE{2024A&C....4800850C,
+       author = {{Chaini}, S. and {Mahabal}, A. and {Kembhavi}, A. and {Bianco}, F.~B.},
+        title = "{Light curve classification with DistClassiPy: A new distance-based classifier}",
+      journal = {Astronomy and Computing},
+     keywords = {Variable stars (1761), Astronomy data analysis (1858), Open source software (1866), Astrostatistics (1882), Classification (1907), Light curve classification (1954), Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Solar and Stellar Astrophysics, Computer Science - Machine Learning},
+         year = 2024,
+        month = jul,
+       volume = {48},
+          eid = {100850},
+        pages = {100850},
+          doi = {10.1016/j.ascom.2024.100850},
+archivePrefix = {arXiv},
        eprint = {2403.12120},
-       primaryClass = {astro-ph.IM},
-       adsurl = {https://ui.adsabs.harvard.edu/abs/2024arXiv240312120C},
-       adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+ primaryClass = {astro-ph.IM},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2024A&C....4800850C},
+      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
 }
+
 ```