From 933a8200f73e4708ee40a5160ab6ad2b0d142848 Mon Sep 17 00:00:00 2001 From: Jeroen Offerijns Date: Fri, 12 Jun 2020 14:29:09 +0200 Subject: [PATCH 1/4] docs: update readme --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3dee157..d0e2b6d 100644 --- a/README.md +++ b/README.md @@ -1,18 +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. + +## Getting started +Make sure you are running Python 3.6 or higher. You can install the package from PyPI: ``` pip install deepmorpheus - -import deepmorpheus -deepmorpheus.load(model_name) -deepmorpheus.tag(doc) ``` +To tag a `.txt` file, simply run: + +``` +import deepmorpheus +deepmorpheus.tag_from_file("input.txt", "ancient-greek") ``` -python train.py -python evaluate.py -python main.py --input doc.txt -python train_embeddings.py -``` \ No newline at end of file From 0e6b6025e8f8332fa529a3afd63132dc386912d6 Mon Sep 17 00:00:00 2001 From: Jeroen Offerijns Date: Fri, 12 Jun 2020 14:30:43 +0200 Subject: [PATCH 2/4] docs: add syntax highlighting to readme code --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d0e2b6d..4ce83b9 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,13 @@ Morphological tagger for Ancient Greek and Latin using deep learning. ## Getting started Make sure you are running Python 3.6 or higher. You can install the package from PyPI: -``` +```shell pip install deepmorpheus ``` To tag a `.txt` file, simply run: -``` +```python import deepmorpheus deepmorpheus.tag_from_file("input.txt", "ancient-greek") From d721e2d1d0f911887a0f9cd85ceafbcb2e1d6de3 Mon Sep 17 00:00:00 2001 From: MGelein Date: Wed, 1 Jul 2020 10:04:29 +0200 Subject: [PATCH 3/4] Added simple example to remember how to use this module --- example.py | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 example.py diff --git a/example.py b/example.py new file mode 100644 index 0000000..66f1533 --- /dev/null +++ b/example.py @@ -0,0 +1,3 @@ +import deepmorpheus + +deepmorpheus.tag_from_file("test_input.txt") \ No newline at end of file From 5a8cccdb121cec6001761123483760d155003d86 Mon Sep 17 00:00:00 2001 From: MGelein Date: Wed, 1 Jul 2020 10:05:18 +0200 Subject: [PATCH 4/4] Already had examples, was blind --- example.py | 3 --- 1 file changed, 3 deletions(-) delete mode 100644 example.py diff --git a/example.py b/example.py deleted file mode 100644 index 66f1533..0000000 --- a/example.py +++ /dev/null @@ -1,3 +0,0 @@ -import deepmorpheus - -deepmorpheus.tag_from_file("test_input.txt") \ No newline at end of file