blob: 1ae8ba202ec38953b1fd0a16744456f7c9d8edd3 [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_121) on Fri Apr 14 22:11:35 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CanopyDriver (Mahout Map-Reduce 0.13.0 API)</title>
<meta name="date" content="2017-04-14">
<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="CanopyDriver (Mahout Map-Reduce 0.13.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":41,"i1":41,"i2":41,"i3":41,"i4":41,"i5":41,"i6":42};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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="class-use/CanopyDriver.html">Use</a></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/mahout/clustering/canopy/CanopyConfigKeys.html" title="class in org.apache.mahout.clustering.canopy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/mahout/clustering/canopy/CanopyReducer.html" title="class in org.apache.mahout.clustering.canopy"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mahout/clustering/canopy/CanopyDriver.html" target="_top">Frames</a></li>
<li><a href="CanopyDriver.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.mahout.clustering.canopy</div>
<h2 title="Class CanopyDriver" class="title">Class CanopyDriver</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.conf.Configured</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/mahout/common/AbstractJob.html" title="class in org.apache.mahout.common">org.apache.mahout.common.AbstractJob</a></li>
<li>
<ul class="inheritance">
<li>org.apache.mahout.clustering.canopy.CanopyDriver</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool</dd>
</dl>
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<br>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public class <span class="typeNameLabel">CanopyDriver</span>
extends <a href="../../../../../org/apache/mahout/common/AbstractJob.html" title="class in org.apache.mahout.common">AbstractJob</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/canopy/CanopyDriver.html#DEFAULT_CLUSTERED_POINTS_DIRECTORY">DEFAULT_CLUSTERED_POINTS_DIRECTORY</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.mahout.common.AbstractJob">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.mahout.common.<a href="../../../../../org/apache/mahout/common/AbstractJob.html" title="class in org.apache.mahout.common">AbstractJob</a></h3>
<code><a href="../../../../../org/apache/mahout/common/AbstractJob.html#argMap">argMap</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#inputFile">inputFile</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#inputPath">inputPath</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#outputFile">outputFile</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#outputPath">outputPath</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#tempPath">tempPath</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/canopy/CanopyDriver.html#CanopyDriver--">CanopyDriver</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>static org.apache.hadoop.fs.Path</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/canopy/CanopyDriver.html#buildClusters-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.mahout.common.distance.DistanceMeasure-double-double-double-double-int-boolean-">buildClusters</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
org.apache.hadoop.fs.Path&nbsp;input,
org.apache.hadoop.fs.Path&nbsp;output,
<a href="../../../../../org/apache/mahout/common/distance/DistanceMeasure.html" title="interface in org.apache.mahout.common.distance">DistanceMeasure</a>&nbsp;measure,
double&nbsp;t1,
double&nbsp;t2,
double&nbsp;t3,
double&nbsp;t4,
int&nbsp;clusterFilter,
boolean&nbsp;runSequential)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Build a directory of Canopy clusters from the input vectors and other
arguments.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/canopy/CanopyDriver.html#buildClusters-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.mahout.common.distance.DistanceMeasure-double-double-int-boolean-">buildClusters</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
org.apache.hadoop.fs.Path&nbsp;input,
org.apache.hadoop.fs.Path&nbsp;output,
<a href="../../../../../org/apache/mahout/common/distance/DistanceMeasure.html" title="interface in org.apache.mahout.common.distance">DistanceMeasure</a>&nbsp;measure,
double&nbsp;t1,
double&nbsp;t2,
int&nbsp;clusterFilter,
boolean&nbsp;runSequential)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Convenience method for backwards compatibility</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/canopy/CanopyDriver.html#main-java.lang.String:A-">main</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/canopy/CanopyDriver.html#run-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.mahout.common.distance.DistanceMeasure-double-double-boolean-double-boolean-">run</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
org.apache.hadoop.fs.Path&nbsp;input,
org.apache.hadoop.fs.Path&nbsp;output,
<a href="../../../../../org/apache/mahout/common/distance/DistanceMeasure.html" title="interface in org.apache.mahout.common.distance">DistanceMeasure</a>&nbsp;measure,
double&nbsp;t1,
double&nbsp;t2,
boolean&nbsp;runClustering,
double&nbsp;clusterClassificationThreshold,
boolean&nbsp;runSequential)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Convenience method to provide backward compatibility</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/canopy/CanopyDriver.html#run-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.mahout.common.distance.DistanceMeasure-double-double-double-double-int-boolean-double-boolean-">run</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
org.apache.hadoop.fs.Path&nbsp;input,
org.apache.hadoop.fs.Path&nbsp;output,
<a href="../../../../../org/apache/mahout/common/distance/DistanceMeasure.html" title="interface in org.apache.mahout.common.distance">DistanceMeasure</a>&nbsp;measure,
double&nbsp;t1,
double&nbsp;t2,
double&nbsp;t3,
double&nbsp;t4,
int&nbsp;clusterFilter,
boolean&nbsp;runClustering,
double&nbsp;clusterClassificationThreshold,
boolean&nbsp;runSequential)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Build a directory of Canopy clusters from the input arguments and, if
requested, cluster the input vectors using these clusters</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/canopy/CanopyDriver.html#run-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.mahout.common.distance.DistanceMeasure-double-double-boolean-double-boolean-">run</a></span>(org.apache.hadoop.fs.Path&nbsp;input,
org.apache.hadoop.fs.Path&nbsp;output,
<a href="../../../../../org/apache/mahout/common/distance/DistanceMeasure.html" title="interface in org.apache.mahout.common.distance">DistanceMeasure</a>&nbsp;measure,
double&nbsp;t1,
double&nbsp;t2,
boolean&nbsp;runClustering,
double&nbsp;clusterClassificationThreshold,
boolean&nbsp;runSequential)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Convenience method creates new Configuration() Build a directory of Canopy
clusters from the input arguments and, if requested, cluster the input
vectors using these clusters</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/canopy/CanopyDriver.html#run-java.lang.String:A-">run</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.mahout.common.AbstractJob">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.mahout.common.<a href="../../../../../org/apache/mahout/common/AbstractJob.html" title="class in org.apache.mahout.common">AbstractJob</a></h3>
<code><a href="../../../../../org/apache/mahout/common/AbstractJob.html#addFlag-java.lang.String-java.lang.String-java.lang.String-">addFlag</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#addInputOption--">addInputOption</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#addOption-org.apache.commons.cli2.Option-">addOption</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#addOption-java.lang.String-java.lang.String-java.lang.String-">addOption</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#addOption-java.lang.String-java.lang.String-java.lang.String-boolean-">addOption</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#addOption-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">addOption</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#addOutputOption--">addOutputOption</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#buildOption-java.lang.String-java.lang.String-java.lang.String-boolean-boolean-java.lang.String-">buildOption</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#buildOption-java.lang.String-java.lang.String-java.lang.String-boolean-int-int-boolean-java.lang.String-">buildOption</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getAnalyzerClassFromOption--">getAnalyzerClassFromOption</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getCLIOption-java.lang.String-">getCLIOption</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getConf--">getConf</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getDimensions-org.apache.hadoop.fs.Path-">getDimensions</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getFloat-java.lang.String-">getFloat</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getFloat-java.lang.String-float-">getFloat</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getGroup--">getGroup</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getInputFile--">getInputFile</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getInputPath--">getInputPath</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getInt-java.lang.String-">getInt</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getInt-java.lang.String-int-">getInt</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getOption-java.util.Map-java.lang.String-">getOption</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getOption-java.lang.String-">getOption</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getOption-java.lang.String-java.lang.String-">getOption</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getOptions-java.lang.String-">getOptions</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getOutputFile--">getOutputFile</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getOutputPath--">getOutputPath</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getOutputPath-java.lang.String-">getOutputPath</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getTempPath--">getTempPath</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#getTempPath-java.lang.String-">getTempPath</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#hasOption-java.lang.String-">hasOption</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#keyFor-java.lang.String-">keyFor</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#maybePut-java.util.Map-org.apache.commons.cli2.CommandLine-org.apache.commons.cli2.Option...-">maybePut</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#parseArguments-java.lang.String:A-">parseArguments</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#parseArguments-java.lang.String:A-boolean-boolean-">parseArguments</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#parseDirectories-org.apache.commons.cli2.CommandLine-boolean-boolean-">parseDirectories</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#prepareJob-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-java.lang.Class-java.lang.Class-java.lang.Class-java.lang.Class-java.lang.Class-">prepareJob</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#prepareJob-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-java.lang.Class-java.lang.Class-java.lang.Class-java.lang.Class-java.lang.Class-java.lang.String-">prepareJob</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#prepareJob-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-java.lang.Class-java.lang.Class-java.lang.Class-java.lang.Class-java.lang.Class-java.lang.Class-java.lang.Class-java.lang.Class-">prepareJob</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#prepareJob-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-java.lang.Class-java.lang.Class-java.lang.Class-java.lang.Class-java.lang.Class-java.lang.Class-">prepareJob</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#setConf-org.apache.hadoop.conf.Configuration-">setConf</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#setS3SafeCombinedInputPath-org.apache.hadoop.mapreduce.Job-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-">setS3SafeCombinedInputPath</a>, <a href="../../../../../org/apache/mahout/common/AbstractJob.html#shouldRunNextPhase-java.util.Map-java.util.concurrent.atomic.AtomicInteger-">shouldRunNextPhase</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_CLUSTERED_POINTS_DIRECTORY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_CLUSTERED_POINTS_DIRECTORY</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_CLUSTERED_POINTS_DIRECTORY</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.mahout.clustering.canopy.CanopyDriver.DEFAULT_CLUSTERED_POINTS_DIRECTORY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CanopyDriver--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CanopyDriver</h4>
<pre>public&nbsp;CanopyDriver()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="main-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;main(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="run-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;int&nbsp;run(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="run-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.mahout.common.distance.DistanceMeasure-double-double-double-double-int-boolean-double-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public static&nbsp;void&nbsp;run(org.apache.hadoop.conf.Configuration&nbsp;conf,
org.apache.hadoop.fs.Path&nbsp;input,
org.apache.hadoop.fs.Path&nbsp;output,
<a href="../../../../../org/apache/mahout/common/distance/DistanceMeasure.html" title="interface in org.apache.mahout.common.distance">DistanceMeasure</a>&nbsp;measure,
double&nbsp;t1,
double&nbsp;t2,
double&nbsp;t3,
double&nbsp;t4,
int&nbsp;clusterFilter,
boolean&nbsp;runClustering,
double&nbsp;clusterClassificationThreshold,
boolean&nbsp;runSequential)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a>,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Build a directory of Canopy clusters from the input arguments and, if
requested, cluster the input vectors using these clusters</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - the Configuration</dd>
<dd><code>input</code> - the Path to the directory containing input vectors</dd>
<dd><code>output</code> - the Path for all output directories</dd>
<dd><code>measure</code> - the DistanceMeasure</dd>
<dd><code>t1</code> - the double T1 distance metric</dd>
<dd><code>t2</code> - the double T2 distance metric</dd>
<dd><code>t3</code> - the reducer's double T1 distance metric</dd>
<dd><code>t4</code> - the reducer's double T2 distance metric</dd>
<dd><code>clusterFilter</code> - the minimum canopy size output by the mappers</dd>
<dd><code>runClustering</code> - cluster the input vectors if true</dd>
<dd><code>clusterClassificationThreshold</code> - vectors having pdf below this value will not be clustered. Its value should be between 0 and 1.</dd>
<dd><code>runSequential</code> - execute sequentially if true</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></code></dd>
</dl>
</li>
</ul>
<a name="run-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.mahout.common.distance.DistanceMeasure-double-double-boolean-double-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public static&nbsp;void&nbsp;run(org.apache.hadoop.conf.Configuration&nbsp;conf,
org.apache.hadoop.fs.Path&nbsp;input,
org.apache.hadoop.fs.Path&nbsp;output,
<a href="../../../../../org/apache/mahout/common/distance/DistanceMeasure.html" title="interface in org.apache.mahout.common.distance">DistanceMeasure</a>&nbsp;measure,
double&nbsp;t1,
double&nbsp;t2,
boolean&nbsp;runClustering,
double&nbsp;clusterClassificationThreshold,
boolean&nbsp;runSequential)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a>,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Convenience method to provide backward compatibility</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></code></dd>
</dl>
</li>
</ul>
<a name="run-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.mahout.common.distance.DistanceMeasure-double-double-boolean-double-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public static&nbsp;void&nbsp;run(org.apache.hadoop.fs.Path&nbsp;input,
org.apache.hadoop.fs.Path&nbsp;output,
<a href="../../../../../org/apache/mahout/common/distance/DistanceMeasure.html" title="interface in org.apache.mahout.common.distance">DistanceMeasure</a>&nbsp;measure,
double&nbsp;t1,
double&nbsp;t2,
boolean&nbsp;runClustering,
double&nbsp;clusterClassificationThreshold,
boolean&nbsp;runSequential)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a>,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Convenience method creates new Configuration() Build a directory of Canopy
clusters from the input arguments and, if requested, cluster the input
vectors using these clusters</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - the Path to the directory containing input vectors</dd>
<dd><code>output</code> - the Path for all output directories</dd>
<dd><code>t1</code> - the double T1 distance metric</dd>
<dd><code>t2</code> - the double T2 distance metric</dd>
<dd><code>runClustering</code> - cluster the input vectors if true</dd>
<dd><code>clusterClassificationThreshold</code> - vectors having pdf below this value will not be clustered. Its value should be between 0 and 1.</dd>
<dd><code>runSequential</code> - execute sequentially if true</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></code></dd>
</dl>
</li>
</ul>
<a name="buildClusters-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.mahout.common.distance.DistanceMeasure-double-double-int-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildClusters</h4>
<pre>public static&nbsp;org.apache.hadoop.fs.Path&nbsp;buildClusters(org.apache.hadoop.conf.Configuration&nbsp;conf,
org.apache.hadoop.fs.Path&nbsp;input,
org.apache.hadoop.fs.Path&nbsp;output,
<a href="../../../../../org/apache/mahout/common/distance/DistanceMeasure.html" title="interface in org.apache.mahout.common.distance">DistanceMeasure</a>&nbsp;measure,
double&nbsp;t1,
double&nbsp;t2,
int&nbsp;clusterFilter,
boolean&nbsp;runSequential)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a>,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Convenience method for backwards compatibility</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></code></dd>
</dl>
</li>
</ul>
<a name="buildClusters-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.mahout.common.distance.DistanceMeasure-double-double-double-double-int-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>buildClusters</h4>
<pre>public static&nbsp;org.apache.hadoop.fs.Path&nbsp;buildClusters(org.apache.hadoop.conf.Configuration&nbsp;conf,
org.apache.hadoop.fs.Path&nbsp;input,
org.apache.hadoop.fs.Path&nbsp;output,
<a href="../../../../../org/apache/mahout/common/distance/DistanceMeasure.html" title="interface in org.apache.mahout.common.distance">DistanceMeasure</a>&nbsp;measure,
double&nbsp;t1,
double&nbsp;t2,
double&nbsp;t3,
double&nbsp;t4,
int&nbsp;clusterFilter,
boolean&nbsp;runSequential)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a>,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Build a directory of Canopy clusters from the input vectors and other
arguments. Run sequential or mapreduce execution as requested</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - the Configuration to use</dd>
<dd><code>input</code> - the Path to the directory containing input vectors</dd>
<dd><code>output</code> - the Path for all output directories</dd>
<dd><code>measure</code> - the DistanceMeasure</dd>
<dd><code>t1</code> - the double T1 distance metric</dd>
<dd><code>t2</code> - the double T2 distance metric</dd>
<dd><code>t3</code> - the reducer's double T1 distance metric</dd>
<dd><code>t4</code> - the reducer's double T2 distance metric</dd>
<dd><code>clusterFilter</code> - the int minimum size of canopies produced</dd>
<dd><code>runSequential</code> - a boolean indicates to run the sequential (reference) algorithm</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the canopy output directory Path</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></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="class-use/CanopyDriver.html">Use</a></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/mahout/clustering/canopy/CanopyConfigKeys.html" title="class in org.apache.mahout.clustering.canopy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/mahout/clustering/canopy/CanopyReducer.html" title="class in org.apache.mahout.clustering.canopy"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mahout/clustering/canopy/CanopyDriver.html" target="_top">Frames</a></li>
<li><a href="CanopyDriver.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>