Update README.md

README.md

@@ -1,3 +1,51 @@
----
-license: mit
----
+---
+
+language: nl
+tags:
+- Dutch
+- Flemish
+- RoBERTa
+- RobBERT
+- BERT
+- lblod
+- abb
+- agentschap binnenlands bestuur
+license: mit
+datasets:
+- Lokaal-Beslist
+---
+
+# RobBERT-2023-abb-classifier: Model fine-tuned on Flemish Local Decisions for ABB
+
+Multilabel classifier built using [svercoutere/robbert-2023-dutch-base-abb](https://huggingface.co/svercoutere/robbert-2023-dutch-base-abb), trained on the data of [Lokaal Beslist](https://www.vlaanderen.be/lokaal-bestuur/data-en-tools/lokaal-beslist).
+Specifically, we used the subset of [svercoutere/llama3_abb_instruct_dataset](https://huggingface.co/datasets/svercoutere/llama3_abb_instruct_dataset) related to the classification of agenda items.
+The model assigns one or more labels from the following top-level categories:
+
+[
+'stadsbestuur'
+'samenleven, welzijn en gezondheid'
+'wonen en (ver)bouwen'
+'groen en milieu'
+'mobiliteit en openbare werken'
+'cultuur, sport en vrije tijd'
+'werken en ondernemen'
+'onderwijs en kinderopvang'
+'burgerzaken'
+'veiligheid en preventie'
+]
+
+## How to use
+
+Download the files, load them into spaCy, and use as follows:
+
+```python
+import spacy
+nlp = load("../robbert-2023-abb-agendapunten-classifier")
+
+text = """
+2021_CBS_01153 - 2021/00226M - Aktename melding voor het bouwen van een veranda langs Berkenstraat 3 in 3950 Bocholt - Goedkeuring Aktename melding voor het bouwen van een veranda langs de Berkenstraat
+"""
+doc = nlp(text)
+
+print(doc.cats)
+```