diff --git a/README.md b/README.md index 112faf1..4ce83b9 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ # Deep Morpheus -Trying to parse Ancient Greek texts using state of the art neural network techniques. +Morphological tagger for Ancient Greek and Latin using deep learning. -This packages requires Python 3.6+, as well as PyTorch 1.0+. To get started, install the package from PyPI: -``` +## Getting started +Make sure you are running Python 3.6 or higher. You can install the package from PyPI: + +```shell pip install deepmorpheus ``` -Then, you can tag the contents of a text file like this: +To tag a `.txt` file, simply run: + +```python +import deepmorpheus + +deepmorpheus.tag_from_file("input.txt", "ancient-greek") ``` -deepmorpheus.tag_from_file(filepath, "ancient-greek") -``` \ No newline at end of file