Update README.md

README.md

@@ -1,13 +1,47 @@
 ---
+'[object Object]': null
 license: llama3.1
 language:
 - de
 base_model:
-- meta-llama/Llama-3.1-8B-Instruct
 - spacy/de_core_news_lg
-library_name: spacy
+- meta-llama/Llama-3.1-8B-Instruct
 ---
 
-## Model Details
-THIS IS STILL WORK IN PROGRESS! This is a finetuned spacy/de_core_news_lg model. It was finetuned on 50,000 LLM-annotated German news articles. The model is trained to extract names of cities and municipalities from German news articles.
+### Model Description
+
+This is a spaCy model fine-tuned to extract names of cities and municipalities from German news articles. It was trained on 50,000 LLM-annotated (LLAMA 3.1 8B-Instruct) German news articles from the CommonCrawl news dataset.
+
+- **Developed by:** Lukas Kriesch
+- **Model type:** Named Entity Recognition (NER)
+- **Language(s) (NLP):** German
+- **License:** Llama 3.1 Community License Agreement
+- **Finetuned from model [optional]:** spacy/de_core_news_lg
+
+## Uses
+
+### Direct Use
+This model can be directly used to extract city and municipality names from any German-language text source, particularly news articles. Researchers and developers working in geospatial analysis or regional studies may find this useful for location-based analyses.
+
+### Downstream Use
+
+Fine-tuned applications might involve integration into larger workflows for geospatial data processing, population studies, regional analysis, or sentiment analysis in the context of location data.
+
+### Out-of-Scope Use
+The model should not be used to infer broader geographical trends or to analyze texts unrelated to city or municipal locations in Germany. Additionally, it may not perform well on non-news domains or texts that lack clear references to cities or municipalities.
+
+## Bias, Risks, and Limitations
+
+The model is trained specifically on German news articles and may not generalize well to other domains such as social media, legal texts, or scientific literature. Additionally, there may be biases in the training data, particularly if certain regions are underrepresented in the dataset. Users should be cautious about the model's performance across different subpopulations of city or location mentions (e.g., historical names or rare municipalities).
+
+## How to Get Started with the Model
+
+Use the code below to get started with the model.
+
+{{ get_started_code | default("[More Information Needed]", true)}}
 
+#### Training Hyperparameters
+Batch size: 64
+Epochs: Up to 100, with early stopping (patience of 3 epochs)
+Optimizer: Default spaCy optimizer for NER fine-tuning
+Training regime: Mixed precision (fp16)