@@ -44,14 +44,13 @@ terms of information passed, which gives the user a lot of flexibility. The
4444markdown part of the ``README.md `` file comes with a couple of defaults provided
4545by ``skops ``, which includes the following slots for free text sections:
4646
47- - ``"Mode description" ``: A description of the model.
47+ - ``"Model description" ``: A description of the model.
4848- ``"Intended uses & limitations" ``: Intended use for the model, limitations and
4949 potential biases. This section should also include risks of using models in
5050 certain domains if relevant.
5151- ``"How to Get Started with the Model" ``: Code the user can run to load and use
5252 the model.
53- - ``"Model Card Authors" ``: Authors of the model card. This section includes
54- authors of the model card
53+ - ``"Model Card Authors" ``: Authors of the model card.
5554- ``"Model Card Contact" ``: Contact information of people whom can be reached
5655 out, in case of questions about the model or the model card.
5756- ``"Citation" ``: Bibtex style citations for the model or resources used to
@@ -149,7 +148,7 @@ if you used different column alignment than the default, this could change, as
149148well as removing excess empty lines or trailing whitespace. However, the content
150149itself should be exactly the same. All known deviations are documented in the
151150`parse_modelcard docs
152- <https://skops.readthedocs.io/en/stable/modules/classes.html#skops.card.parse_modelcard> `_
151+ <https://skops.readthedocs.io/en/stable/modules/classes.html#skops.card.parse_modelcard> `_.
153152
154153For the parsing part, we rely on `pandoc <https://pandoc.org/ >`_. If you haven't
155154installed it, please follow `these instructions
0 commit comments