.. smote_cd documentation master file, created by
   sphinx-quickstart on Sat Dec  3 15:46:11 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

SMOTE for compositional data
============================

SMOTE-CD implements an adaptation of the Synthetic Minority Oversampling TEchnique in the case where the labels of the dataset are compositional data.

You can install and start using SMOTE-CD using ``pip`` ::

    python -m pip install smote-cd


Documentation
-------------

You can find a detailed documentation here: 

.. toctree::
   :maxdepth: 3
   
   Install <installation>
   
   User Guide <guide/index>
   
   API reference <refs/index>
   
   
Acknowledgements
----------------

This project was financed by the `BigCEES <https://lma-umr5142.univ-pau.fr/fr/activites-scientifiques/projets-exploratoires-et-seed-funding/bigcees.html>`_ project (`E2S/UPPA <https://e2s-uppa.eu/fr/index.html>`_) and the `Macquarie University <https://www.mq.edu.au/>`_.