.. 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 activations-plus's documentation!
============================================
.. image:: https://img.shields.io/pypi/v/activations-plus.svg
   :target: https://pypi.org/project/activations-plus/
   :alt: PyPI version

.. image:: https://img.shields.io/pypi/pyversions/activations-plus.svg
   :target: https://pypi.org/project/activations-plus/
   :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/activations-plus/graph/badge.svg?token=N0V9KANTG2
   :alt: Coverage

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


Activations-plus is a Python library providing a collection of advanced activation functions for pytorch.

Installation
------------

To install activations-plus, use pip:

.. code-block:: bash

    pip install activations-plus



.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   introduction

.. toctree::
   :maxdepth: 2
   :caption: Activation Functions

   activations/entmax
   activations/sparsemax
   activations/bent_identity
   activations/elish
   activations/maxout
   activations/soft_clipping
   activations/srelu

.. toctree::
   :maxdepth: 2
   :caption: Additional Information

   credits

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

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