Mirror of Apache OpenNLP Add-ons

Clone this repo:

Branches

  1. b69e41a [INFRA] Set up default rulesets for default and release branches (#148) by The Apache Software Foundation · 4 days ago main
  2. 3248945 Minor: Regenerated NOTICE File for ed9f3b5148cede82d19b4e62cf12a2a7216d4d10 by mawiesne · 4 days ago
  3. ed9f3b5 Bump org.slf4j:slf4j-api from 2.0.17 to 2.0.18 (#149) by dependabot[bot] · 4 days ago
  4. 3091b0a Updates sandbox components to use OpenNLP 3.0.0-M3 by Martin Wiesner · 10 days ago
  5. c00ee0a OPENNLP-1828: Move to Apache Parent 38 (#147) by dependabot[bot] · 11 days ago

Welcome to Apache OpenNLP!

Build Status Contributors GitHub pull requests Stack Overflow

The Apache OpenNLP library is a machine learning based toolkit for the processing of natural language text.

These addons of the toolkit are written in Java and provide components for special NLP tasks, such as geographic entity linking, Wordnet dictionary access and integration with Liblinear and Morfologik!

The goal of the OpenNLP addons is to provide extra components, potentially in an experimental stage.

OpenNLP addons code can be used programmatically through its Java API, some components even from a terminal through its CLI.

Useful Links

For additional information, visit the OpenNLP Home Page

You can use OpenNLP with any language, demo models are provided here. The models are fully compatible with the latest release, they can be used for testing or getting started.

[!NOTE]
Please train your own models for all other use cases.

Documentation, including JavaDocs, code usage and command-line interface examples are available here

You can also follow our mailing lists for news and updates.

Overview

Currently, the library has different components:

  • geoentitylinker-addon: A set of Java classes that allows for detecting and linking geographic entities.
  • japanese-addon: An addon providing a set of Java classes specialized for processing text written in the Japanese language.
  • jwnl-addon: An addon that uses extJWNL for accessing WordNet-style relational dictionaries.
  • liblinear-addon: An addon that binds to LIBLINEAR via liblinear-java.
  • modelbuilder-addon: A set of Java classes to build models more conveniently.
  • morfologik-addon: An addon that binds to Morfologik.

Getting Started

You can import the addons components directly via Maven, SBT or Gradle after you have built it locally:

Maven

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

SBT

libraryDependencies += "org.apache.opennlp" % "opennlp-addons" % "${opennlp.version}"

Gradle

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

For more details please check our documentation

Building OpenNLP

At least JDK 21 and Maven 3.3.9 are required to build the addons components.

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

mvn install

Contributing

The Apache OpenNLP project is developed by volunteers and is always looking for new contributors to work on all parts of the project. Every contribution is welcome and needed to make it better. A contribution can be anything from a small documentation typo fix to a new component.

If you would like to get involved please follow the instructions here