deploy: 35c8126

sidchaini · Feb 8, 2024 · bff7837 · bff7837
commit bff7837
Show file tree

Hide file tree

Showing 29 changed files with 3,625 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +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: c63f8469dddd2cae4394ccabc6f02df8
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/classifier.doctree b/.doctrees/classifier.doctree
diff --git a/.doctrees/distances.doctree b/.doctrees/distances.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_sources/classifier.rst.txt b/_sources/classifier.rst.txt
@@ -0,0 +1,7 @@
+DistanceMetricClassifier module
+===============================
+
+.. automodule:: distclassipy.classifier
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/distances.rst.txt b/_sources/distances.rst.txt
@@ -0,0 +1,7 @@
+Distance module
+===============
+
+.. automodule:: distclassipy.distances
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,63 @@
+.. DistClassiPy documentation master file, created by
+   sphinx-quickstart on Wed Feb  7 16:42:22 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to DistClassiPy's documentation!
+========================================
+
+DistClassiPy is a Python package for a distance-based classifier which can use several different distance metrics.
+
+Installation
+------------
+
+To install DistClassiPy, run the following command:
+
+.. code-block:: bash
+
+    pip install distclassipy
+
+Usage
+-----
+
+Here's a quick example to get you started with DistClassiPy:
+
+.. code-block:: 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
+
+Contact
+-------
+
+For any queries, please reach out to Siddharth Chaini at sidchaini@gmail.com.
+
+
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+API Documentation
+-----------------
+
+.. toctree::
+   :maxdepth: 2
+   :caption: API Reference
+
+   classifier
+   distances