From a1294b35e7f392d67f15ef01b63d865f24adfb94 Mon Sep 17 00:00:00 2001
From: David Rouquet <david.rouquet@tetras-libre.fr>
Date: Fri, 15 Dec 2023 13:51:57 +0000
Subject: [PATCH] Update README.md
---
README.md | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index bce14672..80a9ec2c 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
--
GitLab