From b5993f1e8e18c09d854c9ac2166ac300b1e2cea6 Mon Sep 17 00:00:00 2001 From: Ivan Ivanov <54508530+divakaivan@users.noreply.github.com> Date: Tue, 30 Sep 2025 21:14:35 +0100 Subject: [PATCH] DOC Minor text cleanup in model card page --- docs/model_card.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/model_card.rst b/docs/model_card.rst index 32ee1e29..47f46a61 100644 --- a/docs/model_card.rst +++ b/docs/model_card.rst @@ -44,14 +44,13 @@ terms of information passed, which gives the user a lot of flexibility. The markdown part of the ``README.md`` file comes with a couple of defaults provided by ``skops``, which includes the following slots for free text sections: -- ``"Mode description"``: A description of the model. +- ``"Model description"``: A description of the model. - ``"Intended uses & limitations"``: Intended use for the model, limitations and potential biases. This section should also include risks of using models in certain domains if relevant. - ``"How to Get Started with the Model"``: Code the user can run to load and use the model. -- ``"Model Card Authors"``: Authors of the model card. This section includes - authors of the model card +- ``"Model Card Authors"``: Authors of the model card. - ``"Model Card Contact"``: Contact information of people whom can be reached out, in case of questions about the model or the model card. - ``"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 well as removing excess empty lines or trailing whitespace. However, the content itself should be exactly the same. All known deviations are documented in the `parse_modelcard docs -`_ +`_. For the parsing part, we rely on `pandoc `_. If you haven't installed it, please follow `these instructions