Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-server / hadoop-yarn-server-nodemanager / apidocs / org / apache / hadoop / yarn / server / nodemanager / containermanager / resourceplugin / com / nec / NECVEPlugin.html
blob: 122eccf2e58ebfc985fb6fcedf6fd37ac39b177b [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_292) on Tue Jun 15 06:11:22 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NECVEPlugin (Apache Hadoop YARN NodeManager 3.3.1 API)</title>
<meta name="date" content="2021-06-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="NECVEPlugin (Apache Hadoop YARN NodeManager 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All 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="class-use/NECVEPlugin.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>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../../index.html?org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/com/nec/NECVEPlugin.html" target="_top">Frames</a></li>
<li><a href="NECVEPlugin.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.yarn.server.nodemanager.containermanager.resourceplugin.com.nec</div>
<h2 title="Class NECVEPlugin" class="title">Class NECVEPlugin</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/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.yarn.server.nodemanager.containermanager.resourceplugin.com.nec.NECVEPlugin</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePlugin.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">DevicePlugin</a>, <a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePluginScheduler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">DevicePluginScheduler</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">NECVEPlugin</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePlugin.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">DevicePlugin</a>, <a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePluginScheduler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">DevicePluginScheduler</a></pre>
<div class="block">A device framework plugin which supports NEC Vector Engine.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/com/nec/NECVEPlugin.html#NECVEPlugin--">NECVEPlugin</a></span>()</code>&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="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="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/Device.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">Device</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/com/nec/NECVEPlugin.html#allocateDevices-java.util.Set-int-java.util.Map-">allocateDevices</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/Device.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">Device</a>&gt;&nbsp;availableDevices,
int&nbsp;count,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;env)</code>
<div class="block">Called when allocating devices.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/Device.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">Device</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/com/nec/NECVEPlugin.html#getDevices--">getDevices</a></span>()</code>
<div class="block">Called when update node resource.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DeviceRegisterRequest.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">DeviceRegisterRequest</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/com/nec/NECVEPlugin.html#getRegisterRequestInfo--">getRegisterRequestInfo</a></span>()</code>
<div class="block">Called first when device plugin framework wants to register.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DeviceRuntimeSpec.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">DeviceRuntimeSpec</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/com/nec/NECVEPlugin.html#onDevicesAllocated-java.util.Set-org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin.YarnRuntimeType-">onDevicesAllocated</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/Device.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">Device</a>&gt;&nbsp;set,
<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/YarnRuntimeType.html" title="enum in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">YarnRuntimeType</a>&nbsp;yarnRuntimeType)</code>
<div class="block">Asking how these devices should be prepared/used
before/when container launch.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/com/nec/NECVEPlugin.html#onDevicesReleased-java.util.Set-">onDevicesReleased</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/Device.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">Device</a>&gt;&nbsp;releasedDevices)</code>
<div class="block">Called after device released.</div>
</td>
</tr>
</table>
<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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="NECVEPlugin--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NECVEPlugin</h4>
<pre>public&nbsp;NECVEPlugin()
throws <a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandlerException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandlerException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandlerException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandlerException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getRegisterRequestInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRegisterRequestInfo</h4>
<pre>public&nbsp;<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DeviceRegisterRequest.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">DeviceRegisterRequest</a>&nbsp;getRegisterRequestInfo()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePlugin.html#getRegisterRequestInfo--">DevicePlugin</a></code></span></div>
<div class="block">Called first when device plugin framework wants to register.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePlugin.html#getRegisterRequestInfo--">getRegisterRequestInfo</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePlugin.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">DevicePlugin</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>DeviceRegisterRequest <a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DeviceRegisterRequest.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin"><code>DeviceRegisterRequest</code></a></dd>
</dl>
</li>
</ul>
<a name="getDevices--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDevices</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/Device.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">Device</a>&gt;&nbsp;getDevices()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePlugin.html#getDevices--">DevicePlugin</a></code></span></div>
<div class="block">Called when update node resource.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePlugin.html#getDevices--">getDevices</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePlugin.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">DevicePlugin</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a set of <a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/Device.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin"><code>Device</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TreeSet.html?is-external=true" title="class or interface in java.util"><code>TreeSet</code></a> recommended</dd>
</dl>
</li>
</ul>
<a name="onDevicesAllocated-java.util.Set-org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin.YarnRuntimeType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onDevicesAllocated</h4>
<pre>public&nbsp;<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DeviceRuntimeSpec.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">DeviceRuntimeSpec</a>&nbsp;onDevicesAllocated(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/Device.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">Device</a>&gt;&nbsp;set,
<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/YarnRuntimeType.html" title="enum in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">YarnRuntimeType</a>&nbsp;yarnRuntimeType)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePlugin.html#onDevicesAllocated-java.util.Set-org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin.YarnRuntimeType-">DevicePlugin</a></code></span></div>
<div class="block">Asking how these devices should be prepared/used
before/when container launch. A plugin can do some tasks in its own or
define it in DeviceRuntimeSpec to let the framework do it.
For instance, define <code>VolumeSpec</code> to let the
framework to create volume before running container.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePlugin.html#onDevicesAllocated-java.util.Set-org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin.YarnRuntimeType-">onDevicesAllocated</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePlugin.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">DevicePlugin</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>set</code> - A set of allocated <a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/Device.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin"><code>Device</code></a>.</dd>
<dd><code>yarnRuntimeType</code> - Indicate which runtime YARN will use
Could be <code>RUNTIME_DEFAULT</code> or <code>RUNTIME_DOCKER</code>
in <a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DeviceRuntimeSpec.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin"><code>DeviceRuntimeSpec</code></a> constants. The default means YARN's
non-docker container runtime is used. The docker means YARN's
docker container runtime is used.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DeviceRuntimeSpec.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin"><code>DeviceRuntimeSpec</code></a> description about environment,
<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/VolumeSpec.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin"><code>VolumeSpec</code></a>, <a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/MountVolumeSpec.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin"><code>MountVolumeSpec</code></a>. etc</dd>
</dl>
</li>
</ul>
<a name="onDevicesReleased-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onDevicesReleased</h4>
<pre>public&nbsp;void&nbsp;onDevicesReleased(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/Device.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">Device</a>&gt;&nbsp;releasedDevices)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePlugin.html#onDevicesReleased-java.util.Set-">DevicePlugin</a></code></span></div>
<div class="block">Called after device released.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePlugin.html#onDevicesReleased-java.util.Set-">onDevicesReleased</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePlugin.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">DevicePlugin</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>releasedDevices</code> - A set of released devices</dd>
</dl>
</li>
</ul>
<a name="allocateDevices-java.util.Set-int-java.util.Map-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>allocateDevices</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/Device.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">Device</a>&gt;&nbsp;allocateDevices(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/Device.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">Device</a>&gt;&nbsp;availableDevices,
int&nbsp;count,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;env)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePluginScheduler.html#allocateDevices-java.util.Set-int-java.util.Map-">DevicePluginScheduler</a></code></span></div>
<div class="block">Called when allocating devices. The framework will do all device book
keeping and fail recovery. So this hook could be stateless and only do
scheduling based on available devices passed in. It could be
invoked multiple times by the framework. The hint in environment variables
passed in could be potentially used in making better scheduling decision.
For instance, GPU scheduling might support different kind of policy. The
container can set it through environment variables.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePluginScheduler.html#allocateDevices-java.util.Set-int-java.util.Map-">allocateDevices</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/DevicePluginScheduler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin">DevicePluginScheduler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>availableDevices</code> - Devices allowed to be chosen from.</dd>
<dd><code>count</code> - Number of device to be allocated.</dd>
<dd><code>env</code> - Environment variables of the container.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A set of <a href="../../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/api/deviceplugin/Device.html" title="class in org.apache.hadoop.yarn.server.nodemanager.api.deviceplugin"><code>Device</code></a> allocated</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/NECVEPlugin.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>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../../index.html?org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/com/nec/NECVEPlugin.html" target="_top">Frames</a></li>
<li><a href="NECVEPlugin.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>