summaryrefslogblamecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/mllib/util/Saveable.html
blob: 90e540879177fabd12e2985fa76fa25cad9a68dd (plain) (tree)
1
2
3
4
5
6
7



                                                                                                      
                                                                                
                       
                                       





























                                                                                               
                                                                                                                                                                  
































































































































































                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               
                                                                                                                                                                  









































                                                                                                                                                                                               
<!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 (version 1.7.0_51) on Wed Sep 16 10:26:35 PDT 2015 -->
<title>Saveable</title>
<meta name="date" content="2015-09-16">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="Saveable";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/mllib/util/MLUtils.html" title="class in org.apache.spark.mllib.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/mllib/util/SVMDataGenerator.html" title="class in org.apache.spark.mllib.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/mllib/util/Saveable.html" target="_top">Frames</a></li>
<li><a href="Saveable.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All 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>Nested&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.mllib.util</div>
<h2 title="Interface Saveable" class="title">Interface Saveable</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/spark/mllib/tree/model/DecisionTreeModel.html" title="class in org.apache.spark.mllib.tree.model">DecisionTreeModel</a>, <a href="../../../../../org/apache/spark/mllib/clustering/DistributedLDAModel.html" title="class in org.apache.spark.mllib.clustering">DistributedLDAModel</a>, <a href="../../../../../org/apache/spark/mllib/clustering/GaussianMixtureModel.html" title="class in org.apache.spark.mllib.clustering">GaussianMixtureModel</a>, <a href="../../../../../org/apache/spark/mllib/tree/model/GradientBoostedTreesModel.html" title="class in org.apache.spark.mllib.tree.model">GradientBoostedTreesModel</a>, <a href="../../../../../org/apache/spark/mllib/regression/IsotonicRegressionModel.html" title="class in org.apache.spark.mllib.regression">IsotonicRegressionModel</a>, <a href="../../../../../org/apache/spark/mllib/clustering/KMeansModel.html" title="class in org.apache.spark.mllib.clustering">KMeansModel</a>, <a href="../../../../../org/apache/spark/mllib/regression/LassoModel.html" title="class in org.apache.spark.mllib.regression">LassoModel</a>, <a href="../../../../../org/apache/spark/mllib/clustering/LDAModel.html" title="class in org.apache.spark.mllib.clustering">LDAModel</a>, <a href="../../../../../org/apache/spark/mllib/regression/LinearRegressionModel.html" title="class in org.apache.spark.mllib.regression">LinearRegressionModel</a>, <a href="../../../../../org/apache/spark/mllib/clustering/LocalLDAModel.html" title="class in org.apache.spark.mllib.clustering">LocalLDAModel</a>, <a href="../../../../../org/apache/spark/mllib/classification/LogisticRegressionModel.html" title="class in org.apache.spark.mllib.classification">LogisticRegressionModel</a>, <a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html" title="class in org.apache.spark.mllib.recommendation">MatrixFactorizationModel</a>, <a href="../../../../../org/apache/spark/mllib/classification/NaiveBayesModel.html" title="class in org.apache.spark.mllib.classification">NaiveBayesModel</a>, <a href="../../../../../org/apache/spark/mllib/clustering/PowerIterationClusteringModel.html" title="class in org.apache.spark.mllib.clustering">PowerIterationClusteringModel</a>, <a href="../../../../../org/apache/spark/mllib/tree/model/RandomForestModel.html" title="class in org.apache.spark.mllib.tree.model">RandomForestModel</a>, <a href="../../../../../org/apache/spark/mllib/regression/RidgeRegressionModel.html" title="class in org.apache.spark.mllib.regression">RidgeRegressionModel</a>, <a href="../../../../../org/apache/spark/mllib/clustering/StreamingKMeansModel.html" title="class in org.apache.spark.mllib.clustering">StreamingKMeansModel</a>, <a href="../../../../../org/apache/spark/mllib/classification/SVMModel.html" title="class in org.apache.spark.mllib.classification">SVMModel</a>, <a href="../../../../../org/apache/spark/mllib/feature/Word2VecModel.html" title="class in org.apache.spark.mllib.feature">Word2VecModel</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Saveable</span></pre>
<div class="block">:: DeveloperApi ::
 <p>
 Trait for models and transformers which may be saved as files.
 This should be inherited by the class which implements model instances.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/util/Saveable.html#formatVersion()">formatVersion</a></strong>()</code>
<div class="block">Current version of model save/load format.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/util/Saveable.html#save(org.apache.spark.SparkContext, java.lang.String)">save</a></strong>(<a href="../../../../../org/apache/spark/SparkContext.html" title="class in org.apache.spark">SparkContext</a>&nbsp;sc,
    java.lang.String&nbsp;path)</code>
<div class="block">Save this model to the given path.</div>
</td>
</tr>
</table>
</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="save(org.apache.spark.SparkContext, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>save</h4>
<pre>void&nbsp;save(<a href="../../../../../org/apache/spark/SparkContext.html" title="class in org.apache.spark">SparkContext</a>&nbsp;sc,
        java.lang.String&nbsp;path)</pre>
<div class="block">Save this model to the given path.
 <p>
 This saves:
  - human-readable (JSON) model metadata to path/metadata/
  - Parquet formatted data to path/data/
 <p>
 The model may be loaded using <code>Loader.load</code>.
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sc</code> - Spark context used to save model data.</dd><dd><code>path</code> - Path specifying the directory in which to save this model.
              If the directory already exists, this method throws an exception.</dd></dl>
</li>
</ul>
<a name="formatVersion()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>formatVersion</h4>
<pre>java.lang.String&nbsp;formatVersion()</pre>
<div class="block">Current version of model save/load format.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/mllib/util/MLUtils.html" title="class in org.apache.spark.mllib.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/mllib/util/SVMDataGenerator.html" title="class in org.apache.spark.mllib.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/mllib/util/Saveable.html" target="_top">Frames</a></li>
<li><a href="Saveable.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All 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>Nested&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>