[OPENNLP-1346] The Training API code for Tokenization is outdated in manual (1/2)

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.9.4
• Fix Version/s: 2.0.0
• Component/s: Documentation
• Labels: documentation easy-fix

Language

English

• Assignee: Martin Wiesner
• Reporter: Phillip Rhodes
• Created: 24/Nov/21 00:17
• Updated: 09/Dec/22 18:20
• Resolved: 09/Dec/22 18:20

Description

The Training API example code at https://opennlp.apache.org/docs/1.9.4/manual/opennlp.html in the section dealing with Tokenizer training  incorrect. The current code sample is:

ObjectStream<String> lineStream = new PlainTextByLineStream(new FileInputStream("en-sent.train"),
    StandardCharsets.UTF_8);

But PlainTextByLineStream no longer takes an InputStream as the first argument to its constructor. It now requires an InputStreamFactory.

NOTE: this same pattern reappears in multiple places in the current manual. See also, OPENNLP-1319 and OPENNLP-1345

 

Issue Links

• is a clone of: OPENNLP-1345 The Training API code for Sentence Detection is outdated in manual
• is cloned by: OPENNLP-1348 The Training API code for NamedEntityRecognition is outdated in manual
• is fixed by: OPENNLP-1362 Update document to be compatible with latest version PlainTextByLineStream class