blob: f6b9e1d0d3c668fd5d630519fa3737d3538720dc [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.9.1) on Fri Sep 09 19:30:40 KST 2022 -->
<title>org.apache.nemo.compiler.optimizer.pass.compiletime.annotating (Nemo Project 0.4 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-09-09">
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.nemo.compiler.optimizer.pass.compiletime.annotating (Nemo Project 0.4 API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.nemo.compiler.optimizer.pass.compiletime.annotating</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AggressiveSpeculativeCloningPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">AggressiveSpeculativeCloningPass</a></th>
<td class="colLast">
<div class="block">Speculative execution.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AnnotatingPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">AnnotatingPass</a></th>
<td class="colLast">
<div class="block">A compile-time pass that annotates the IR DAG with execution properties.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CompressionPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">CompressionPass</a></th>
<td class="colLast">
<div class="block">A pass for applying compression algorithm for data flowing between vertices.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultDataPersistencePass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">DefaultDataPersistencePass</a></th>
<td class="colLast">
<div class="block">Pass for initiating IREdge data persistence ExecutionProperty with default values.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultDataStorePass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">DefaultDataStorePass</a></th>
<td class="colLast">
<div class="block">Edge data store pass to process inter-stage memory store edges.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultEdgeDecoderPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">DefaultEdgeDecoderPass</a></th>
<td class="colLast">
<div class="block">Pass for initiating IREdge Decoder ExecutionProperty with default dummy coder.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultEdgeEncoderPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">DefaultEdgeEncoderPass</a></th>
<td class="colLast">
<div class="block">Pass for initiating IREdge Encoder ExecutionProperty with default dummy coder.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultParallelismPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">DefaultParallelismPass</a></th>
<td class="colLast">
<div class="block">Optimization pass for tagging parallelism execution property.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultScheduleGroupPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">DefaultScheduleGroupPass</a></th>
<td class="colLast">
<div class="block">A pass for assigning each stages in schedule groups.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DisaggregationEdgeDataStorePass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">DisaggregationEdgeDataStorePass</a></th>
<td class="colLast">
<div class="block">A pass to support Disaggregated Resources by tagging edges.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DuplicateEdgeGroupSizePass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">DuplicateEdgeGroupSizePass</a></th>
<td class="colLast">
<div class="block">A pass for annotate duplicate data for each edge.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LambdaPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">LambdaPass</a></th>
<td class="colLast">
<div class="block">Lambda Pass.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LargeShuffleAnnotatingPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">LargeShuffleAnnotatingPass</a></th>
<td class="colLast">
<div class="block">This pass assumes that a RelayVertex was previously inserted to receive each shuffle edge.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PipeTransferForAllEdgesPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">PipeTransferForAllEdgesPass</a></th>
<td class="colLast">
<div class="block">Annotate 'Pipe' on all edges.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ResourceLocalityPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">ResourceLocalityPass</a></th>
<td class="colLast">
<div class="block">Sets <a href="../../../../../common/ir/vertex/executionproperty/ResourceLocalityProperty.html" title="class in org.apache.nemo.common.ir.vertex.executionproperty"><code>ResourceLocalityProperty</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ResourceSitePass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">ResourceSitePass</a></th>
<td class="colLast">
<div class="block">Computes and assigns appropriate share of nodes to each irVertex to minimize shuffle time,
with respect to bandwidth restrictions of nodes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ResourceSlotPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">ResourceSlotPass</a></th>
<td class="colLast">
<div class="block">Sets <a href="../../../../../common/ir/vertex/executionproperty/ResourceSlotProperty.html" title="class in org.apache.nemo.common.ir.vertex.executionproperty"><code>ResourceSlotProperty</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ShuffleEdgePushPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">ShuffleEdgePushPass</a></th>
<td class="colLast">
<div class="block">A pass for tagging shuffle edges different from the default ones.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SkewAnnotatingPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">SkewAnnotatingPass</a></th>
<td class="colLast">
<div class="block">For each shuffle edge, set the number of partitions to (dstParallelism * HASH_RANGE_MULTIPLIER).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TransientResourceDataTransferPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">TransientResourceDataTransferPass</a></th>
<td class="colLast">
<div class="block">Optimizes IREdges between transient resources and reserved resources.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TransientResourcePriorityPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">TransientResourcePriorityPass</a></th>
<td class="colLast">
<div class="block">Place valuable computations on reserved resources, and the rest on transient resources.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="UpfrontCloningPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">UpfrontCloningPass</a></th>
<td class="colLast">
<div class="block">Set the ClonedScheduling property of source vertices, in an upfront manner.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="XGBoostPass.html" title="class in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">XGBoostPass</a></th>
<td class="colLast">
<div class="block">Pass for applying XGBoost optimizations.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Annotates.html" title="annotation in org.apache.nemo.compiler.optimizer.pass.compiletime.annotating">Annotates</a></th>
<td class="colLast">
<div class="block">Annotation used to indicate which execution properties the class annotates.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>