diff --git a/README.md b/README.md index bce146720e4de8856fcc3a7c39ce73964f418d59..80a9ec2ccae82e207c9303db6a6b60a728bd28fd 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,17 @@ AMR Batch is a python library to parse natural language sentences in order to build AMR graphs. It requires, as input, a textual document, and gives as output a set of AMR graphs corresponding to each sentence of the input document. -This library is currently under development, and therefore in unstable state. +The library is based on `amrlib` to produce AMR graphs and `amr-ld` to additionaly produce RDF representations of the AMR graphs. +Compared to `amrlib`, AMR Batch is designed to process documents or copora and adds the following features : + +- It processes the text sentence by sentence and produces a directory hierarchy containing different representations of the sentence in AMR : + 1. Penman + 2. dot + 3. PNG + 4. SVG + 5. AMR-RDF in turtle format + 6. AMR-RDF in n-triple format ### Installation This project was developp under Python 3.7 and Manjaro Linux system, but should be run on most common systems (Linux, Windows, Mac). @@ -17,7 +26,7 @@ For example, 'venv' can be create and use with the following commands: source venv/bin/activate -The necessary libraries are defined in the file 'requirements.txt', and can be installed in the virtual environment using package installer as pip: +The necessary libraries are defined in the file 'requirements.txt', and can be installed in the virtual environment using package installer as pip : pip install -r requirements.txt