Google Git
Sign in
apache / spark-website / 2c562896505588421cce257d111c8ba3805528c2 / . / site / docs / 3.4.3 / api / java / org / apache / spark / ml / feature / Word2VecModel.html
blob: e6bc5ec7ef1aef6008f6926afc1fe87f9dffbfa3 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_402) on Mon Apr 15 02:02:01 UTC 2024 -->
<title>Word2VecModel (Spark 3.4.3 JavaDoc)</title>
<meta name="date" content="2024-04-15">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Word2VecModel (Spark 3.4.3 JavaDoc)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html" title="interface in org.apache.spark.ml.feature"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.Data$.html" title="class in org.apache.spark.ml.feature"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/ml/feature/Word2VecModel.html" target="_top">Frames</a></li>
<li><a href="Word2VecModel.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.spark.ml.feature</div>
<h2 title="Class Word2VecModel" class="title">Class Word2VecModel</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">org.apache.spark.ml.PipelineStage</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/spark/ml/Transformer.html" title="class in org.apache.spark.ml">org.apache.spark.ml.Transformer</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/spark/ml/Model.html" title="class in org.apache.spark.ml">org.apache.spark.ml.Model</a>&lt;<a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html" title="class in org.apache.spark.ml.feature">Word2VecModel</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.ml.feature.Word2VecModel</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, org.apache.spark.internal.Logging, <a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html" title="interface in org.apache.spark.ml.feature">Word2VecBase</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasInputCol.html" title="interface in org.apache.spark.ml.param.shared">HasInputCol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html" title="interface in org.apache.spark.ml.param.shared">HasMaxIter</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasOutputCol.html" title="interface in org.apache.spark.ml.param.shared">HasOutputCol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasSeed.html" title="interface in org.apache.spark.ml.param.shared">HasSeed</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasStepSize.html" title="interface in org.apache.spark.ml.param.shared">HasStepSize</a>, <a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a>, <a href="../../../../../org/apache/spark/ml/util/MLWritable.html" title="interface in org.apache.spark.ml.util">MLWritable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Word2VecModel</span>
extends <a href="../../../../../org/apache/spark/ml/Model.html" title="class in org.apache.spark.ml">Model</a>&lt;<a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html" title="class in org.apache.spark.ml.feature">Word2VecModel</a>&gt;
implements <a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html" title="interface in org.apache.spark.ml.feature">Word2VecBase</a>, <a href="../../../../../org/apache/spark/ml/util/MLWritable.html" title="interface in org.apache.spark.ml.util">MLWritable</a></pre>
<div class="block">Model fitted by <a href="../../../../../org/apache/spark/ml/feature/Word2Vec.html" title="class in org.apache.spark.ml.feature"><code>Word2Vec</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.spark.ml.feature.Word2VecModel">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.Data$.html" title="class in org.apache.spark.ml.feature">Word2VecModel.Data$</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.Word2VecModelWriter$.html" title="class in org.apache.spark.ml.feature">Word2VecModel.Word2VecModelWriter$</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.spark.internal.Logging">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.spark.internal.Logging</h3>
<code>org.apache.spark.internal.Logging.SparkShellLoggingFilter</code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html" title="class in org.apache.spark.ml.feature">Word2VecModel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#copy-org.apache.spark.ml.param.ParamMap-">copy</a></span>(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extra)</code>
<div class="block">Creates a copy of this instance with the same UID and some extra params.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;<a href="../../../../../org/apache/spark/sql/Row.html" title="interface in org.apache.spark.sql">Row</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#findSynonyms-java.lang.String-int-">findSynonyms</a></span>(String&nbsp;word,
int&nbsp;num)</code>
<div class="block">Find "num" number of words closest in similarity to the given word, not
including the word itself.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;<a href="../../../../../org/apache/spark/sql/Row.html" title="interface in org.apache.spark.sql">Row</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#findSynonyms-org.apache.spark.ml.linalg.Vector-int-">findSynonyms</a></span>(<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a>&nbsp;vec,
int&nbsp;num)</code>
<div class="block">Find "num" number of words whose vector representation is most similar to the supplied vector.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>scala.Tuple2&lt;String,Object&gt;[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#findSynonymsArray-java.lang.String-int-">findSynonymsArray</a></span>(String&nbsp;word,
int&nbsp;num)</code>
<div class="block">Find "num" number of words closest in similarity to the given word, not
including the word itself.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>scala.Tuple2&lt;String,Object&gt;[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#findSynonymsArray-org.apache.spark.ml.linalg.Vector-int-">findSynonymsArray</a></span>(<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a>&nbsp;vec,
int&nbsp;num)</code>
<div class="block">Find "num" number of words whose vector representation is most similar to the supplied vector.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;<a href="../../../../../org/apache/spark/sql/Row.html" title="interface in org.apache.spark.sql">Row</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#getVectors--">getVectors</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#inputCol--">inputCol</a></span>()</code>
<div class="block">Param for input column name.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html" title="class in org.apache.spark.ml.feature">Word2VecModel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#load-java.lang.String-">load</a></span>(String&nbsp;path)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#maxIter--">maxIter</a></span>()</code>
<div class="block">Param for maximum number of iterations (&amp;gt;= 0).</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#maxSentenceLength--">maxSentenceLength</a></span>()</code>
<div class="block">Sets the maximum length (in words) of each sentence in the input data.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#minCount--">minCount</a></span>()</code>
<div class="block">The minimum number of times a token must appear to be included in the word2vec model's
vocabulary.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#numPartitions--">numPartitions</a></span>()</code>
<div class="block">Number of partitions for sentences of words.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#outputCol--">outputCol</a></span>()</code>
<div class="block">Param for output column name.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/ml/util/MLReader.html" title="class in org.apache.spark.ml.util">MLReader</a>&lt;<a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html" title="class in org.apache.spark.ml.feature">Word2VecModel</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#read--">read</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/LongParam.html" title="class in org.apache.spark.ml.param">LongParam</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#seed--">seed</a></span>()</code>
<div class="block">Param for random seed.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html" title="class in org.apache.spark.ml.feature">Word2VecModel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#setInputCol-java.lang.String-">setInputCol</a></span>(String&nbsp;value)</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html" title="class in org.apache.spark.ml.feature">Word2VecModel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#setOutputCol-java.lang.String-">setOutputCol</a></span>(String&nbsp;value)</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#stepSize--">stepSize</a></span>()</code>
<div class="block">Param for Step size to be used for each iteration of optimization (&amp;gt; 0).</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;<a href="../../../../../org/apache/spark/sql/Row.html" title="interface in org.apache.spark.sql">Row</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#transform-org.apache.spark.sql.Dataset-">transform</a></span>(<a href="../../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;?&gt;&nbsp;dataset)</code>
<div class="block">Transform a sentence column to a vector column to represent the whole sentence.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#transformSchema-org.apache.spark.sql.types.StructType-">transformSchema</a></span>(<a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a>&nbsp;schema)</code>
<div class="block">Check transform validity and derive the output schema from the input schema.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#uid--">uid</a></span>()</code>
<div class="block">An immutable unique ID for the object and its derivatives.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#vectorSize--">vectorSize</a></span>()</code>
<div class="block">The dimension of the code that you want to transform from words.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#windowSize--">windowSize</a></span>()</code>
<div class="block">The window size (context words from [-window, window]).</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/util/MLWriter.html" title="class in org.apache.spark.ml.util">MLWriter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html#write--">write</a></span>()</code>
<div class="block">Returns an <code>MLWriter</code> instance for this ML instance.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.Model">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/Model.html" title="class in org.apache.spark.ml">Model</a></h3>
<code><a href="../../../../../org/apache/spark/ml/Model.html#hasParent--">hasParent</a>, <a href="../../../../../org/apache/spark/ml/Model.html#parent--">parent</a>, <a href="../../../../../org/apache/spark/ml/Model.html#setParent-org.apache.spark.ml.Estimator-">setParent</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.Transformer">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/Transformer.html" title="class in org.apache.spark.ml">Transformer</a></h3>
<code><a href="../../../../../org/apache/spark/ml/Transformer.html#transform-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamMap-">transform</a>, <a href="../../../../../org/apache/spark/ml/Transformer.html#transform-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-org.apache.spark.ml.param.ParamPair...-">transform</a>, <a href="../../../../../org/apache/spark/ml/Transformer.html#transform-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-scala.collection.Seq-">transform</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.PipelineStage">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">PipelineStage</a></h3>
<code><a href="../../../../../org/apache/spark/ml/PipelineStage.html#params--">params</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.feature.Word2VecBase">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.ml.feature.<a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html" title="interface in org.apache.spark.ml.feature">Word2VecBase</a></h3>
<code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#getMaxSentenceLength--">getMaxSentenceLength</a>, <a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#getMinCount--">getMinCount</a>, <a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#getNumPartitions--">getNumPartitions</a>, <a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#getVectorSize--">getVectorSize</a>, <a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#getWindowSize--">getWindowSize</a>, <a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#validateAndTransformSchema-org.apache.spark.sql.types.StructType-">validateAndTransformSchema</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasInputCol">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasInputCol.html" title="interface in org.apache.spark.ml.param.shared">HasInputCol</a></h3>
<code><a href="../../../../../org/apache/spark/ml/param/shared/HasInputCol.html#getInputCol--">getInputCol</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasOutputCol">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasOutputCol.html" title="interface in org.apache.spark.ml.param.shared">HasOutputCol</a></h3>
<code><a href="../../../../../org/apache/spark/ml/param/shared/HasOutputCol.html#getOutputCol--">getOutputCol</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasMaxIter">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html" title="interface in org.apache.spark.ml.param.shared">HasMaxIter</a></h3>
<code><a href="../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html#getMaxIter--">getMaxIter</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasStepSize">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasStepSize.html" title="interface in org.apache.spark.ml.param.shared">HasStepSize</a></h3>
<code><a href="../../../../../org/apache/spark/ml/param/shared/HasStepSize.html#getStepSize--">getStepSize</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasSeed">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasSeed.html" title="interface in org.apache.spark.ml.param.shared">HasSeed</a></h3>
<code><a href="../../../../../org/apache/spark/ml/param/shared/HasSeed.html#getSeed--">getSeed</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.Params">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.ml.param.<a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></h3>
<code><a href="../../../../../org/apache/spark/ml/param/Params.html#clear-org.apache.spark.ml.param.Param-">clear</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#copyValues-T-org.apache.spark.ml.param.ParamMap-">copyValues</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#defaultCopy-org.apache.spark.ml.param.ParamMap-">defaultCopy</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#defaultParamMap--">defaultParamMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#explainParam-org.apache.spark.ml.param.Param-">explainParam</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#explainParams--">explainParams</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#extractParamMap--">extractParamMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#extractParamMap-org.apache.spark.ml.param.ParamMap-">extractParamMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#get-org.apache.spark.ml.param.Param-">get</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#getDefault-org.apache.spark.ml.param.Param-">getDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#getOrDefault-org.apache.spark.ml.param.Param-">getOrDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#getParam-java.lang.String-">getParam</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#hasDefault-org.apache.spark.ml.param.Param-">hasDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#hasParam-java.lang.String-">hasParam</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#isDefined-org.apache.spark.ml.param.Param-">isDefined</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#isSet-org.apache.spark.ml.param.Param-">isSet</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#onParamChange-org.apache.spark.ml.param.Param-">onParamChange</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#paramMap--">paramMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#params--">params</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.Param-T-">set</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.ParamPair-">set</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#set-java.lang.String-java.lang.Object-">set</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#setDefault-org.apache.spark.ml.param.Param-T-">setDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#setDefault-scala.collection.Seq-">setDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#shouldOwn-org.apache.spark.ml.param.Param-">shouldOwn</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.util.MLWritable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.ml.util.<a href="../../../../../org/apache/spark/ml/util/MLWritable.html" title="interface in org.apache.spark.ml.util">MLWritable</a></h3>
<code><a href="../../../../../org/apache/spark/ml/util/MLWritable.html#save-java.lang.String-">save</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.internal.Logging">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.internal.Logging</h3>
<code>$init$, initializeForcefully, initializeLogIfNecessary, initializeLogIfNecessary, initializeLogIfNecessary$default$2, initLock, isTraceEnabled, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning, org$apache$spark$internal$Logging$$log__$eq, org$apache$spark$internal$Logging$$log_, uninitialize</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="read--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/spark/ml/util/MLReader.html" title="class in org.apache.spark.ml.util">MLReader</a>&lt;<a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html" title="class in org.apache.spark.ml.feature">Word2VecModel</a>&gt;&nbsp;read()</pre>
</li>
</ul>
<a name="load-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>load</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html" title="class in org.apache.spark.ml.feature">Word2VecModel</a>&nbsp;load(String&nbsp;path)</pre>
</li>
</ul>
<a name="vectorSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>vectorSize</h4>
<pre>public final&nbsp;<a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a>&nbsp;vectorSize()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#vectorSize--">Word2VecBase</a></code></span></div>
<div class="block">The dimension of the code that you want to transform from words.
Default: 100</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#vectorSize--">vectorSize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html" title="interface in org.apache.spark.ml.feature">Word2VecBase</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="windowSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>windowSize</h4>
<pre>public final&nbsp;<a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a>&nbsp;windowSize()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#windowSize--">Word2VecBase</a></code></span></div>
<div class="block">The window size (context words from [-window, window]).
Default: 5</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#windowSize--">windowSize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html" title="interface in org.apache.spark.ml.feature">Word2VecBase</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="numPartitions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>numPartitions</h4>
<pre>public final&nbsp;<a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a>&nbsp;numPartitions()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#numPartitions--">Word2VecBase</a></code></span></div>
<div class="block">Number of partitions for sentences of words.
Default: 1</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#numPartitions--">numPartitions</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html" title="interface in org.apache.spark.ml.feature">Word2VecBase</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="minCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minCount</h4>
<pre>public final&nbsp;<a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a>&nbsp;minCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#minCount--">Word2VecBase</a></code></span></div>
<div class="block">The minimum number of times a token must appear to be included in the word2vec model's
vocabulary.
Default: 5</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#minCount--">minCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html" title="interface in org.apache.spark.ml.feature">Word2VecBase</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="maxSentenceLength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxSentenceLength</h4>
<pre>public final&nbsp;<a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a>&nbsp;maxSentenceLength()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#maxSentenceLength--">Word2VecBase</a></code></span></div>
<div class="block">Sets the maximum length (in words) of each sentence in the input data.
Any sentence longer than this threshold will be divided into chunks of
up to <code>maxSentenceLength</code> size.
Default: 1000</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html#maxSentenceLength--">maxSentenceLength</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html" title="interface in org.apache.spark.ml.feature">Word2VecBase</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="seed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>seed</h4>
<pre>public final&nbsp;<a href="../../../../../org/apache/spark/ml/param/LongParam.html" title="class in org.apache.spark.ml.param">LongParam</a>&nbsp;seed()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/param/shared/HasSeed.html#seed--">HasSeed</a></code></span></div>
<div class="block">Param for random seed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasSeed.html#seed--">seed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/param/shared/HasSeed.html" title="interface in org.apache.spark.ml.param.shared">HasSeed</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="stepSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stepSize</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a>&nbsp;stepSize()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/param/shared/HasStepSize.html#stepSize--">HasStepSize</a></code></span></div>
<div class="block">Param for Step size to be used for each iteration of optimization (&amp;gt; 0).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasStepSize.html#stepSize--">stepSize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/param/shared/HasStepSize.html" title="interface in org.apache.spark.ml.param.shared">HasStepSize</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="maxIter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxIter</h4>
<pre>public final&nbsp;<a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a>&nbsp;maxIter()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html#maxIter--">HasMaxIter</a></code></span></div>
<div class="block">Param for maximum number of iterations (&amp;gt;= 0).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html#maxIter--">maxIter</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html" title="interface in org.apache.spark.ml.param.shared">HasMaxIter</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="outputCol--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outputCol</h4>
<pre>public final&nbsp;<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;String&gt;&nbsp;outputCol()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/param/shared/HasOutputCol.html#outputCol--">HasOutputCol</a></code></span></div>
<div class="block">Param for output column name.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasOutputCol.html#outputCol--">outputCol</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/param/shared/HasOutputCol.html" title="interface in org.apache.spark.ml.param.shared">HasOutputCol</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="inputCol--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>inputCol</h4>
<pre>public final&nbsp;<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;String&gt;&nbsp;inputCol()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/param/shared/HasInputCol.html#inputCol--">HasInputCol</a></code></span></div>
<div class="block">Param for input column name.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasInputCol.html#inputCol--">inputCol</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/param/shared/HasInputCol.html" title="interface in org.apache.spark.ml.param.shared">HasInputCol</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="uid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uid</h4>
<pre>public&nbsp;String&nbsp;uid()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html#uid--">Identifiable</a></code></span></div>
<div class="block">An immutable unique ID for the object and its derivatives.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html#uid--">uid</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="getVectors--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVectors</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;<a href="../../../../../org/apache/spark/sql/Row.html" title="interface in org.apache.spark.sql">Row</a>&gt;&nbsp;getVectors()</pre>
</li>
</ul>
<a name="findSynonyms-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findSynonyms</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;<a href="../../../../../org/apache/spark/sql/Row.html" title="interface in org.apache.spark.sql">Row</a>&gt;&nbsp;findSynonyms(String&nbsp;word,
int&nbsp;num)</pre>
<div class="block">Find "num" number of words closest in similarity to the given word, not
including the word itself.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>word</code> - (undocumented)</dd>
<dd><code>num</code> - (undocumented)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a dataframe with columns "word" and "similarity" of the word and the cosine
similarities between the synonyms and the given word.</dd>
</dl>
</li>
</ul>
<a name="findSynonyms-org.apache.spark.ml.linalg.Vector-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findSynonyms</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;<a href="../../../../../org/apache/spark/sql/Row.html" title="interface in org.apache.spark.sql">Row</a>&gt;&nbsp;findSynonyms(<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a>&nbsp;vec,
int&nbsp;num)</pre>
<div class="block">Find "num" number of words whose vector representation is most similar to the supplied vector.
If the supplied vector is the vector representation of a word in the model's vocabulary,
that word will be in the results.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vec</code> - (undocumented)</dd>
<dd><code>num</code> - (undocumented)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a dataframe with columns "word" and "similarity" of the word and the cosine
similarities between the synonyms and the given word vector.</dd>
</dl>
</li>
</ul>
<a name="findSynonymsArray-org.apache.spark.ml.linalg.Vector-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findSynonymsArray</h4>
<pre>public&nbsp;scala.Tuple2&lt;String,Object&gt;[]&nbsp;findSynonymsArray(<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a>&nbsp;vec,
int&nbsp;num)</pre>
<div class="block">Find "num" number of words whose vector representation is most similar to the supplied vector.
If the supplied vector is the vector representation of a word in the model's vocabulary,
that word will be in the results.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vec</code> - (undocumented)</dd>
<dd><code>num</code> - (undocumented)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of the words and the cosine similarities between the synonyms given
word vector.</dd>
</dl>
</li>
</ul>
<a name="findSynonymsArray-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findSynonymsArray</h4>
<pre>public&nbsp;scala.Tuple2&lt;String,Object&gt;[]&nbsp;findSynonymsArray(String&nbsp;word,
int&nbsp;num)</pre>
<div class="block">Find "num" number of words closest in similarity to the given word, not
including the word itself.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>word</code> - (undocumented)</dd>
<dd><code>num</code> - (undocumented)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of the words and the cosine similarities between the synonyms given
word vector.</dd>
</dl>
</li>
</ul>
<a name="setInputCol-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInputCol</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html" title="class in org.apache.spark.ml.feature">Word2VecModel</a>&nbsp;setInputCol(String&nbsp;value)</pre>
</li>
</ul>
<a name="setOutputCol-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutputCol</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html" title="class in org.apache.spark.ml.feature">Word2VecModel</a>&nbsp;setOutputCol(String&nbsp;value)</pre>
</li>
</ul>
<a name="transform-org.apache.spark.sql.Dataset-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transform</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;<a href="../../../../../org/apache/spark/sql/Row.html" title="interface in org.apache.spark.sql">Row</a>&gt;&nbsp;transform(<a href="../../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;?&gt;&nbsp;dataset)</pre>
<div class="block">Transform a sentence column to a vector column to represent the whole sentence. The transform
is performed by averaging all word vectors it contains.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/Transformer.html#transform-org.apache.spark.sql.Dataset-">transform</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/spark/ml/Transformer.html" title="class in org.apache.spark.ml">Transformer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dataset</code> - (undocumented)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="transformSchema-org.apache.spark.sql.types.StructType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transformSchema</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a>&nbsp;transformSchema(<a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a>&nbsp;schema)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/spark/ml/PipelineStage.html#transformSchema-org.apache.spark.sql.types.StructType-">PipelineStage</a></code></span></div>
<div class="block">Check transform validity and derive the output schema from the input schema.
<p>
We check validity for interactions between parameters during <code>transformSchema</code> and
raise an exception if any parameter value is invalid. Parameter value checks which
do not depend on other parameters are handled by <code>Param.validate()</code>.
<p>
Typical implementation should first conduct verification on schema change and parameter
validity, including complex parameter interaction checks.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/PipelineStage.html#transformSchema-org.apache.spark.sql.types.StructType-">transformSchema</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">PipelineStage</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schema</code> - (undocumented)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="copy-org.apache.spark.ml.param.ParamMap-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html" title="class in org.apache.spark.ml.feature">Word2VecModel</a>&nbsp;copy(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extra)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/param/Params.html#copy-org.apache.spark.ml.param.ParamMap-">Params</a></code></span></div>
<div class="block">Creates a copy of this instance with the same UID and some extra params.
Subclasses should implement this method and set the return type properly.
See <code>defaultCopy()</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/param/Params.html#copy-org.apache.spark.ml.param.ParamMap-">copy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/Model.html#copy-org.apache.spark.ml.param.ParamMap-">copy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/spark/ml/Model.html" title="class in org.apache.spark.ml">Model</a>&lt;<a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html" title="class in org.apache.spark.ml.feature">Word2VecModel</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extra</code> - (undocumented)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="write--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/ml/util/MLWriter.html" title="class in org.apache.spark.ml.util">MLWriter</a>&nbsp;write()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/util/MLWritable.html#write--">MLWritable</a></code></span></div>
<div class="block">Returns an <code>MLWriter</code> instance for this ML instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/util/MLWritable.html#write--">write</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/util/MLWritable.html" title="interface in org.apache.spark.ml.util">MLWritable</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html#toString--">toString</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/spark/ml/feature/Word2VecBase.html" title="interface in org.apache.spark.ml.feature"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.Data$.html" title="class in org.apache.spark.ml.feature"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/ml/feature/Word2VecModel.html" target="_top">Frames</a></li>
<li><a href="Word2VecModel.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script></body>
</html>