Skip to content

Commit

Permalink
add section about intended audience
Browse files Browse the repository at this point in the history
  • Loading branch information
lukavdplas committed Aug 23, 2023
1 parent 0cf25a5 commit ba20749
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ This is a basic wrapper for multiple Dutch compound splitters. The purpose of th
- provide a unified API for multiple compound splitters. The package offers a simple socket server and a Flask application for this purpose.
- evaluate the accuracy of different compound splitters

## Intended audience

The package was initially developed for [T-scan](https://github.com/UUDigitalHumanitieslab/tscan), a natural language analysis application intended for research. For T-scan, we required that users could choose between different algorithms (hence the need for a unified API), and some evaluation of the quality of those algorithms.

The resulting package is useful if you want to run a compound splitting service (e.g. as part of an API or web application), or if you want to evaluate compound splitter methods. Adding new methods, even ones that are not python packages, should be feasible if you have programming experience.

If you are looking for a simple, lightweight python package for compound splitting, this is not it. [compound-word-splitter](https://github.com/TimKam/compound-word-splitter) may be a good alternative for you.

## Compound splitting methods

The following compound splitters are included:

- `compound-splitter-nl`, developed by Katja Hoffman, Valentin Jijkoun, Jaap Kamps, and Christof Monz (LGPL-3.0 license). See https://web.archive.org/web/20200813005715/https://ilps.science.uva.nl/resources/compound-splitter-nl/ for the archived website and https://github.com/bminixhofer/ilps-nl-splitter for an archive of the source code.
Expand Down

0 comments on commit ba20749

Please sign in to comment.