https://github.com/jfilter/german-lemmatizer-docker
✂️ Combining the power of several tools for lemmatization of German text
https://github.com/jfilter/german-lemmatizer-docker
docker-image german lemmas lemmatization lemmatizer python
Last synced: 10 months ago
JSON representation
✂️ Combining the power of several tools for lemmatization of German text
- Host: GitHub
- URL: https://github.com/jfilter/german-lemmatizer-docker
- Owner: jfilter
- License: mit
- Created: 2018-11-11T23:30:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-09-30T19:44:13.000Z (over 3 years ago)
- Last Synced: 2025-08-12T10:55:09.440Z (10 months ago)
- Topics: docker-image, german, lemmas, lemmatization, lemmatizer, python
- Language: Python
- Homepage:
- Size: 63.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# German Lemmatizer Docker Image
A Docker image to [lemmatize](https://en.wikipedia.org/wiki/Lemmatisation) German texts.
Built upon:
- [IWNLP](https://github.com/Liebeck/spacy-iwnlp) uses the crowd-generated token tables on [de.wikitionary](https://de.wiktionary.org/).
- [GermaLemma](https://github.com/WZBSocialScienceCenter/germalemma): Looks up lemmas in the [TIGER Corpus](http://www.ims.uni-stuttgart.de/forschung/ressourcen/korpora/TIGERCorpus/) and uses [Pattern](https://www.clips.uantwerpen.be/pattern) as a fallback for some rule-based lemmatizations.
It works as follows. First [spaCy](https://spacy.io/) tags the token with POS. Then `German Lemmatizer` looks up lemmas on IWNLP and GermanLemma. If they disagree, choose the one from IWNLP. If they agree or only one tool finds it, take it. Try to preserve the casing of the original token.
You may want to use the Python wrapper: [German Lemmatizer](https://github.com/jfilter/german-lemmatizer)
## Installation
1. Install [Docker](https://docs.docker.com/).
## Usage
1. Read and accept the [license terms of the TIGER Corpus](http://www.ims.uni-stuttgart.de/forschung/ressourcen/korpora/TIGERCorpus/license/htmlicense.html) (free to use for non-commercial purposes).
2. Start Docker.
3. To execute, you have two options:
1. To lemmatize a string from the termial, run:
```bash
docker run -it filter/german-lemmatizer:0.5.0 "Was ist das für ein Leben?" [--remove_stop]
```
2. To lemmatize a collection of text, add two local folders to the docker container (NB: you have to give absolute paths):
```bash
docker run -it -v $(pwd)/some_input_folder:/input -v $(pwd)/some_output_folder:/output filter/german-lemmatizer:0.5.0 [--line] [--escape] [--remove_stop]
```
With `--line` each line is treated as a single document instead of the whole file.
With `--escape` The newlines are escaped ('\n' -> '\\\n') for each document (per line), so the text in the input file has to be processed like this.
`--remove_stop` removes stop words as defined by spaCy.
## The Case for Reproduciblilty
Everything – all the code and all the data – is packaged in the Docker image. This means that every lemmatization is reproduceable. For the future, I may update the code and/or data but each images is tagged with a specific version.
## Dev Remarks
- Tried to base in on an [Docker Apline Image](https://hub.docker.com/_/alpine/) but there were too many installation hassels.
- Tried to parallelise with [joblib](https://github.com/joblib/joblib) but it created too much overhead
- To build an image run `docker build -t lemma .` in this folder
- For debugging purposes, you may want enter the container and override the entry point: `docker run -it --entrypoint /bin/bash lemma`
- `docker build -t filter/german-lemmatizer:0.5.0 .` and `docker push filter/german-lemmatizer:0.5.0`
## License
MIT.
## Sponsoring
This work was created as part of a [project](https://github.com/jfilter/ptf) that was funded by the German [Federal Ministry of Education and Research](https://www.bmbf.de/en/index.html).
