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.5.tar.gz (56.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

distclassipy-0.1.5-py3-none-any.whl (41.5 kB view details)

Uploaded Python 3

File details

Details for the file distclassipy-0.1.5.tar.gz.

File metadata

  • Download URL: distclassipy-0.1.5.tar.gz
  • Upload date:
  • Size: 56.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for distclassipy-0.1.5.tar.gz
Algorithm Hash digest
SHA256 0ec7496b2611e21607973d1d7d5d63272cdc909e611aa4809893fd1512de12e1
MD5 e803fd58f00bd9c6d756f2ee12856a7a
BLAKE2b-256 a677b7a9a130d4e14cd9a995b00983731d5d4feb00e9947cade086dcb859e4b4

See more details on using hashes here.

File details

Details for the file distclassipy-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: distclassipy-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 41.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for distclassipy-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d82350a6961fdeca77624bfef22cd3d1dd4ba7fa0f32e0589d76bdbc35c1536d
MD5 919e54db3adac616f3047b2e456abc4c
BLAKE2b-256 51aee1d151d8dfc13c96ea7dcff6cedb812d8f49356ee5f74c711b80df2fdf9f

See more details on using hashes here.

Supported by

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