Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rst-workbench/rst-workbench
rst-workbench enables the hassle-free installation of RST parsers. It lets you visually compare their results in your browser.
https://github.com/rst-workbench/rst-workbench
discourse discourse-analysis docker linguistics nlp rhetorical-parser rhetorical-structure-theory rst webapp
Last synced: about 7 hours ago
JSON representation
rst-workbench enables the hassle-free installation of RST parsers. It lets you visually compare their results in your browser.
- Host: GitHub
- URL: https://github.com/rst-workbench/rst-workbench
- Owner: rst-workbench
- Created: 2018-02-12T19:47:13.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T12:35:00.000Z (9 months ago)
- Last Synced: 2024-04-12T15:23:23.853Z (9 months ago)
- Topics: discourse, discourse-analysis, docker, linguistics, nlp, rhetorical-parser, rhetorical-structure-theory, rst, webapp
- Language: JavaScript
- Homepage: https://rst-workbench.arne.cl/
- Size: 1.92 MB
- Stars: 17
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# rst-workbench
The `rst-workbench` lets you easily
install and run existing RST parsers usind Docker containers.
It provides a convenient web app for running multiple RST parsers concurrently
and allows you to visualize and post-edit the trees produced by the parsers.
Here's a [video](https://www.youtube.com/watch?v=-zpdhp5nu-M) demonstrating its usage.
You can also try our demo server at https://rst-workbench.arne.cl/.
\
For installation instructions and usage examples, see [below](#installation).
## Supported Parsers
Currently, we support the following RST parsers that we provide as Docker
containers with a REST API and pre-trained on RST-DT:
- HILDA (Hernault et al. 2010) [[our repo](https://github.com/nlpbox/hilda-service)] [[paper](http://journals.linguisticsociety.org/elanguage/dad/article/download/591/591-2300-1-PB.pdf)]
- HILDA itself is only available from the [Prendinger lab](http://research.nii.ac.jp/%7Eprendinger/),
so we can't provide automated builds but only the build scripts here.
- Feng and Hirst (2014) [[our repo](https://github.com/NLPbox/feng-hirst-service)] [[paper](https://www.aclweb.org/anthology/P14-1048/)]
- DPLP (Ji and Eisenstein 2014) [[our repo](https://github.com/NLPbox/dplp-service)] [[paper](https://www.aclweb.org/anthology/P14-1002/)]
- Heilman and Sagae (2015) [[our repo](https://github.com/NLPbox/heilman-sagae-2015-service)] [[paper](https://arxiv.org/abs/1505.02425)]
- CODRA (Joty et al. 2015) [[our repo](https://github.com/NLPbox/codra-service)] [[paper](https://www.mitpressjournals.org/doi/abs/10.1162/COLI_a_00226)]
- StageDP (Wang et al. 2017) [[our repo](https://github.com/nlpbox/stagedp-service)] [[paper](https://www.aclweb.org/anthology/P17-2029/)]
- the parser requires EDU-segmented input, so we combine it with the NeuralEDUSeg discourse segmenter [(Wang et al. 2018)](https://www.aclweb.org/anthology/D18-1116/)
## Installation
Please install [Docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/) first,
then clone this repo including its submodules.
```
git clone --recurse-submodules https://github.com/rst-workbench/rst-workbench
```
### Usage on your local machine
To run the rst-workbench on your local machine, simply run
`DOMAIN=localhost docker compose up --build --force-recreate` in the folder into which you cloned the repo.
On the first run, this will take a long time and download the Docker containers of all supported RST parsers.
On all subsequent runs, this will be much quicker and simply start the Docker containers from your hard drive.
Once it has started, go to http://localhost:8000/ in your browser to use the web interface.
By setting set the `DOMAIN` to `localhost`, the rst-workbench will be only available on the
machine where you run this command. The parameters `--build` and `--force-recreate` should
not be needed on normal runs, but you will need them whenever you change the configuration.
### Usage on a server
The repo contains everything necessary to run our demo server at https://rst-workbench.arne.cl/ .
We usually start it like this:
```
DOMAIN=rst-workbench.arne.cl docker compose -f docker-compose-server.yml up --build --force-recreate
```
To make it work on your domain, you will need to change the `domains` and `email` variables
in the file `nginx-certbot/init-letsencrypt.sh`.
## Citation
If you use rst-workbench, rst-converter-service or any of the dockerized RST parsers,
please consider citing our paper:
```
@inproceedings{neumann-2021-rst-workbench,
title = "Using and comparing {R}hetorical {S}tructure {T}heory parsers with rst-workbench",
author = "Neumann, Arne",
booktitle = "Proceedings of the 16th Conference of the European Chapter of the Association for Computational Linguistics: System Demonstrations",
month = apr,
year = "2021",
address = "Online",
publisher = "Association for Computational Linguistics",
url = "https://www.aclweb.org/anthology/2021.eacl-demos.1",
pages = "1--6",
}
```