Skip to content

OPENNLP-1757: Expose probs() method in thread-safe probabilistic ME classes#812

Merged
mawiesne merged 1 commit intomainfrom
OPENNLP-1757-Expose-probs()-method-in-thread-safe-probabilistic-ME-classes
Jul 10, 2025
Merged

OPENNLP-1757: Expose probs() method in thread-safe probabilistic ME classes#812
mawiesne merged 1 commit intomainfrom
OPENNLP-1757-Expose-probs()-method-in-thread-safe-probabilistic-ME-classes

Conversation

@mawiesne
Copy link
Contributor

@mawiesne mawiesne commented Jul 7, 2025

Change

  • adds Probabilistic marker interface to API
  • adjusts classic ME and related thread-safe classes to implement common probs() method via Probabilistic interface
  • declares non-common probs-like methods 'getSentenceProbabilities' and 'getTokenProbabilities' deprecated as probs() must now be implemented by all ME classes.
  • improves JavaDoc along the path

Tasks

Thank you for contributing to Apache OpenNLP.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced
    in the commit message?

  • Does your PR title start with OPENNLP-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

  • Has your PR been rebased against the latest commit within the target branch (typically main)?

  • Is your initial contribution a single, squashed commit?

For code changes:

  • Have you ensured that the full suite of tests is executed via mvn clean install at the root opennlp folder?
  • Have you written or updated unit tests to verify your changes?
  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • If applicable, have you updated the LICENSE file, including the main LICENSE file in opennlp folder?
  • If applicable, have you updated the NOTICE file, including the main NOTICE file found in opennlp folder?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check GitHub Actions for build issues and submit an update to your PR as soon as possible.

…lasses

- adds Probabilistic marker interface to API
- adjusts classic ME related thread-safe classes to implement common probs() method via Probabilistic interface
- declares non-common probs-like methods 'getSentenceProbabilities' and 'getTokenProbabilities' deprecated as 'probs()' must now be implemented by all ME classes.
- improves JavaDoc along the path
@mawiesne mawiesne self-assigned this Jul 7, 2025
@mawiesne mawiesne added the java Pull requests that update Java code label Jul 7, 2025
@mawiesne mawiesne requested a review from rzo1 July 8, 2025 11:30
@mawiesne mawiesne merged commit 442e2c7 into main Jul 10, 2025
10 checks passed
@mawiesne mawiesne deleted the OPENNLP-1757-Expose-probs()-method-in-thread-safe-probabilistic-ME-classes branch July 10, 2025 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

java Pull requests that update Java code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants