INCEpTION 34.2

inception-project · Oct 29, 2024 · f051e7c · f051e7c
1 parent f2e9fa3
commit f051e7c
Show file tree

Hide file tree

Showing 118 changed files with 23,880 additions and 0 deletions.
diff --git a/_data/releases.yml b/_data/releases.yml
@@ -24,6 +24,10 @@
 ### RELEASE VERSIONS
 ###
 
+- version: "34.2"
+  date: 2024-10-29
+  status: stable
+
 - version: "34.1"
   date: 2024-10-15
   status: stable

diff --git a/_use-cases/ruffers-2024/index.md b/_use-cases/ruffers-2024/index.md
@@ -0,0 +1,32 @@
+---
+title: RUFFERS 2024
+subheadline: Recognizing Ultra Fine-grained Entities, Events, and Relations
+permalink: /use-cases/ruffers-2024/
+hidden: false
+---
+
+**Source**: <i>This use-case was kindly contributed by Shudong Huang, U.S. National Institute of Standards and Technology, USA.</i>
+
+The Text Analysis Conference (TAC) is a well-established series of evaluation workshops designed to advance research in Natural Language Processing (NLP) by providing a standardized framework for testing, evaluating, and comparing various NLP systems. 
+TAC fosters innovation by offering large datasets, unified evaluation procedures, and a platform for participants to showcase and discuss their results.
+
+Within TAC, specific challenges, or *tracks,* are organized around different NLP problems. 
+These tracks not only focus on real-world end-user tasks but also include evaluations of critical components required for solving these tasks.
+
+One such track, the RUFEERS track, is aimed at extracting information about entities, events, and relations in a way that can be used as input for knowledge bases. 
+This track addresses real-world needs, such as disaster relief and technical support, where systems must accurately recognize a wide range of entity, event, and relation types—often with limited training data. 
+The challenge for participating systems lies in identifying mentions of approximately 55 event types, 30 relation types, and 350 entity types, spanning diverse topics, in news articles.
+
+To prepare the dataset for the RUFEERS track, the annotation tool INCEpTION was used to facilitate the task of marking up entities, events, and relations in the provided news articles, based on a predefined ontology. 
+INCEpTION was used to prepare the gold-standard data for the following tasks within the track:
+
+1. **Task 1**: Extract one mention of each event, relation, and event/relation argument from each document.
+2. **Task 2**: Extract all mentions of events, relations, and their arguments from each document.
+3. **Task 3**: Extract all mentions of each entity from each document.
+
+Key reasons for choosing INCEpTION as the annotation tool to prepare the task data were the ability to support custom annotation layers and being able to link data against knowledge bases.
+
+
+##### References
+
+[1]: https://tac.nist.gov/2024/RUFEERS/
diff --git a/releases/34.2/docs/admin-guide.html b/releases/34.2/docs/admin-guide.html
diff --git a/releases/34.2/docs/admin-guide/scripts/docker-compose-mysql8.yml b/releases/34.2/docs/admin-guide/scripts/docker-compose-mysql8.yml
@@ -0,0 +1,51 @@
+##
+# docker-compose up [-d]
+# docker-compose down
+##
+version: '2.4'
+
+networks:
+  inception-net:
+
+services:
+  db:
+    image: "mysql:8.3"
+    environment:
+      - MYSQL_RANDOM_ROOT_PASSWORD=yes
+      - MYSQL_DATABASE=inception
+      - MYSQL_USER=${DBUSER:-inception}
+      - MYSQL_PORT=3306
+      - MYSQL_PASSWORD=${DBPASSWORD:-inception}
+    volumes:
+      - ${INCEPTION_DB_HOME:-db-data}:/var/lib/mysql
+    command: ["--character-set-server=utf8mb4", "--collation-server=utf8mb4_bin"]
+    healthcheck:
+      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost", "-p${DBPASSWORD:-inception}", "-u${DBUSER:-inception}"]
+      interval: 20s
+      timeout: 10s
+      retries: 10
+    networks:
+      inception-net:
+
+  app:
+    image: "${INCEPTION_IMAGE:-ghcr.io/inception-project/inception}:${INCEPTION_VERSION:-{revnumber}}"
+    ports:
+      - "${INCEPTION_PORT:-8080}:8080"
+    environment:
+      - INCEPTION_DB_DIALECT=org.hibernate.dialect.MySQL8Dialect
+      - INCEPTION_DB_DRIVER=org.mariadb.jdbc.Driver
+      - INCEPTION_DB_URL=jdbc:mysql://db:3306/inception?useSSL=false&useUnicode=true&characterEncoding=UTF-8
+      - INCEPTION_DB_USERNAME=${DBUSER:-inception}
+      - INCEPTION_DB_PASSWORD=${DBPASSWORD:-inception}
+    volumes:
+      - ${INCEPTION_HOME:-app-data}:/export
+    depends_on:
+      db:
+        condition: service_healthy
+    restart: unless-stopped
+    networks:
+      inception-net:
+
+volumes:
+  app-data:
+  db-data:
diff --git a/releases/34.2/docs/admin-guide/scripts/docker-compose.yml b/releases/34.2/docs/admin-guide/scripts/docker-compose.yml
@@ -0,0 +1,50 @@
+##
+# docker-compose up [-d]
+# docker-compose down
+##
+version: '2.4'
+
+networks:
+  inception-net:
+
+services:
+  db:
+    image: "mariadb:11.4"
+    environment:
+      - MARIADB_RANDOM_ROOT_PASSWORD=yes
+      - MARIADB_DATABASE=inception
+      - MARIADB_USER=${DBUSER:-inception}
+      - MARIADB_PASSWORD=${DBPASSWORD:-inception}
+      - MARIADB_AUTO_UPGRADE=1
+    volumes:
+      - ${INCEPTION_DB_HOME:-db-data}:/var/lib/mysql
+    command: ["--character-set-server=utf8mb4", "--collation-server=utf8mb4_bin"]
+    healthcheck:
+      test: ["CMD", "mariadb-admin" ,"ping", "-h", "localhost", "-p${DBPASSWORD:-inception}", "-u${DBUSER:-inception}"]
+      interval: 20s
+      timeout: 10s
+      retries: 10
+    networks:
+      inception-net:
+
+  app:
+    image: "${INCEPTION_IMAGE:-ghcr.io/inception-project/inception}:${INCEPTION_VERSION:-{revnumber}}"
+    ports:
+      - "${INCEPTION_PORT:-8080}:8080"
+    environment:
+      - INCEPTION_DB_DIALECT=org.hibernate.dialect.MariaDB106Dialect
+      - INCEPTION_DB_URL=jdbc:mariadb://db:3306/inception?useSSL=false&useUnicode=true&characterEncoding=UTF-8
+      - INCEPTION_DB_USERNAME=${DBUSER:-inception}
+      - INCEPTION_DB_PASSWORD=${DBPASSWORD:-inception}
+    volumes:
+      - ${INCEPTION_HOME:-app-data}:/export
+    depends_on:
+      db:
+        condition: service_healthy
+    restart: unless-stopped
+    networks:
+      inception-net:
+
+volumes:
+  app-data:
+  db-data:
diff --git a/releases/34.2/docs/admin-guide/scripts/kubernetes.yml b/releases/34.2/docs/admin-guide/scripts/kubernetes.yml
@@ -0,0 +1,142 @@
+kind: PersistentVolume
+apiVersion: v1
+metadata:
+  name: inception-data-pv
+  labels:
+    type: local
+spec:
+  storageClassName: standard
+  capacity:
+    storage: 5Gi
+  accessModes:
+    - ReadWriteOnce
+  hostPath:
+    path: "/srv/inception-kubernetes/data"
+---
+kind: PersistentVolume
+apiVersion: v1
+metadata:
+  name: inception-log-pv
+  labels:
+    type: local
+spec:
+  storageClassName: standard
+  capacity:
+    storage: 5Gi
+  accessModes:
+    - ReadWriteOnce
+  hostPath:
+    path: "/srv/inception-kubernetes/data"
+---
+kind: PersistentVolume
+apiVersion: v1
+metadata:
+  name: inception-tmp-pv
+  labels:
+    type: local
+spec:
+  storageClassName: standard
+  capacity:
+    storage: 5Gi
+  accessModes:
+    - ReadWriteOnce
+  hostPath:
+    path: "/srv/inception-kubernetes/data"
+---
+kind: PersistentVolumeClaim
+apiVersion: v1
+metadata:
+  name: inception-data-pvc
+spec:
+  storageClassName: standard
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 5Gi
+---
+kind: PersistentVolumeClaim
+apiVersion: v1
+metadata:
+  name: inception-tmp-pvc
+spec:
+  storageClassName: standard
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 5Gi
+---
+kind: PersistentVolumeClaim
+apiVersion: v1
+metadata:
+  name: inception-log-pvc
+spec:
+  storageClassName: standard
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 5Gi
+---
+apiVersion: v1
+kind: Service
+metadata:
+   name: inception-svc
+   labels:
+     app: inception
+spec:
+   type: NodePort
+   ports:
+   - protocol: TCP
+     port: 8080
+     targetPort: 8080
+     nodePort: 32000
+   selector:
+     app: inception
+---     
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: inception
+spec:
+  selector:
+    matchLabels:
+      app: inception
+  replicas: 1
+  template:
+    metadata:
+      labels:
+        app: inception
+    spec:
+      securityContext:
+        runAsUser: 2000
+        runAsGroup: 2000
+        fsGroup: 2000
+        runAsNonRoot: true
+      containers:
+      - name: inception
+        image: "ghcr.io/inception-project/inception-snapshots:{revnumber}"
+        imagePullPolicy: Always
+        ports:
+        - containerPort: 8080
+        securityContext:
+          readOnlyRootFilesystem: true
+          privileged: false
+        volumeMounts:
+        - mountPath: /export
+          name: inception-data-pv
+        - mountPath: /tmp
+          name: inception-tmp-pv
+        - mountPath: /var/log
+          name: inception-log-pv
+      volumes:
+      - name: inception-data-pv
+        persistentVolumeClaim:
+          claimName: inception-data-pvc
+      - name: inception-tmp-pv
+        persistentVolumeClaim:
+          claimName: inception-tmp-pvc
+      - name: inception-log-pv
+        persistentVolumeClaim:
+          claimName: inception-log-pvc