Skip to main content

A python package for a distance-based classifier which can use several different distance metrics.

Project description

DistClassiPy Logo


PyPI Installs Codecov License - GPL-3 Code style: black

arXiv ascl:2403.002

A python package for a distance-based classifier which can use several different distance metrics.

Installation

To install DistClassiPy, run the following command:

pip install distclassipy

Usage

Here's a quick example to get you started with DistClassiPy:

import distclassipy as dcpy
from sklearn.datasets import make_classification

X, y = make_classification(
    n_samples=1000,
    n_features=4,
    n_informative=2,
    n_redundant=0,
    random_state=0,
    shuffle=False,
)
clf = dcpy.DistanceMetricClassifier(metric="canberra")
clf.fit(X, y)
print(clf.predict([[0, 0, 0, 0]]))

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

Documentation

For more detailed information about the package and its functionalities, please refer to the official documentation.

Contributing

Contributions are welcome! If you have suggestions for improvements or bug fixes, please feel free to open an issue or submit a pull request.

License

DistClassiPy is released under the GNU General Public License v3.0. See the LICENSE file for more details.

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

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},
       eprint = {2403.12120},
       primaryClass = {astro-ph.IM},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2024arXiv240312120C},
       adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

Authors

Siddharth Chaini, Ashish Mahabal, Ajit Kembhavi and Federica B. Bianco.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

distclassipy-0.1.4.tar.gz (54.2 kB view hashes)

Uploaded Source

Built Distribution

distclassipy-0.1.4-py3-none-any.whl (39.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page