================
Citation Request
================

Please include these citations if you plan to use this library::

	@article{Thieu_PerMetrics_A_Framework_2024,
		author = {Thieu, Nguyen Van},
		doi = {10.21105/joss.06143},
		journal = {Journal of Open Source Software},
		month = mar,
		number = {95},
		pages = {6143},
		title = {{PerMetrics: A Framework of Performance Metrics for Machine Learning Models}},
		url = {https://joss.theoj.org/papers/10.21105/joss.06143},
		volume = {9},
		year = {2024}
	}

	@article{van2023mealpy,
		title={MEALPY: An open-source library for latest meta-heuristic algorithms in Python},
		author={Van Thieu, Nguyen and Mirjalili, Seyedali},
		journal={Journal of Systems Architecture},
		year={2023},
		publisher={Elsevier},
		doi={10.1016/j.sysarc.2023.102871}
	}

If you have an open-ended or a research question, you can contact me via nguyenthieu2102@gmail.com


==============
Official Links
==============

* Official source code repo: https://github.com/thieu1995/permetrics
* Official document: https://permetrics.readthedocs.io/
* Download releases: https://pypi.org/project/permetrics/
* Issue tracker: https://github.com/thieu1995/permetrics/issues
* Notable changes log: https://github.com/thieu1995/permetrics/blob/master/ChangeLog.md
* Official chat group: https://t.me/+fRVCJGuGJg1mNDg1

* This project also related to our another projects which are "optimization" and "machine learning", check it here:
    * https://github.com/thieu1995/mealpy
    * https://github.com/thieu1995/metaheuristics
    * https://github.com/thieu1995/opfunu
    * https://github.com/thieu1995/enoppy
    * https://github.com/thieu1995/MetaCluster
    * https://github.com/thieu1995/pfevaluator
    * https://github.com/thieu1995/mafese
    * https://github.com/aiir-team


===================
Reference Documents
===================

1) https://www.debadityachakravorty.com/ai-ml/cmatrix/
2) https://neptune.ai/blog/evaluation-metrics-binary-classification
3) https://danielyang1009.github.io/model-performance-measure/
4) https://towardsdatascience.com/multi-class-metrics-made-simple-part-i-precision-and-recall-9250280bddc2
5) http://cran.nexr.com/web/packages/clusterCrit/vignettes/clusterCrit.pdf
6) https://publikationen.bibliothek.kit.edu/1000120412/79692380
7) https://torchmetrics.readthedocs.io/en/latest/
8) http://rasbt.github.io/mlxtend/user_guide/evaluate/lift_score/
9) https://www.baeldung.com/cs/multi-class-f1-score
10) https://kavita-ganesan.com/how-to-compute-precision-and-recall-for-a-multi-class-classification-problem/#.YoXMSqhBy3A
11) https://machinelearningmastery.com/precision-recall-and-f-measure-for-imbalanced-classification/


=======
License
=======

The project is licensed under GNU General Public License (GPL) V3 license.


.. toctree::
   :maxdepth: 4

   version.rst