This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opennlp.git
The following commit(s) were added to refs/heads/main by this push:
new c31792e9d GH-1475: Say that opennlp-dl is not in the binary
distribution (#1477)
c31792e9d is described below
commit c31792e9dfb2d56e3e906838012e6731e0e3ca33
Author: Kristian Rickert <[email protected]>
AuthorDate: Sun Oct 11 12:13:31 2026 -0500
GH-1475: Say that opennlp-dl is not in the binary distribution (#1477)
The text embedding section said opennlp-dl is the one provider in the
default distribution. The binary distribution does not include the
opennlp-dl or opennlp-dl-gpu jars, and opennlp-tools does not depend on
them.
Fixes #1475
Signed-off-by: Kristian Rickert <[email protected]>
---
opennlp-docs/src/docbkx/machine-learning.xml | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/opennlp-docs/src/docbkx/machine-learning.xml
b/opennlp-docs/src/docbkx/machine-learning.xml
index 96733f229..a1d5a8660 100644
--- a/opennlp-docs/src/docbkx/machine-learning.xml
+++ b/opennlp-docs/src/docbkx/machine-learning.xml
@@ -149,8 +149,10 @@ org-start wc=ic=1.0 w&c=apache,ic=2.0 p1wc=lc=3.0]]>
<code>TextEmbedder</code> in <code>opennlp-api</code>
accepts text and returns vectors.
<code>TextEmbedderProvider</code> is its provider
interface, resolved through
<code>Providers</code> as described in <xref
linkend="intro.providers"/>. The API names no
- backend: <code>opennlp-dl</code> registers the
<code>onnx</code> provider, and it is the
- default only because it is the one provider in the
default distribution.
+ backend: <code>opennlp-dl</code> registers the
<code>onnx</code> provider. The binary
+ distribution does not include the
<code>opennlp-dl</code> or <code>opennlp-dl-gpu</code>
+ jars, and <code>opennlp-tools</code> does not depend on
them, so add one of them to the
+ application to use it.
</para>
<para>
An embedder is safe for concurrent use until it is
closed. <code>embedAll</code> checks
@@ -177,9 +179,9 @@ try (TextEmbedder embedder =
providers.select(spec).create(spec)) {
<code>sentence_embedding</code> output is used as it
is, without pooling. A spec with
another option is not supported. The key
<code>opennlp.provider.opennlp.tools.embeddings.TextEmbedderProvider</code>
selects a
- provider by name. Excluding <code>opennlp-dl</code>
leaves the API without a provider
- until another one is installed. Existing
<code>SentenceVectorsDL</code> constructors remain
- available.
+ provider by name. Without <code>opennlp-dl</code> or
<code>opennlp-dl-gpu</code> the API
+ has no provider until another one is installed.
Existing <code>SentenceVectorsDL</code>
+ constructors remain available.
</para>
</section>
</chapter>
\ No newline at end of file
