Skip to content

Commit c7ef135

Browse files
authored
Update README.md
1 parent ca97b5d commit c7ef135

1 file changed

Lines changed: 56 additions & 23 deletions

File tree

README.md

Lines changed: 56 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
![GitHub License](https://img.shields.io/github/license/Texttechnologylab/Unified-Dynamic-Annotation-Visualizer)
2-
![GitHub release (with filter)](https://img.shields.io/github/v/release/Texttechnologylab/Unified-Dynamic-Annotation-Visualizer)
3-
4-
[![Conference](http://img.shields.io/badge/conference-LREC--2026-4b44ce.svg)]([https://2023.emnlp.org/](https://lrec2026.info/))
5-
[![Paper](http://img.shields.io/badge/paper-LREC--2026-fb44ce.svg)]([https://2023.emnlp.org/](https://lrec2026.info/))
6-
7-
# Unified Dynamic Annotation Visualizer
1+
<div align="center">
2+
<a href="/LICENSE"> <img src="https://img.shields.io/github/license/Texttechnologylab/Unified-Dynamic-Annotation-Visualizer"></a>
3+
<a href="https://github.com/texttechnologylab/Unified-Dynamic-Annotation-Visualizer/releases"> <img src="https://img.shields.io/github/v/release/Texttechnologylab/Unified-Dynamic-Annotation-Visualizer"></a>
4+
<a href="https://lrec2026.info/"> <img src="https://img.shields.io/badge/conference-LREC--2026-4b44ce.svg"></a>
5+
<a href="https://lrec2026.info/"> <img src="https://img.shields.io/badge/paper-LREC--2026-fb44ce.svg"></a>
6+
</div>
7+
8+
<div align="center">
9+
<h1>Unified Dynamic Annotation Visualizer</h1>
10+
<img height="200px" src="/src/main/resources/static/img/logo.png"/>
11+
<hr/>
12+
</div>
813

914
UDAV is designed to enable different disciplines to display their automatic pre-processing results in a schema-based and reproducible, dynamic and interactive way without the need to hard-code manual and user-defined visualizations for each new project.
1015

@@ -16,36 +21,65 @@ UDAV is designed to enable different disciplines to display their automatic pre-
1621
### Requirements
1722

1823
- Java version 21 or higher
19-
24+
2025
### Usage
2126

2227
1. Clone the repository:
2328

24-
```
25-
git clone https://github.com/texttechnologylab/Unified-Dynamic-Annotation-Visualizer.git
26-
```
27-
28-
2. Start the `App.java` file
29-
30-
### Development
31-
32-
For setting up UDAV in an development environment, refer to our [documentation](https://texttechnologylab.github.io/Unified-Dynamic-Annotation-Visualizer/).
29+
```
30+
git clone https://github.com/texttechnologylab/Unified-Dynamic-Annotation-Visualizer.git
31+
```
32+
33+
2. In the root folder, create an `.env` file that holds the following environment variables:
34+
35+
```env
36+
DB_URL=jdbc:postgresql://postgres:5432/udav
37+
DB_USER=postgres
38+
DB_PASS=postgres
39+
DB_SCHEMA=public
40+
DB_DIALECT=POSTGRES
41+
# Batch size for database inserts (default: 5000)
42+
# Higher = fewer DB roundtrips, more memory. Range: 1000-15000
43+
DB_BATCH_SIZE=5000
44+
# Max identifier length (PostgreSQL: 63, MySQL: 64, MSSQL: 128)
45+
DB_MAX_IDENT=255
46+
# Enable/disable DUUI importer
47+
DUUI_IMPORTER=false
48+
# Path to input files
49+
DUUI_IMPORTER_PATH=/app/data/input
50+
# File extension: .xmi (uncompressed) or .gz (gzip compressed)
51+
DUUI_IMPORTER_FILE_ENDING=.xmi
52+
# Number of parallel workers (default: 4, rule: 1 per CPU core)
53+
DUUI_IMPORTER_WORKERS=4
54+
# UIMA CAS pool size (default: 2×workers)
55+
DUUI_IMPORTER_CAS_POOL_SIZE=8
56+
# Optional: External TypeSystem XML file path (auto-detected from XMI if not set)
57+
DUUI_IMPORTER_TYPE_SYSTEM_PATH=
58+
PIPELINE_IMPORTER=true
59+
PIPELINE_IMPORTER_FOLDER=/app/data/pipelines
60+
PIPELINE_IMPORTER_REPLACE_IF_DIFFERENT=false
61+
SROUCE_BUILDER=false
62+
JAVA_OPTS=-Xmx2048m -Xms1024m
63+
```
64+
65+
3. Run the File Importer to import the annotation data
66+
67+
4. Start the `App.java` file
68+
69+
> [!NOTE]
70+
> The webpage, by deafult, is reachable under: [http://localhost:8080](http://localhost:8080/). If you're looking for a small demo without creating it yourself, please check our [open demo](udav/demo).
3371
3472
## License
3573

3674
This project is published under the AGPL-3.0 [license](/LICENSE).
3775

38-
3976
# Cite
4077
If you want to use the project please quote this as follows:
4178

4279
Thiemo Dahmann, Julian Schneider, Philipp Stephan, Giuseppe Abrami and Alexander Mehler. 2026. "Towards the Generation and Application of Dynamic Web-Based Visualization of UIMA-based Annotations for Big-Data Corpora with the Help of Unified Dynamic Annotation Visualizer". Proceedings of the 15th International Conference on Language Resources and Evaluation (LREC 2026). _accepted_.
4380

44-
45-
4681
## BibTeX
47-
```
48-
82+
```bib
4983
@inproceedings{Dahmann:et:al:2026,
5084
title = {Towards the Generation and Application of Dynamic Web-Based Visualization
5185
of UIMA-based Annotations for Big-Data Corpora with the Help of
@@ -70,5 +104,4 @@ Thiemo Dahmann, Julian Schneider, Philipp Stephan, Giuseppe Abrami and Alexander
70104
the integration into existing big data frameworks.},
71105
note = {accepted}
72106
}
73-
74107
```

0 commit comments

Comments
 (0)