Google Git
Sign in
apache / opennlp-site / asf-site / . / docs / 2.3.2 / apidocs / opennlp-tools / opennlp / tools / langdetect / LanguageDetectorME.html
blob: 01bde59c1857230df97b1275de252214abe5daaf [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>LanguageDetectorME (Apache OpenNLP Tools 2.3.2 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: opennlp.tools.langdetect, class: LanguageDetectorME">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">opennlp.tools.langdetect</a></div>
<h1 title="Class LanguageDetectorME" class="title">Class LanguageDetectorME</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">opennlp.tools.langdetect.LanguageDetectorME</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect">LanguageDetector</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">LanguageDetectorME</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect">LanguageDetector</a></span></div>
<div class="block">Implements a learnable <a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect"><code>LanguageDetector</code></a>.
<p>
This will process the entire string when called with
<a href="#predictLanguage(java.lang.CharSequence)"><code>predictLanguage(CharSequence)</code></a> or
<a href="#predictLanguages(java.lang.CharSequence)"><code>predictLanguages(CharSequence)</code></a>.
</p>
<p>
If you want this to stop early, use <a href="#probingPredictLanguages(java.lang.CharSequence)"><code>probingPredictLanguages(CharSequence)</code></a>
or <a href="#probingPredictLanguages(java.lang.CharSequence,opennlp.tools.langdetect.LanguageDetectorConfig)"><code>probingPredictLanguages(CharSequence, LanguageDetectorConfig)</code></a>.
When run in probing mode, this starts at the beginning of the char sequence
and runs language detection on chunks of text. If the end of the
string is reached or there are <a href="LanguageDetectorConfig.html#getMinConsecImprovements()"><code>LanguageDetectorConfig.getMinConsecImprovements()</code></a>
consecutive predictions for the best language and the confidence
increases over those last predictions and if the difference
in confidence between the highest confidence language
and the second highest confidence language is greater than
<a href="LanguageDetectorConfig.html#getMinDiff()"><code>LanguageDetectorConfig.getMinDiff()</code></a>, the language detector will
stop and report the results.
</p>
<p>
The authors wish to thank Ken Krugler and
<a href="https://github.com/kkrugler/yalder">Yalder</a>}
for the inspiration for many of the design
components of this detector.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../serialized-form.html#opennlp.tools.langdetect.LanguageDetectorME">Serialized Form</a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(opennlp.tools.langdetect.LanguageDetectorModel)" class="member-name-link">LanguageDetectorME</a><wbr>(<a href="LanguageDetectorModel.html" title="class in opennlp.tools.langdetect">LanguageDetectorModel</a>&nbsp;model)</code></div>
<div class="col-last even-row-color">
<div class="block">Initializes an instance with a specific <a href="LanguageDetectorModel.html" title="class in opennlp.tools.langdetect"><code>LanguageDetectorModel</code></a>.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSupportedLanguages()" class="member-name-link">getSupportedLanguages</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Language.html" title="class in opennlp.tools.langdetect">Language</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#predictLanguage(java.lang.CharSequence)" class="member-name-link">predictLanguage</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;content)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Predicts the <a href="Language.html" title="class in opennlp.tools.langdetect"><code>Language</code></a> for the full <code>content</code> length.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Language.html" title="class in opennlp.tools.langdetect">Language</a>[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#predictLanguages(java.lang.CharSequence)" class="member-name-link">predictLanguages</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;content)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Predicts the <a href="Language.html" title="class in opennlp.tools.langdetect"><code>languages</code></a> for the full <code>content</code> length.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProbingLanguageDetectionResult.html" title="class in opennlp.tools.langdetect">ProbingLanguageDetectionResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#probingPredictLanguages(java.lang.CharSequence)" class="member-name-link">probingPredictLanguages</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;content)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This will stop processing early if the stopping criteria
specified in <a href="LanguageDetectorConfig.html#DEFAULT_LANGUAGE_DETECTOR_CONFIG"><code>LanguageDetectorConfig.DEFAULT_LANGUAGE_DETECTOR_CONFIG</code></a>
are met.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProbingLanguageDetectionResult.html" title="class in opennlp.tools.langdetect">ProbingLanguageDetectionResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#probingPredictLanguages(java.lang.CharSequence,opennlp.tools.langdetect.LanguageDetectorConfig)" class="member-name-link">probingPredictLanguages</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;content,
<a href="LanguageDetectorConfig.html" title="class in opennlp.tools.langdetect">LanguageDetectorConfig</a>&nbsp;config)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This will stop processing early if the stopping criteria
specified in <a href="LanguageDetectorConfig.html#DEFAULT_LANGUAGE_DETECTOR_CONFIG"><code>LanguageDetectorConfig.DEFAULT_LANGUAGE_DETECTOR_CONFIG</code></a>
are met.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LanguageDetectorModel.html" title="class in opennlp.tools.langdetect">LanguageDetectorModel</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#train(opennlp.tools.util.ObjectStream,opennlp.tools.util.TrainingParameters,opennlp.tools.langdetect.LanguageDetectorFactory)" class="member-name-link">train</a><wbr>(<a href="../util/ObjectStream.html" title="interface in opennlp.tools.util">ObjectStream</a>&lt;<a href="LanguageSample.html" title="class in opennlp.tools.langdetect">LanguageSample</a>&gt;&nbsp;samples,
<a href="../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a>&nbsp;mlParams,
<a href="LanguageDetectorFactory.html" title="class in opennlp.tools.langdetect">LanguageDetectorFactory</a>&nbsp;factory)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Starts a training of a <a href="LanguageDetectorModel.html" title="class in opennlp.tools.langdetect"><code>LanguageDetectorModel</code></a> with the given parameters.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(opennlp.tools.langdetect.LanguageDetectorModel)">
<h3>LanguageDetectorME</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">LanguageDetectorME</span><wbr><span class="parameters">(<a href="LanguageDetectorModel.html" title="class in opennlp.tools.langdetect">LanguageDetectorModel</a>&nbsp;model)</span></div>
<div class="block">Initializes an instance with a specific <a href="LanguageDetectorModel.html" title="class in opennlp.tools.langdetect"><code>LanguageDetectorModel</code></a>.
Default feature generation is used.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>model</code> - the <a href="LanguageDetectorModel.html" title="class in opennlp.tools.langdetect"><code>LanguageDetectorModel</code></a> to be used.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="predictLanguages(java.lang.CharSequence)">
<h3>predictLanguages</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Language.html" title="class in opennlp.tools.langdetect">Language</a>[]</span>&nbsp;<span class="element-name">predictLanguages</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;content)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="LanguageDetector.html#predictLanguages(java.lang.CharSequence)">LanguageDetector</a></code></span></div>
<div class="block">Predicts the <a href="Language.html" title="class in opennlp.tools.langdetect"><code>languages</code></a> for the full <code>content</code> length.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="LanguageDetector.html#predictLanguages(java.lang.CharSequence)">predictLanguages</a></code>&nbsp;in interface&nbsp;<code><a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect">LanguageDetector</a></code></dd>
<dt>Parameters:</dt>
<dd><code>content</code> - The textual content to detect potential <a href="Language.html" title="class in opennlp.tools.langdetect"><code>languages</code></a> from.</dd>
<dt>Returns:</dt>
<dd>the predicted languages</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="predictLanguage(java.lang.CharSequence)">
<h3>predictLanguage</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Language.html" title="class in opennlp.tools.langdetect">Language</a></span>&nbsp;<span class="element-name">predictLanguage</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;content)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="LanguageDetector.html#predictLanguage(java.lang.CharSequence)">LanguageDetector</a></code></span></div>
<div class="block">Predicts the <a href="Language.html" title="class in opennlp.tools.langdetect"><code>Language</code></a> for the full <code>content</code> length.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="LanguageDetector.html#predictLanguage(java.lang.CharSequence)">predictLanguage</a></code>&nbsp;in interface&nbsp;<code><a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect">LanguageDetector</a></code></dd>
<dt>Parameters:</dt>
<dd><code>content</code> - The textual content to detect potential <a href="Language.html" title="class in opennlp.tools.langdetect"><code>languages</code></a> from.</dd>
<dt>Returns:</dt>
<dd>the language with the highest confidence</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSupportedLanguages()">
<h3>getSupportedLanguages</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span>&nbsp;<span class="element-name">getSupportedLanguages</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="LanguageDetector.html#getSupportedLanguages()">getSupportedLanguages</a></code>&nbsp;in interface&nbsp;<code><a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect">LanguageDetector</a></code></dd>
<dt>Returns:</dt>
<dd>Retrieves an array of language (codes) that are supported by a <a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect"><code>LanguageDetector</code></a>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="probingPredictLanguages(java.lang.CharSequence)">
<h3>probingPredictLanguages</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ProbingLanguageDetectionResult.html" title="class in opennlp.tools.langdetect">ProbingLanguageDetectionResult</a></span>&nbsp;<span class="element-name">probingPredictLanguages</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;content)</span></div>
<div class="block">This will stop processing early if the stopping criteria
specified in <a href="LanguageDetectorConfig.html#DEFAULT_LANGUAGE_DETECTOR_CONFIG"><code>LanguageDetectorConfig.DEFAULT_LANGUAGE_DETECTOR_CONFIG</code></a>
are met.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>content</code> - content to be processed</dd>
<dt>Returns:</dt>
<dd>A computed <a href="ProbingLanguageDetectionResult.html" title="class in opennlp.tools.langdetect"><code>ProbingLanguageDetectionResult</code></a>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="probingPredictLanguages(java.lang.CharSequence,opennlp.tools.langdetect.LanguageDetectorConfig)">
<h3>probingPredictLanguages</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ProbingLanguageDetectionResult.html" title="class in opennlp.tools.langdetect">ProbingLanguageDetectionResult</a></span>&nbsp;<span class="element-name">probingPredictLanguages</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;content,
<a href="LanguageDetectorConfig.html" title="class in opennlp.tools.langdetect">LanguageDetectorConfig</a>&nbsp;config)</span></div>
<div class="block">This will stop processing early if the stopping criteria
specified in <a href="LanguageDetectorConfig.html#DEFAULT_LANGUAGE_DETECTOR_CONFIG"><code>LanguageDetectorConfig.DEFAULT_LANGUAGE_DETECTOR_CONFIG</code></a>
are met.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>content</code> - The textual content to process.</dd>
<dd><code>config</code> - The <a href="LanguageDetectorConfig.html" title="class in opennlp.tools.langdetect"><code>LanguageDetectorConfig</code></a> to customize detection.</dd>
<dt>Returns:</dt>
<dd>A computed <a href="ProbingLanguageDetectionResult.html" title="class in opennlp.tools.langdetect"><code>ProbingLanguageDetectionResult</code></a>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="train(opennlp.tools.util.ObjectStream,opennlp.tools.util.TrainingParameters,opennlp.tools.langdetect.LanguageDetectorFactory)">
<h3>train</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="LanguageDetectorModel.html" title="class in opennlp.tools.langdetect">LanguageDetectorModel</a></span>&nbsp;<span class="element-name">train</span><wbr><span class="parameters">(<a href="../util/ObjectStream.html" title="interface in opennlp.tools.util">ObjectStream</a>&lt;<a href="LanguageSample.html" title="class in opennlp.tools.langdetect">LanguageSample</a>&gt;&nbsp;samples,
<a href="../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a>&nbsp;mlParams,
<a href="LanguageDetectorFactory.html" title="class in opennlp.tools.langdetect">LanguageDetectorFactory</a>&nbsp;factory)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Starts a training of a <a href="LanguageDetectorModel.html" title="class in opennlp.tools.langdetect"><code>LanguageDetectorModel</code></a> with the given parameters.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>samples</code> - The <a href="../util/ObjectStream.html" title="interface in opennlp.tools.util"><code>ObjectStream</code></a> of <a href="LanguageSample.html" title="class in opennlp.tools.langdetect"><code>LanguageSample</code></a> used as input for training.</dd>
<dd><code>mlParams</code> - The <a href="../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> for the context of the training.</dd>
<dd><code>factory</code> - The <a href="LanguageDetectorFactory.html" title="class in opennlp.tools.langdetect"><code>LanguageDetectorFactory</code></a> for creating related objects defined
via <code>mlParams</code>.</dd>
<dt>Returns:</dt>
<dd>A valid, trained <a href="LanguageDetectorModel.html" title="class in opennlp.tools.langdetect"><code>LanguageDetectorModel</code></a> instance.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - Thrown if IO errors occurred.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>