distclassipy 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

{distclassipy-0.1.0.dist-info → distclassipy-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: distclassipy
-Version: 0.1.0
+Version: 0.1.2
 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
@@ -678,9 +678,9 @@ License: GNU GENERAL PUBLIC LICENSE
         Public License instead of this License.  But first, please read
         <https://www.gnu.org/licenses/why-not-lgpl.html>.
         
-Project-URL: Homepage, https://github.com/sidchaini/DistClassiPy
-Project-URL: Issues, https://github.com/sidchaini/DistClassiPy/issues
-Classifier: Development Status :: 3 - Alpha
+Project-URL: Repository, https://github.com/sidchaini/DistClassiPy
+Project-URL: Documenation, https://sidchaini.github.io/DistClassiPy/
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Science/Research
@@ -698,7 +698,23 @@ Requires-Dist: numpy >=1.26.3
 Requires-Dist: pandas >=2.2.0
 Requires-Dist: scikit-learn >=1.4.0
 
-# DistClassiPy
+<h1 align="center">
+<picture align="center">
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/sidchaini/DistClassiPy/main/docs/_static/logo-dark.svg" width="300">
+  <img alt="DistClassiPy Logo" src="https://raw.githubusercontent.com/sidchaini/DistClassiPy/main/docs/_static/logo.svg" width="300">
+</picture>
+</h1>
+<br>
+
+[![PyPI](https://img.shields.io/pypi/v/distclassipy?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/distclassipy/)
+[![Installs](https://img.shields.io/pypi/dm/distclassipy.svg?label=PyPI%20downloads)](https://pypi.org/project/distclassipy/)
+[![Codecov](https://codecov.io/gh/sidchaini/distclassipy/branch/main/graph/badge.svg)](https://codecov.io/gh/sidchaini/distclassipy)
+[![License - GPL-3](https://img.shields.io/pypi/l/distclassipy.svg)](https://github.com/sidchaini/distclassipy/blob/main/LICENSE)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+<!-- [![Paper](https://img.shields.io/badge/DOI-10.1038%2Fs41586--020--2649--2-blue)](
+https://doi.org/10.1038/s41586-020-2649-2) -->
+
 A python package for a distance-based classifier which can use several different distance metrics.
 
 ## Installation
@@ -711,11 +727,19 @@ pip install distclassipy
 Here's a quick example to get you started with DistClassiPy:
 ```python
 import distclassipy as dcpy
-clf = dcpy.DistanceMetricClassifier()
-# Add your data and labels
-clf.fit(data, labels)
-# Predict new instances
-predictions = clf.predict(new_data)
+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
@@ -735,8 +759,35 @@ 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 package. You can find citation information in the [CITATION.cff](https://github.com/sidchaini/DistClassiPy/CITATION.cff) file.
+If you use DistClassiPy in your research or project, please consider citing the paper:
+> Light Curve Classification with DistClassiPy: a new distance-based classifier (submitted to A&C)
+
+
+<!--
+### Bibtex
+
+
+```bibtex
+@ARTICLE{Chaini2024,
+       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 = {Submitted to A&C},
+    %  keywords = {},
+         year = 2024,
+      %   month = ,
+      %  volume = {},
+      %     eid = {},
+      %   pages = {},
+      %     doi = {},
+      %  adsurl = {},
+      % adsnote = {}
+}
+```
+-->
+  
+
+<!-- You can also find citation information in the [CITATION.cff](https://github.com/sidchaini/DistClassiPy/CITATION.cff) file. -->
 
 
-## Contact
-For any queries, please reach out to Siddharth Chaini at sidchaini@gmail.com.
+## Authors
+Siddharth Chaini, Ashish Mahabal, Ajit Kembhavi and Federica B. Bianco.

distclassipy-0.1.2.dist-info/RECORD

@@ -0,0 +1,9 @@
+distclassipy/__init__.py,sha256=ktlw7OVuC2C6xPV3ZkTpaIo_fuRsXsXDtmrk2ZVgleg,525
+distclassipy/classifier.py,sha256=rvXMgMOL30Vqpbzazl08eYBk0dk5uPVmX3l-u6385zo,17633
+distclassipy/distances.py,sha256=21fsoX6MfeGr7XeV7oqyVZVSr_4aCUYkgr2qriGb3AI,49403
+distclassipy/version.py,sha256=piUqd7Jqjr5Y8FPF5YjkMnmrraDX-H2yHnUGP0QibDo,482
+distclassipy-0.1.2.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+distclassipy-0.1.2.dist-info/METADATA,sha256=foOlSgUE8ZZTxBJR6hCZ9l7rZjNdrUkRJTeUiOkVu0s,45016
+distclassipy-0.1.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+distclassipy-0.1.2.dist-info/top_level.txt,sha256=jiwqhSkq7CMCjV_Zar2dSDBO63o5C_Dp2tpGiVV6COE,13
+distclassipy-0.1.2.dist-info/RECORD,,

{distclassipy-0.1.0.dist-info → distclassipy-0.1.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.2)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

distclassipy-0.1.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-distclassipy/__init__.py,sha256=ktlw7OVuC2C6xPV3ZkTpaIo_fuRsXsXDtmrk2ZVgleg,525
-distclassipy/classifier.py,sha256=d9fh-gaoSvdfPBrpzgAi0mOpqXIV6iTWmf0VW4Stjwc,13777
-distclassipy/distances.py,sha256=SBH92YwH2hI-d777xnbQL6HVOGYje2M4lp19MX4HVEA,46878
-distclassipy/version.py,sha256=piUqd7Jqjr5Y8FPF5YjkMnmrraDX-H2yHnUGP0QibDo,482
-distclassipy-0.1.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-distclassipy-0.1.0.dist-info/METADATA,sha256=is4H77mrtw13iCj7Nt1jBVDk-I3HCxrV6UwwoSocItA,43159
-distclassipy-0.1.0.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-distclassipy-0.1.0.dist-info/top_level.txt,sha256=jiwqhSkq7CMCjV_Zar2dSDBO63o5C_Dp2tpGiVV6COE,13
-distclassipy-0.1.0.dist-info/RECORD,,