diversiformer / README.md
David Pomerenke
parameters
408ae59
---
language:
- de
license: gpl
widget:
- text: "Ersetze \"Lehrer\" durch \"Lehrerin oder Lehrer\": Ein promovierter Mathelehrer ist noch nie im Unterricht eingeschlafen."
example_title: "Example 1"
- text: "Ersetze \"Student\" durch \"studierende Person\": Maria ist kein Student."
example_title: "Example 2"
inference:
parameters:
max_length: 500
---
# Diversiformer 🤗 🏳️‍🌈 🇩🇪
_Work in progress._
Language model for inclusive language in German, fine-tuned on [mT5](https://arxiv.org/abs/2010.11934).
An experimental model version is released [on Huggingface](https://huggingface.co/diversifix/diversiformer).
Source code for fine-tuning is available [on GitHub](https://github.com/diversifix/diversiformer).
## Tasks
- **DETECT**: Recognizes instances of the generic masculine, and of other exclusive language. To do.
- **SUGGEST**: Suggest inclusive alternatives to masculine and exclusive words. To do.
- **REPLACE**: Replace one phrase by another, while preserving grammatical coherence. Work in progress.
- ▶️ `Ersetze "Schüler" durch "Schülerin oder Schüler": Die Schüler kamen zu spät.`
◀️ `Die Schülerinnen und Schüler kamen zu spät.`
- ▶️ `Ersetze "Lehrer" durch "Kollegium": Die wartenden Lehrer wunderten sich.`
◀️ `Das wartende Kollegium wunderte sich.`
## Usage
```python
>>> from transformers import pipeline
>>> generator = pipeline("text2text-generation", model="diversifix/diversiformer")
>>> generator('Ersetze "Schüler" durch "Schülerin oder Schüler": Die Schüler kamen zu spät.', max_length=500)
```
## License
Diversiformer. Transformer model for inclusive language.
Copyright (C) 2022 [Diversifix e. V.](mailto:vorstand@diversifix.org)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.