Welcome to psipose
===================

.. image:: https://img.shields.io/badge/Documentation-ReadTheDocs-blue?logo=readthedocs
   :target: https://psipose.readthedocs.io/

.. image:: https://img.shields.io/badge/GitHub-dduyanhhoang/psipose-blue?logo=github
   :target: https://github.com/dduyanhhoang/psipose

.. image:: https://img.shields.io/pypi/v/psipose?logo=pypi
   :target: https://pypi.org/project/psipose/

**A scikit-learn-compatible quantum machine learning library powered by PennyLane.**

psipose brings the scikit-learn API style to quantum machine learning.
Drop in quantum estimators -- classifiers, regressors, kernels -- that follow
sklearn's conventions, so you can use them in existing sklearn workflows
like ``Pipeline``, ``GridSearchCV``, and ``cross_val_score``.

.. grid:: 2

   .. grid-item-card:: I'm a User
      :link: getting-started/index
      :link-type: doc

      Install psipose, follow tutorials, and use quantum ML in your projects.

   .. grid-item-card:: I'm a Contributor
      :link: contributor-guide/index
      :link-type: doc

      Understand the architecture, add new components, and run tests.

Quick Links
-----------

* :doc:`getting-started/quickstart` -- Get started in 5 minutes
* :doc:`user-guide/classifiers` -- VQCClassifier guide
* :doc:`user-guide/quantum-kernels` -- Quantum kernel SVM
* :doc:`api-reference/index` -- Full API reference

.. toctree::
   :maxdepth: 2
   :hidden:

   getting-started/index
   user-guide/index
   api-reference/index
   tutorials/index
   contributor-guide/index