Welcome to JASMINE's Documentation
=================================

**JASMINE** (JAX Accelerated Statistical Models and Integrated Neural Engine)
is a machine learning library built on JAX for accelerated statistical modeling.

.. image:: https://img.shields.io/badge/python-3.9+-blue.svg
   :target: https://www.python.org/downloads/
   :alt: Python 3.9+

.. image:: https://img.shields.io/badge/JAX-latest-orange.svg
   :target: https://github.com/google/jax
   :alt: JAX

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/licenses/MIT
   :alt: License: MIT

Key Features
------------

* Linear and logistic regression models with JAX acceleration
* KNN and SVM classifiers
* Preprocessing utilities (standard scaling and one-hot encoding)
* Synthetic dataset generators for regression and classification
* Train/test split helpers and model metrics

Table of Contents
-----------------

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   quickstart
   installation
   examples
   performance
   faq
   changelog
   contributing

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/index
   api/linear_model
   api/neighbors
   api/svm
   api/preprocessing
   api/datasets
   api/metrics
   api/model_selection

Support
-------

* **GitHub Issues**: `Report bugs and request features <https://github.com/jaseempaloth/JASMINE/issues>`_
* **Documentation**: `Complete guides and API reference <https://jasmine.readthedocs.io>`_

Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`