.. python-template documentation master file, created by
   sphinx-quickstart on Wed Apr  9 13:29:29 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pytorch-tabnet2's documentation!
============================================
.. image:: https://img.shields.io/pypi/v/pytorch-tabnet2.svg
   :target: https://pypi.org/project/pytorch-tabnet2/
   :alt: PyPI version

.. image:: https://img.shields.io/pypi/pyversions/pytorch-tabnet2.svg
   :target: https://pypi.org/project/pytorch-tabnet2/
   :alt: Python versions

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

.. image:: https://img.shields.io/badge/ubuntu-blue?logo=ubuntu
   :alt: Ubuntu

.. image:: https://img.shields.io/badge/ubuntu-blue?logo=windows
   :alt: Windows

.. image:: https://img.shields.io/badge/ubuntu-blue?logo=apple
   :alt: MacOS

.. image:: https://codecov.io/gh/DanielAvdar/tabnet/branch/main/graph/badge.svg
   :alt: Coverage

.. image:: https://img.shields.io/github/last-commit/DanielAvdar/tabnet/main
   :alt: Last Commit

.. toctree::
   :maxdepth: 2
   :caption: Introduction

   introduction

.. toctree::
   :maxdepth: 2
   :caption: Guides

   guides/basic_usage
   guides/categorical_embeding_example
   guides/custom_metrics_and_losses
   guides/pretraining_and_transfer
   guides/saving_and_loading

.. toctree::
   :maxdepth: 2
   :caption: Models & Usage

   models/pretrainer
   models/regressor
   models/classifier
   models/multi_regressor
   models/multi_classifier

.. toctree::
   :maxdepth: 2
   :caption: Metrics

   metrics/classification
   metrics/regression
   metrics/unsupervised

.. toctree::
   :maxdepth: 2
   :caption: Credits

   credits

Indices and tables
==================

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