.. list-table::
   :widths: 10 25 25 25
   :header-rows: 0

   * - Meta
     - |python|
     - |docs|
     -
   * - Testing
     - |ci/cd|
     - |coverage|
     - |colab|
   * - PyPI
     - |PyPI|
     - |PyPI_download|
     -
   * - Anaconda
     - |anaconda|
     - |anaconda_download|
     - |anaconda_date|


DeepPeak
========

DeepPeak is a Python package for detecting and localizing peaks in 1D signals using deep learning. Designed for researchers and engineers, it simplifies the process of training and deploying neural networks for peak detection.

Key Features
------------
- **Deep Learning-based Peak Detection**: Leverages Keras and TensorFlow for state-of-the-art performance.
- **Gaussian Peak Handling**: Built-in support for detecting Gaussian-shaped peaks.
- **Custom Signal Support**: Easily adaptable to various types of 1D signals.
- **Easy-to-Use API**: Train and predict with minimal setup.

Contact
-------
For questions or contributions, contact `martin.poinsinet.de.sivry@gmail.com <mailto:martin.poinsinet.de.sivry@gmail.com>`_.

.. |python| image:: https://img.shields.io/pypi/pyversions/deeppeak.svg
    :alt: Python
    :target: https://www.python.org/
.. |colab| image:: https://colab.research.google.com/assets/colab-badge.svg
    :alt: Google Colab
    :target: https://colab.research.google.com/github/MartinPdeS/DeepPeak/blob/master/notebook.ipynb
.. |docs| image:: https://github.com/martinpdes/deeppeak/actions/workflows/deploy_documentation.yml/badge.svg
    :target: https://martinpdes.github.io/DeepPeak/
    :alt: Documentation Status
.. |PyPI| image:: https://badge.fury.io/py/DeepPeak.svg
    :alt: PyPI version
    :target: https://badge.fury.io/py/DeepPeak
.. |PyPI_download| image:: https://img.shields.io/pypi/dm/DeepPeak?style=plastic&label=PyPI%20downloads&labelColor=hex&color=hex
    :alt: PyPI downloads
    :target: https://pypistats.org/packages/deeppeak
.. |coverage| image:: https://raw.githubusercontent.com/MartinPdeS/DeepPeak/python-coverage-comment-action-data/badge.svg
    :alt: Unittest coverage
    :target: https://htmlpreview.github.io/?https://github.com/MartinPdeS/DeepPeak/blob/python-coverage-comment-action-data/htmlcov/index.html
.. |ci/cd| image:: https://github.com/martinpdes/deeppeak/actions/workflows/deploy_coverage.yml/badge.svg
    :alt: Unittest Status
.. |anaconda| image:: https://anaconda.org/martinpdes/deeppeak/badges/version.svg
    :alt: Anaconda version
    :target: https://anaconda.org/martinpdes/deeppeak
.. |anaconda_download| image:: https://anaconda.org/martinpdes/deeppeak/badges/downloads.svg
    :alt: Anaconda downloads
    :target: https://anaconda.org/martinpdes/deeppeak
.. |anaconda_date| image:: https://anaconda.org/martinpdes/deeppeak/badges/latest_release_relative_date.svg
    :alt: Latest release date
    :target: https://anaconda.org/martinpdes/deeppeak
