From da648c13abdafa43a885fd62d4ecfd6a274e80b4 Mon Sep 17 00:00:00 2001 From: Benjamin Bossan Date: Tue, 9 May 2023 11:21:03 +0200 Subject: [PATCH] [skip ci] DOC some minor updates to README.rst - PyPi => PyPI - add links to docs where appropriate - add link to GH issues --- README.rst | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index e50701ce..f7408e7d 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ .. -*- mode: rst -*- -|readthedocs| |github-actions| |Codecov| |PyPi| |Black| +|readthedocs| |github-actions| |Codecov| |PyPI| |Black| .. |readthedocs| image:: https://readthedocs.org/projects/skops/badge/?version=latest&style=flat :target: https://skops.readthedocs.io/en/latest/ @@ -14,7 +14,7 @@ :target: https://codecov.io/gh/skops-dev/skops :alt: Codecov -.. |PyPi| image:: https://img.shields.io/pypi/v/skops +.. |PyPI| image:: https://img.shields.io/pypi/v/skops :target: https://pypi.org/project/skops :alt: PyPi @@ -40,11 +40,13 @@ download or load the model. `Hugging Face Hub `__, mainly through ``skops.hub_utils.init`` and ``skops.hub_utils.push``. You can see all the models uploaded to the hub using this library `here - `_ + `_. Find out more `here + `_. - ``skops.card``: tools to create a model card explaining what the model does and how it should be used. The model card can then be stored as the ``README.md`` file on the Hugging Face Hub, with pre-populated metadata to - help Hub understand the model. + help Hub understand the model. More information can be found `here + `_. - ``skops.io``: Secure persistence of sklearn estimators and more, without using ``pickle``. Visit `the docs `_ for more @@ -69,5 +71,6 @@ You can install this library using: Bug Reports and Questions ------------------------- -Please send all your questions and report issues on this repository's issue -tracker as an issue. Try to look for existing ones before you create a new one. +Please send all your questions and report issues on `this repository's issue +tracker `_ as an issue. Try to look +for existing ones before you create a new one.