distclassipy 0.1.6a0__tar.gz → 0.2.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: distclassipy
-Version: 0.1.6a0
+Version: 0.2.0
 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
@@ -694,7 +694,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: joblib>=1.3.2
-Requires-Dist: numpy<2,>=1.25.2
+Requires-Dist: numpy>=1.25.2
 Requires-Dist: pandas>=2.0.3
 Requires-Dist: scikit-learn>=1.2.2
 
@@ -740,17 +740,25 @@ X, y = make_classification(
     random_state=0,
     shuffle=False,
 )
-clf = dcpy.DistanceMetricClassifier(metric="canberra")
+# Example usage of DistanceMetricClassifier
+clf = dcpy.DistanceMetricClassifier()
 clf.fit(X, y)
-print(clf.predict([[0, 0, 0, 0]]))
+print(clf.predict([[0, 0, 0, 0]], metric="canberra"))
+
+# Example usage of EnsembleDistanceClassifier
+ensemble_clf = dcpy.EnsembleDistanceClassifier(feat_idx=0)
+ensemble_clf.fit(X, y)
+print(ensemble_clf.predict(X))
 ```
 
 ## Features
 - **Distance Metric-Based Classification**: Utilizes a variety of distance metrics for classification.
 - **Customizable for Scientific Goals**: Allows fine-tuning based on scientific objectives by selecting appropriate distance metrics and features, enhancing both computational efficiency and model performance.
 - **Interpretable Results**: Offers improved interpretability of classification outcomes by directly using distance metrics and feature importance, making it ideal for scientific applications.
-- **Efficient and Scalable**: Demonstrates lower computational requirements compared to traditional methods like Random Forests, making it suitable for large datasets
-- **Open Source and Accessible**: Available as an open-source Python package on PyPI, encouraging broad application in astronomy and beyond
+- **Efficient and Scalable**: Demonstrates lower computational requirements compared to traditional methods like Random Forests, making it suitable for large datasets.
+- **Open Source and Accessible**: Available as an open-source Python package on PyPI, encouraging broad application in astronomy and beyond.
+- **(NEW) Ensemble Distance Classification**: Leverages an ensemble approach to use different distance metrics for each quantile, improving classification performance across diverse data distributions.
+- **(NEW) Expanded Distance Metrics**: DistClassiPy now offers 43 built-in distance metrics, an increase from the previous 18. Additionally, users can still define and use custom distance metrics as needed.
 
 ## Documentation
 

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

@@ -40,17 +40,25 @@ X, y = make_classification(
     random_state=0,
     shuffle=False,
 )
-clf = dcpy.DistanceMetricClassifier(metric="canberra")
+# Example usage of DistanceMetricClassifier
+clf = dcpy.DistanceMetricClassifier()
 clf.fit(X, y)
-print(clf.predict([[0, 0, 0, 0]]))
+print(clf.predict([[0, 0, 0, 0]], metric="canberra"))
+
+# Example usage of EnsembleDistanceClassifier
+ensemble_clf = dcpy.EnsembleDistanceClassifier(feat_idx=0)
+ensemble_clf.fit(X, y)
+print(ensemble_clf.predict(X))
 ```
 
 ## Features
 - **Distance Metric-Based Classification**: Utilizes a variety of distance metrics for classification.
 - **Customizable for Scientific Goals**: Allows fine-tuning based on scientific objectives by selecting appropriate distance metrics and features, enhancing both computational efficiency and model performance.
 - **Interpretable Results**: Offers improved interpretability of classification outcomes by directly using distance metrics and feature importance, making it ideal for scientific applications.
-- **Efficient and Scalable**: Demonstrates lower computational requirements compared to traditional methods like Random Forests, making it suitable for large datasets
-- **Open Source and Accessible**: Available as an open-source Python package on PyPI, encouraging broad application in astronomy and beyond
+- **Efficient and Scalable**: Demonstrates lower computational requirements compared to traditional methods like Random Forests, making it suitable for large datasets.
+- **Open Source and Accessible**: Available as an open-source Python package on PyPI, encouraging broad application in astronomy and beyond.
+- **(NEW) Ensemble Distance Classification**: Leverages an ensemble approach to use different distance metrics for each quantile, improving classification performance across diverse data distributions.
+- **(NEW) Expanded Distance Metrics**: DistClassiPy now offers 43 built-in distance metrics, an increase from the previous 18. Additionally, users can still define and use custom distance metrics as needed.
 
 ## Documentation
 

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

@@ -22,7 +22,17 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 
-from .classifier import DistanceMetricClassifier  # noqa
-from .distances import Distance  # noqa
+from .classifier import (
+    DistanceMetricClassifier,
+    EnsembleDistanceClassifier,
+)
+from .distances import Distance, _ALL_METRICS
 
-__version__ = "0.1.6a0"
+__version__ = "0.2.0"
+
+__all__ = [
+    "DistanceMetricClassifier",
+    "EnsembleDistanceClassifier",
+    "Distance",
+    "_ALL_METRICS",
+]