Skip to content

Commit

Permalink
DOC: add badges and links to README (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw authored Dec 11, 2024
1 parent 8fec4cf commit cb4de46
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,29 @@
audmodel
========

Library to publish and load machine learning models.
|tests| |coverage| |docs| |python-versions| |license|

**audmodel** publishes and loads machine learning models.

Have a look at the installation_ and usage_ instructions.

.. _installation: https://audeering.github.io/audmodel/installation.html
.. _usage: https://audeering.github.io/audmodel/usage.html


.. badges images and links:
.. |tests| image:: https://github.com/audeering/audmodel/workflows/Test/badge.svg
:target: https://github.com/audeering/audmodel/actions?query=workflow%3ATest
:alt: Test status
.. |coverage| image:: https://codecov.io/gh/audeering/audmodel/branch/main/graph/badge.svg?token=drrULW8vEG
:target: https://codecov.io/gh/audeering/audmodel/
:alt: Code coverage
.. |docs| image:: https://img.shields.io/pypi/v/audmodel?label=docs
:target: https://audeering.github.io/audmodel/
:alt: Documentation
.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
:target: https://github.com/audeering/audmodel/blob/main/LICENSE
:alt: MIT license
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/audmodel.svg
:target: https://pypi.org/project/audmodel/
:alt: Supported Python versions

0 comments on commit cb4de46

Please sign in to comment.