.. Permetrics documentation master file, created by
   sphinx-quickstart on Fri Mar 18 21:57:00 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Permetrics's documentation!
======================================

.. image:: https://img.shields.io/badge/release-2.0.1-yellow.svg
   :target: https://github.com/thieu1995/permetrics/releases

.. image:: https://badge.fury.io/py/permetrics.svg
   :target: https://pypi.python.org/pypi/permetrics

.. image:: https://img.shields.io/pypi/pyversions/permetrics.svg
   :target: https://www.python.org/

.. image:: https://img.shields.io/pypi/status/permetrics.svg
   :target: https://img.shields.io/pypi/status/permetrics.svg

.. image:: https://img.shields.io/pypi/dm/permetrics.svg
   :target: https://img.shields.io/pypi/dm/permetrics.svg

.. image:: https://github.com/thieu1995/permetrics/actions/workflows/publish-package.yaml/badge.svg
   :target: https://github.com/thieu1995/permetrics/actions/workflows/publish-package.yaml

.. image:: https://static.pepy.tech/badge/permetrics
   :target: https://pepy.tech/project/permetrics

.. image:: https://img.shields.io/github/release-date/thieu1995/permetrics.svg
   :target: https://img.shields.io/github/release-date/thieu1995/permetrics.svg

.. image:: https://readthedocs.org/projects/permetrics/badge/?version=latest
   :target: https://permetrics.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/badge/Chat-on%20Telegram-blue
   :target: https://t.me/+fRVCJGuGJg1mNDg1

.. image:: https://img.shields.io/github/contributors/thieu1995/permetrics.svg
   :target: https://img.shields.io/github/contributors/thieu1995/permetrics.svg

.. image:: https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?
   :target: https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project

.. image:: https://zenodo.org/badge/280617738.svg
   :target: https://zenodo.org/badge/latestdoi/280617738

.. image:: https://joss.theoj.org/papers/10.21105/joss.06143/status.svg
   :target: https://doi.org/10.21105/joss.06143

.. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
   :target: https://www.gnu.org/licenses/gpl-3.0


PerMetrics is a python library for performance metrics of machine learning models. We aim to implement all
performance metrics for problems such as regression, classification, clustering, ... problems. Helping users in all
field access metrics as fast as possible

* **Free software:** GNU General Public License (GPL) V3 license
* **Total metrics**: 112 (48 regression metrics, 20 classification metrics, 44 clustering metrics)
* **Documentation:** https://permetrics.readthedocs.io/en/latest/
* **Python versions:** >= 3.11
* **Dependencies:** numpy, scipy


.. toctree::
   :maxdepth: 3
   :caption: Quick Start

   pages/quick_start.rst


.. toctree::
   :maxdepth: 2
   :caption: Models Document

   pages/regression.rst
   pages/classification.rst
   pages/clustering.rst


.. toctree::
   :maxdepth: 3
   :caption: Models API:

   pages/permetrics.rst


.. toctree::
   :maxdepth: 3
   :caption: Support:

   pages/support.rst


.. bibliography:: mybibfile.bib