Skip to content

[skip ci] DOC some minor updates to README.rst #357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adrinjalali merged 1 commit into from
May 9, 2023
Merged

[skip ci] DOC some minor updates to README.rst #357

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/
Expand All @@ -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

Expand All @@ -40,11 +40,13 @@ download or load the model.
`Hugging Face Hub <https://hf.co/models>`__, 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
<https://huggingface.co/models?other=skops>`_
<https://huggingface.co/models?other=skops>`_. Find out more `here
<https://skops.readthedocs.io/en/stable/hf_hub.html>`_.
- ``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
<https://skops.readthedocs.io/en/stable/model_card.html>`_.
- ``skops.io``: Secure persistence of sklearn estimators and more, without using
``pickle``. Visit `the docs
<https://skops.readthedocs.io/en/latest/persistence.html>`_ for more
Expand All @@ -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 <https://github.com/skops-dev/skops/issues>`_ as an issue. Try to look
for existing ones before you create a new one.