From 58523316d3c7356b172b37cf811eb2e6099cf276 Mon Sep 17 00:00:00 2001
From: Patrick Westphal <patrick.westphal@hitec-hamburg.de>
Date: Wed, 24 Apr 2024 13:38:56 +0200
Subject: [PATCH] Add coypu-EventExtraction

---
 docs/coypu-EventExtraction.md | 37 +++++++++++++++++++++++++++++++++++
 docs/index.md                 |  1 +
 2 files changed, 38 insertions(+)
 create mode 100644 docs/coypu-EventExtraction.md

diff --git a/docs/coypu-EventExtraction.md b/docs/coypu-EventExtraction.md
new file mode 100644
index 0000000..120c95d
--- /dev/null
+++ b/docs/coypu-EventExtraction.md
@@ -0,0 +1,37 @@
+# [coypu-EventExtraction](https://github.com/semantic-systems/coypu-EventExtraction)
+Event Extraction module - Master of Disaster (MoD) - for deployment.
+
+This repo contains both the event type detection and event argument extraction modules for inference. Currently, for the first two MVPs, these two modules are independently implemented, meaning it is error pruned - event type and arguments could be mismatched. 
+The plan is to merge this two modules into one in the last MVP.
+
+- [x] MVP 1: custom Event Detector Event Argument Extractor v1
+- [x] MVP 2: custom Event Detector Event Argument Extractor v2
+- [ ] MVP 3: HiTeC Event Extractor
+
+# Requirement
+- python >= 3.7
+
+Use your favorite virtual environment management tool and 
+```
+pip install -r requirements.txt
+```
+
+# Usage
+
+## Local Gradio Deployment
+Users can create a simple gradio demo where MoD is hosted locally. After the module is instantiated, two links will be generated.
+One local link and another a public link. 
+```
+python event_extractor.py 
+```
+
+## Docker
+Alternatively, you can deploy via docker, which will be using port 5278. 
+```
+docker-compose up
+```
+
+and query via post request,
+```
+curl -i -H “Content-Type: application/json” -X POST -d ‘{“message”: “there was an earthquake in Hamburg last night man damn hot noodles.“}’ http://127.0.0.1:5278
+```
diff --git a/docs/index.md b/docs/index.md
index 08749a0..687924b 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -13,6 +13,7 @@ HITeC/SEMS developed several AI solutions, in particular for Knowledge Extractio
 - [coypu-event-spreading](coypu-event-spreading)
 - [coypu-turbo](coypu-turbo)
 - [coypu-ESG-event-detector](coypu-ESG-event-detector)
+- [coypu-EventExtraction](coypu-EventExtraction)
 
 ## Datasets