v0.0.7

With docs
sidchaini · Feb 7, 2024 · 0509a85 · 0509a85
1 parent 4103966
commit 0509a85
Show file tree

Hide file tree

Showing 15 changed files with 58 additions and 18 deletions.
diff --git a/dist/distclassipy-0.0.7-py3-none-any.whl b/dist/distclassipy-0.0.7-py3-none-any.whl
diff --git a/dist/distclassipy-0.0.7.tar.gz b/dist/distclassipy-0.0.7.tar.gz
diff --git a/distclassipy.egg-info/PKG-INFO b/distclassipy.egg-info/PKG-INFO
@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: distclassipy
-Version: 0.0.6
+Version: 0.0.7
 Summary: A python package for a distance-based classifier which can use several different distance metrics.
 Author-email: Siddharth Chaini <[email protected]>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -700,3 +700,43 @@ Requires-Dist: scikit-learn>=1.4.0
 
 # DistClassiPy
 A python package for a distance-based classifier which can use several different distance metrics.
+
+## Installation
+To install DistClassiPy, run the following command:
+```bash
+pip install distclassipy
+```
+
+## Usage
+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)
+```
+
+## Features
+- Multiple distance metrics support
+- Easy integration with existing data processing pipelines
+- Efficient and scalable for large datasets
+
+## Documentation
+
+For more detailed information about the package and its functionalities, please refer to the [official documentation](https://github.com/sidchaini/DistClassiPy).
+
+## Contributing
+Contributions are welcome! If you have suggestions for improvements or bug fixes, please feel free to open an [issue](https://github.com/sidchaini/DistClassiPy/issues) or submit a [pull request](https://github.com/sidchaini/DistClassiPy/pulls).
+
+## License
+DistClassiPy is released under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html). See the LICENSE file for more details.
+
+## Citation
+
+If you use DistClassiPy in your research or project, please consider citing the package. You can find citation information in the [CITATION.md](https://github.com/sidchaini/DistClassiPy/CITATION.md) file.
+
+
+## Contact
+For any queries, please reach out to Siddharth Chaini at [email protected].
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: af7b37c052b5b5b8f96e36de84367bad
+config: 623425d2921e87f0a88d4abca6ad56f1
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.0.5',
+    VERSION: '0.0.7',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/_build/html/classifier.html b/docs/_build/html/classifier.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>DistanceMetricClassifier module &#8212; DistClassiPy 0.0.5 documentation</title>
+    <title>DistanceMetricClassifier module &#8212; DistClassiPy 0.0.7 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
-    <script src="_static/documentation_options.js?v=282f96c0"></script>
+    <script src="_static/documentation_options.js?v=bbaf98b3"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />

diff --git a/docs/_build/html/distances.html b/docs/_build/html/distances.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Distance module &#8212; DistClassiPy 0.0.5 documentation</title>
+    <title>Distance module &#8212; DistClassiPy 0.0.7 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
-    <script src="_static/documentation_options.js?v=282f96c0"></script>
+    <script src="_static/documentation_options.js?v=bbaf98b3"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -4,10 +4,10 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; DistClassiPy 0.0.5 documentation</title>
+    <title>Index &#8212; DistClassiPy 0.0.7 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
-    <script src="_static/documentation_options.js?v=282f96c0"></script>
+    <script src="_static/documentation_options.js?v=bbaf98b3"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="#" />

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Welcome to DistClassiPy’s documentation! &#8212; DistClassiPy 0.0.5 documentation</title>
+    <title>Welcome to DistClassiPy’s documentation! &#8212; DistClassiPy 0.0.7 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
-    <script src="_static/documentation_options.js?v=282f96c0"></script>
+    <script src="_static/documentation_options.js?v=bbaf98b3"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />

diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html
@@ -4,10 +4,10 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Python Module Index &#8212; DistClassiPy 0.0.5 documentation</title>
+    <title>Python Module Index &#8212; DistClassiPy 0.0.7 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
-    <script src="_static/documentation_options.js?v=282f96c0"></script>
+    <script src="_static/documentation_options.js?v=bbaf98b3"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />

diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html
@@ -4,11 +4,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; DistClassiPy 0.0.5 documentation</title>
+    <title>Search &#8212; DistClassiPy 0.0.7 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
 
-    <script src="_static/documentation_options.js?v=282f96c0"></script>
+    <script src="_static/documentation_options.js?v=bbaf98b3"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/searchtools.js"></script>

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/conf.py b/docs/conf.py
@@ -9,7 +9,7 @@
 project = "DistClassiPy"
 copyright = "2024, Siddharth Chaini"
 author = "Siddharth Chaini"
-release = "0.0.5"
+release = "0.0.7"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "distclassipy"
-version = "0.0.6"
+version = "0.0.7"
 description = "A python package for a distance-based classifier which can use several different distance metrics."
 readme = "README.md"
 requires-python = ">=3.10"