Update README.md

README.md

@@ -3,4 +3,165 @@ license: mit
 language:
 - de
 library_name: transformers
----
+---
+# German GPT-2 Medium (355M Parameters)
+
+This model is a German variant of GPT-2 with approximately 355 million parameters and a context window of 2048 tokens. 
+It is pre-trained on 300 GB of German text data and is intended as a base model for text generation tasks in the German language.
+
+- **Model Architecture:** GPT-2 medium architecture adapted for the German language with an extended context window.
+- **Languages Supported:** German
+- **Intended Use Cases:** The model is designed for downstream tasks involving text generation in German, such as language modeling and text completion
+
+## Model Details
+
+- **Version:** 1.0 (Initial and likely final release)
+- **Model Type:** Pre-trained language model
+- **Tokenizer:** Utilizes the tokenizer from [stefan-it/german-gpt2-larger](https://huggingface.co/stefan-it/german-gpt2-larger), with the `pad_token` set to the `eos_token`.
+
+
+## Training Data
+
+The model is trained on a large-scale German text corpus derived from Common Crawl data, filtered to include high-quality text such as newspapers and government websites.
+
+- **Name:** German Colossal Clean Common Crawl (GC4) Corpus (filtered version)
+  - This model is trained on all of the **HEAD** files from the GC4 corpus.
+- **Size:** Approximately 300 GB of text data.
+- **Knowledge Cutoff:** 2020
+
+
+## Intended Use
+
+- Base model for fine-tuning on German text generation tasks.
+- Research in natural language processing for the German language.
+
+**Users:** NLP researchers, developers, and practitioners focusing on German language applications.
+
+
+## Limitations
+
+- **Biases:** The model may reflect biases present in the training data, including stereotypes or offensive content.
+- **No Content Filtering:** The model lacks guardrails and may generate inappropriate or harmful text.
+- **Outdated Information:** Contains knowledge up to 2020; does not include events after this date.
+
+
+## Ethical Considerations and Bias
+
+**Disclaimer:**
+
+The presented and trained language model is for **research purposes only**. The GC4 corpus—used for training—contains crawled texts from the internet. Thus, this GPT-2 model can be considered as highly biased, potentially encoding stereotypical associations along gender, race, ethnicity, and disability status. Before using and working with the released checkpoints, it is highly recommended to read:
+
+- **"On the Dangers of Stochastic Parrots: Can Language Models Be Too Big?"** by Emily M. Bender, Timnit Gebru, Angelina McMillan-Major, and Shmargaret Shmitchell.
+
+**Potential Risks:**
+
+- Generation of biased or offensive content.
+- Misrepresentation of factual information.
+- Propagation of stereotypes.
+
+**Mitigation Strategies:**
+
+- Implement bias mitigation techniques and content filtering appropriate for your use case.
+- Use the model in controlled settings with human oversight.
+- Perform thorough evaluation before deployment.
+
+
+## How to Use
+
+ ```python
+ from transformers import AutoModelForCausalLM, AutoTokenizer
+
+ model_name = "your-model-identifier"  # Replace with your model's identifier
+ tokenizer = AutoTokenizer.from_pretrained("kkirchheim/german-gpt2-medium")
+ model = AutoModelForCausalLM.from_pretrained(model_name)
+ ```
+
+**Code Example:**
+
+```python
+from transformers import pipeline
+
+model_name = "kkirchheim/german-gpt2-medium"  # Replace with your model's identifier
+
+generator = pipeline('text-generation', model=model_name, tokenizer=tokenizer)
+
+prompt = "Das Leben ist schön, weil"
+outputs = generator(prompt, max_length=50, num_return_sequences=1)
+
+print(outputs[0]['generated_text'])
+```
+
+## Acknowledgments
+
+- **Funding:** Chair of Software and Systems Engineering at the Otto-von-Guericke University of Magdeburg.
+- **Contributors:** Konstantin Kirchheim
+- **Third-Party Resources:**
+  - Tokenizer and initial model architecture from [stefan-it/german-gpt2-larger](https://huggingface.co/stefan-it/german-gpt2-larger).
+
+
+---
+
+**Disclaimer:** This model is provided for **research purposes only** and comes with no warranties. The authors are not responsible for any output generated by the model. Users should exercise caution and are responsible for compliance with applicable laws and regulations.
+
+
+**Changelog:**
+
+- **Version 1.0:** Initial release.
+
+
+**Future Work:**
+
+- No planned updates or future releases at this time.
+
+
+**Notes:**
+
+- **Ethical Use:** Users should ensure that the model is used ethically and responsibly, considering potential impacts on individuals and society.
+- **Legal Considerations:** Users should perform their own due diligence regarding the permissible use of the model and its outputs.
+
+
+**FAQ:**
+
+*Q: Can I use this model for commercial purposes?*
+
+A: The model is intended for research purposes only. Commercial use is not advised without proper legal consultation.
+
+*Q: How do I address potential biases in the model's outputs?*
+
+A: Implement bias mitigation strategies and content filtering appropriate for your use case. Always review the model's outputs critically.
+
+
+
+## Training Procedure
+
+**Hyperparameters:**
+
+- **Optimizer:** AdamW (Torch implementation)
+- **Learning Rate:** `6e-4`
+- **Batch Size:**
+  - **Per Device Train Batch Size:** 12
+  - **Gradient Accumulation Steps:** 12
+  - **Effective Batch Size:** 144 (12 * 12)
+- **Number of Epochs:** 1 (single pass over the dataset)
+- **Warmup Steps:** 1,000
+- **Weight Decay:** 0.1
+- **Mixed Precision Training:** Enabled (`fp16=True`)
+- **Gradient Checkpointing:** Enabled
+- **Evaluation Strategy:**
+  - **Evaluation Steps:** Every 100 steps
+  - **Per Device Evaluation Batch Size:** 12
+- **Logging:**
+  - **Logging Steps:** Every 10 steps
+  - **Logging to:** TensorBoard
+
+**Training Hardware:**
+
+- **Compute Resources:** 4 NVIDIA A100 GPUs with 40 GB memory each.
+- **Training Duration:** Approximately 1.5 months.
+- **Parallelism:** Distributed Data Parallel (DDP)
+
+**Additional Training Details:**
+
+- **Resume from Checkpoint:** Enabled (`resume_from_checkpoint=True`)
+- **Optimizer Settings:**
+  - Used `adamw_torch` optimizer.