Apache OpenNLP Add-ons

Clone this repo:
  1. d4dff96 Bump actions/setup-java from 6.0.1 to 6.1.0 (#207) by dependabot[bot] · 2 days ago main
  2. 51960cb OPENNLP-1992: Move to Apache Parent 40 (#203) by dependabot[bot] · 2 weeks ago
  3. 044a206 Bump com.puppycrawl.tools:checkstyle from 14.1.0 to 14.3.0 (#206) by dependabot[bot] · 3 weeks ago
  4. e330df2 Bump org.slf4j:slf4j-api from 2.0.19 to 2.0.20 (#204) by dependabot[bot] · 4 weeks ago
  5. 380febe Bump de.thetaphi:forbiddenapis from 3.10 to 3.11 (#205) by dependabot[bot] · 4 weeks ago

Welcome to Apache OpenNLP Add-ons!

GitHub license Build Status Contributors GitHub pull requests

Apache OpenNLP Add-ons is a set of optional components built on the Apache OpenNLP API.

Each add-on is published as its own Maven artifact, so an application can take a single integration without taking the dependencies of the others. Shared contracts stay in OpenNLP core; an implementation belongs here when it needs a distinct model format, external data, or an optional third-party library.

Useful Links

Overview

Currently, the repository has the following modules:

  • opennlp-addons-docs : The DocBook sources of the add-ons manual.

Getting Started

Depend on the module you need, not on the parent opennlp-addons POM:

Maven

<dependency>
    <groupId>org.apache.opennlp.addons</groupId>
    <artifactId>${addon.artifactId}</artifactId>
    <version>${opennlp-addons.version}</version>
</dependency>

Gradle

compile group: "org.apache.opennlp.addons", name: "${addon.artifactId}", version: "${opennlp-addons.version}"

[!NOTE] No 3.x add-ons release is published yet. Until one is, build this repository locally to use its artifacts.

Building OpenNLP Add-ons

At least JDK 21 and Maven 3.9.6 are required to build the add-ons.

After cloning the repository go into the destination directory and run:

mvn install

A verify build additionally runs Checkstyle, forbidden API checks, the RAT license header check, and a dependency license report. Use -Pjacoco for coverage.

The manual is written in DocBook XML under opennlp-addons-docs/src/docbkx and builds with the rest of the reactor.

Contributing

Every contribution is welcome, from a documentation typo fix to a new add-on. To get involved, please follow the instructions here