Create README.md

README.md

@@ -0,0 +1,37 @@
+---
+license: cc0-1.0
+language:
+- fi
+- sv
+- en
+pipeline_tag: text-classification
+thumbnail: https://raw.githubusercontent.com/NatLibFi/FintoAI/main/ai.finto.fi/static/img/finto-ai-social.png
+tags:
+- glam
+- lam
+- subject indexing
+- annif
+---
+# FintoAI-data-YSO
+This repository is for the [Annif](https://annif.org) projects with the
+[YSO vocabulary](https://finto.fi/yso)
+used at the [Finto AI service](https://ai.finto.fi/).
+The current models were published there 2023-09-04.
+The models have been trained on Python 3.8.10 with version Annif 1.0.0.
+The configurations of the projects are in individual .cfg files in the root of
+this repository.
+
+The GitHub repository [FintoAI-data-YSO](https://github.com/NatLibFi/FintoAI-data-YSO) contains the
+project configurations and the DVC pipeline used in training and
+evaluating the projects.
+
+The training corpora that are public can be found from the [Annif-corpora repository](https://github.com/NatLibFi/Annif-corpora/).
+
+## Usage
+
+To download selected projects with Annif use the `annif download` command, for
+example run
+
+    annif download "*-fi" NatLibFi/FintoAI-data-YSO
+
+See [Annif wiki](https://github.com/NatLibFi/Annif/wiki/Hugging-Face-Hub-integration) for more information.