Google Git
Sign in
apache / spark-website / 28656f2c00baf1bc2d26570a16b4f96f9a890723 / . / site / docs / 3.2.2 / api / python / _modules / pyspark / resource / requests.html
blob: 2bee784ff97258cb109e82451d29b1a15e7751d6 [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>pyspark.resource.requests &#8212; PySpark 3.2.2 documentation</title>
<link rel="stylesheet" href="../../../_static/css/index.73d71520a4ca3b99cfee5594769eaaae.css">
<link rel="stylesheet"
href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet"
href="../../../_static/vendor/open-sans_all/1.44.1/index.css">
<link rel="stylesheet"
href="../../../_static/vendor/lato_latin-ext/1.44.1/index.css">
<link rel="stylesheet" href="../../../_static/basic.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/pyspark.css" />
<link rel="preload" as="script" href="../../../_static/js/index.3da636dd464baa7582d2.js">
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/language_data.js"></script>
<script src="../../../_static/copybutton.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
<link rel="search" title="Search" href="../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en" />
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
<nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main">
<div class="container-xl">
<a class="navbar-brand" href="../../../index.html">
<img src="../../../_static/spark-logo-reverse.png" class="logo" alt="logo" />
</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-menu" aria-controls="navbar-menu" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar-menu" class="col-lg-9 collapse navbar-collapse">
<ul id="navbar-main-elements" class="navbar-nav mr-auto">
<li class="nav-item ">
<a class="nav-link" href="../../../getting_started/index.html">Getting Started</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../../user_guide/index.html">User Guide</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../../reference/index.html">API Reference</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../../development/index.html">Development</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../../migration_guide/index.html">Migration Guide</a>
</li>
</ul>
<ul class="navbar-nav">
</ul>
</div>
</div>
</nav>
<div class="container-xl">
<div class="row">
<div class="col-12 col-md-3 bd-sidebar"><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form>
<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
<ul class="nav bd-sidenav">
</ul>
</nav>
</div>
<div class="d-none d-xl-block col-xl-2 bd-toc">
<nav id="bd-toc-nav">
<ul class="nav section-nav flex-column">
</ul>
</nav>
</div>
<main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
<div>
<h1>Source code for pyspark.resource.requests</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
<span class="c1"># contributor license agreements. See the NOTICE file distributed with</span>
<span class="c1"># this work for additional information regarding copyright ownership.</span>
<span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
<span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
<span class="c1"># the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="c1">#</span>
<span class="kn">from</span> <span class="nn">pyspark.util</span> <span class="kn">import</span> <span class="n">_parse_memory</span>
<div class="viewcode-block" id="ExecutorResourceRequest"><a class="viewcode-back" href="../../../reference/api/pyspark.resource.ExecutorResourceRequest.html#pyspark.resource.ExecutorResourceRequest">[docs]</a><span class="k">class</span> <span class="nc">ExecutorResourceRequest</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> An Executor resource request. This is used in conjunction with the ResourceProfile to</span>
<span class="sd"> programmatically specify the resources needed for an RDD that will be applied at the</span>
<span class="sd"> stage level.</span>
<span class="sd"> This is used to specify what the resource requirements are for an Executor and how</span>
<span class="sd"> Spark can find out specific details about those resources. Not all the parameters are</span>
<span class="sd"> required for every resource type. Resources like GPUs are supported and have same limitations</span>
<span class="sd"> as using the global spark configs spark.executor.resource.gpu.*. The amount, discoveryScript,</span>
<span class="sd"> and vendor parameters for resources are all the same parameters a user would specify through the</span>
<span class="sd"> configs: spark.executor.resource.{resourceName}.{amount, discoveryScript, vendor}.</span>
<span class="sd"> For instance, a user wants to allocate an Executor with GPU resources on YARN. The user has</span>
<span class="sd"> to specify the resource name (gpu), the amount or number of GPUs per Executor,</span>
<span class="sd"> the discovery script would be specified so that when the Executor starts up it can</span>
<span class="sd"> discovery what GPU addresses are available for it to use because YARN doesn&#39;t tell</span>
<span class="sd"> Spark that, then vendor would not be used because its specific for Kubernetes.</span>
<span class="sd"> See the configuration and cluster specific docs for more details.</span>
<span class="sd"> Use :py:class:`pyspark.ExecutorResourceRequests` class as a convenience API.</span>
<span class="sd"> .. versionadded:: 3.1.0</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> resourceName : str</span>
<span class="sd"> Name of the resource</span>
<span class="sd"> amount : str</span>
<span class="sd"> Amount requesting</span>
<span class="sd"> discoveryScript : str, optional</span>
<span class="sd"> Optional script used to discover the resources. This is required on some</span>
<span class="sd"> cluster managers that don&#39;t tell Spark the addresses of the resources</span>
<span class="sd"> allocated. The script runs on Executors startup to discover the addresses</span>
<span class="sd"> of the resources available.</span>
<span class="sd"> vendor : str, optional</span>
<span class="sd"> Vendor, required for some cluster managers</span>
<span class="sd"> Notes</span>
<span class="sd"> -----</span>
<span class="sd"> This API is evolving.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resourceName</span><span class="p">,</span> <span class="n">amount</span><span class="p">,</span> <span class="n">discoveryScript</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">vendor</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="o">=</span> <span class="n">resourceName</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_amount</span> <span class="o">=</span> <span class="n">amount</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_discovery_script</span> <span class="o">=</span> <span class="n">discoveryScript</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_vendor</span> <span class="o">=</span> <span class="n">vendor</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">resourceName</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_name</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">amount</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_amount</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">discoveryScript</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_discovery_script</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">vendor</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_vendor</span></div>
<div class="viewcode-block" id="ExecutorResourceRequests"><a class="viewcode-back" href="../../../reference/api/pyspark.resource.ExecutorResourceRequests.html#pyspark.resource.ExecutorResourceRequests">[docs]</a><span class="k">class</span> <span class="nc">ExecutorResourceRequests</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A set of Executor resource requests. This is used in conjunction with the</span>
<span class="sd"> :class:`pyspark.resource.ResourceProfileBuilder` to programmatically specify the</span>
<span class="sd"> resources needed for an RDD that will be applied at the stage level.</span>
<span class="sd"> .. versionadded:: 3.1.0</span>
<span class="sd"> Notes</span>
<span class="sd"> -----</span>
<span class="sd"> This API is evolving.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">_CORES</span> <span class="o">=</span> <span class="s2">&quot;cores&quot;</span>
<span class="n">_MEMORY</span> <span class="o">=</span> <span class="s2">&quot;memory&quot;</span>
<span class="n">_OVERHEAD_MEM</span> <span class="o">=</span> <span class="s2">&quot;memoryOverhead&quot;</span>
<span class="n">_PYSPARK_MEM</span> <span class="o">=</span> <span class="s2">&quot;pyspark.memory&quot;</span>
<span class="n">_OFFHEAP_MEM</span> <span class="o">=</span> <span class="s2">&quot;offHeap&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">_jvm</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">_requests</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="kn">from</span> <span class="nn">pyspark</span> <span class="kn">import</span> <span class="n">SparkContext</span>
<span class="n">_jvm</span> <span class="o">=</span> <span class="n">_jvm</span> <span class="ow">or</span> <span class="n">SparkContext</span><span class="o">.</span><span class="n">_jvm</span>
<span class="k">if</span> <span class="n">_jvm</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span> <span class="o">=</span> \
<span class="n">_jvm</span><span class="o">.</span><span class="n">org</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">spark</span><span class="o">.</span><span class="n">resource</span><span class="o">.</span><span class="n">ExecutorResourceRequests</span><span class="p">()</span>
<span class="k">if</span> <span class="n">_requests</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">_requests</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="n">k</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">_MEMORY</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span><span class="o">.</span><span class="n">memory</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">amount</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">k</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">_OVERHEAD_MEM</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span><span class="o">.</span><span class="n">memoryOverhead</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">amount</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">k</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">_PYSPARK_MEM</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span><span class="o">.</span><span class="n">pysparkMemory</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">amount</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">k</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">_CORES</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span><span class="o">.</span><span class="n">cores</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">amount</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span><span class="o">.</span><span class="n">resource</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">resourceName</span><span class="p">,</span> <span class="n">v</span><span class="o">.</span><span class="n">amount</span><span class="p">,</span>
<span class="n">v</span><span class="o">.</span><span class="n">discoveryScript</span><span class="p">,</span> <span class="n">v</span><span class="o">.</span><span class="n">vendor</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_executor_resources</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">def</span> <span class="nf">memory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">amount</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span><span class="o">.</span><span class="n">memory</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_executor_resources</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_MEMORY</span><span class="p">]</span> <span class="o">=</span> <span class="n">ExecutorResourceRequest</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_MEMORY</span><span class="p">,</span>
<span class="n">_parse_memory</span><span class="p">(</span><span class="n">amount</span><span class="p">))</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">def</span> <span class="nf">memoryOverhead</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">amount</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span><span class="o">.</span><span class="n">memoryOverhead</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_executor_resources</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_OVERHEAD_MEM</span><span class="p">]</span> <span class="o">=</span> \
<span class="n">ExecutorResourceRequest</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_OVERHEAD_MEM</span><span class="p">,</span> <span class="n">_parse_memory</span><span class="p">(</span><span class="n">amount</span><span class="p">))</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">def</span> <span class="nf">pysparkMemory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">amount</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span><span class="o">.</span><span class="n">pysparkMemory</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_executor_resources</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_PYSPARK_MEM</span><span class="p">]</span> <span class="o">=</span> \
<span class="n">ExecutorResourceRequest</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_PYSPARK_MEM</span><span class="p">,</span> <span class="n">_parse_memory</span><span class="p">(</span><span class="n">amount</span><span class="p">))</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">def</span> <span class="nf">offheapMemory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">amount</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span><span class="o">.</span><span class="n">offHeapMemory</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_executor_resources</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_OFFHEAP_MEM</span><span class="p">]</span> <span class="o">=</span> \
<span class="n">ExecutorResourceRequest</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_OFFHEAP_MEM</span><span class="p">,</span> <span class="n">_parse_memory</span><span class="p">(</span><span class="n">amount</span><span class="p">))</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">def</span> <span class="nf">cores</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">amount</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span><span class="o">.</span><span class="n">cores</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_executor_resources</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_CORES</span><span class="p">]</span> <span class="o">=</span> <span class="n">ExecutorResourceRequest</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_CORES</span><span class="p">,</span> <span class="n">amount</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">def</span> <span class="nf">resource</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resourceName</span><span class="p">,</span> <span class="n">amount</span><span class="p">,</span> <span class="n">discoveryScript</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">vendor</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span><span class="o">.</span><span class="n">resource</span><span class="p">(</span><span class="n">resourceName</span><span class="p">,</span> <span class="n">amount</span><span class="p">,</span> <span class="n">discoveryScript</span><span class="p">,</span>
<span class="n">vendor</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_executor_resources</span><span class="p">[</span><span class="n">resourceName</span><span class="p">]</span> <span class="o">=</span> \
<span class="n">ExecutorResourceRequest</span><span class="p">(</span><span class="n">resourceName</span><span class="p">,</span> <span class="n">amount</span><span class="p">,</span> <span class="n">discoveryScript</span><span class="p">,</span> <span class="n">vendor</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">requests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">result</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">execRes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_java_executor_resource_requests</span><span class="o">.</span><span class="n">requestsJMap</span><span class="p">()</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">execRes</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">result</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">ExecutorResourceRequest</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">resourceName</span><span class="p">(),</span> <span class="n">v</span><span class="o">.</span><span class="n">amount</span><span class="p">(),</span>
<span class="n">v</span><span class="o">.</span><span class="n">discoveryScript</span><span class="p">(),</span> <span class="n">v</span><span class="o">.</span><span class="n">vendor</span><span class="p">())</span>
<span class="k">return</span> <span class="n">result</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_executor_resources</span></div>
<div class="viewcode-block" id="TaskResourceRequest"><a class="viewcode-back" href="../../../reference/api/pyspark.resource.TaskResourceRequest.html#pyspark.resource.TaskResourceRequest">[docs]</a><span class="k">class</span> <span class="nc">TaskResourceRequest</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A task resource request. This is used in conjunction with the</span>
<span class="sd"> :class:`pyspark.resource.ResourceProfile` to programmatically specify the resources</span>
<span class="sd"> needed for an RDD that will be applied at the stage level. The amount is specified</span>
<span class="sd"> as a Double to allow for saying you want more than 1 task per resource. Valid values</span>
<span class="sd"> are less than or equal to 0.5 or whole numbers.</span>
<span class="sd"> Use :class:`pyspark.resource.TaskResourceRequests` class as a convenience API.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> resourceName : str</span>
<span class="sd"> Name of the resource</span>
<span class="sd"> amount : float</span>
<span class="sd"> Amount requesting as a float to support fractional resource requests.</span>
<span class="sd"> Valid values are less than or equal to 0.5 or whole numbers.</span>
<span class="sd"> .. versionadded:: 3.1.0</span>
<span class="sd"> Notes</span>
<span class="sd"> -----</span>
<span class="sd"> This API is evolving.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resourceName</span><span class="p">,</span> <span class="n">amount</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="o">=</span> <span class="n">resourceName</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_amount</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">resourceName</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_name</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">amount</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_amount</span></div>
<div class="viewcode-block" id="TaskResourceRequests"><a class="viewcode-back" href="../../../reference/api/pyspark.resource.TaskResourceRequests.html#pyspark.resource.TaskResourceRequests">[docs]</a><span class="k">class</span> <span class="nc">TaskResourceRequests</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A set of task resource requests. This is used in conjunction with the</span>
<span class="sd"> :class:`pyspark.resource.ResourceProfileBuilder` to programmatically specify the resources</span>
<span class="sd"> needed for an RDD that will be applied at the stage level.</span>
<span class="sd"> .. versionadded:: 3.1.0</span>
<span class="sd"> Notes</span>
<span class="sd"> -----</span>
<span class="sd"> This API is evolving.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">_CPUS</span> <span class="o">=</span> <span class="s2">&quot;cpus&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">_jvm</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">_requests</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="kn">from</span> <span class="nn">pyspark</span> <span class="kn">import</span> <span class="n">SparkContext</span>
<span class="n">_jvm</span> <span class="o">=</span> <span class="n">_jvm</span> <span class="ow">or</span> <span class="n">SparkContext</span><span class="o">.</span><span class="n">_jvm</span>
<span class="k">if</span> <span class="n">_jvm</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_task_resource_requests</span> <span class="o">=</span> \
<span class="n">SparkContext</span><span class="o">.</span><span class="n">_jvm</span><span class="o">.</span><span class="n">org</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">spark</span><span class="o">.</span><span class="n">resource</span><span class="o">.</span><span class="n">TaskResourceRequests</span><span class="p">()</span>
<span class="k">if</span> <span class="n">_requests</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">_requests</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="n">k</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">_CPUS</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_task_resource_requests</span><span class="o">.</span><span class="n">cpus</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">amount</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_task_resource_requests</span><span class="o">.</span><span class="n">resource</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">resourceName</span><span class="p">,</span> <span class="n">v</span><span class="o">.</span><span class="n">amount</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_task_resource_requests</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_task_resources</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">def</span> <span class="nf">cpus</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">amount</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_java_task_resource_requests</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_task_resource_requests</span><span class="o">.</span><span class="n">cpus</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_task_resources</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_CPUS</span><span class="p">]</span> <span class="o">=</span> <span class="n">TaskResourceRequest</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_CPUS</span><span class="p">,</span> <span class="n">amount</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">def</span> <span class="nf">resource</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resourceName</span><span class="p">,</span> <span class="n">amount</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_java_task_resource_requests</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_java_task_resource_requests</span><span class="o">.</span><span class="n">resource</span><span class="p">(</span><span class="n">resourceName</span><span class="p">,</span> <span class="nb">float</span><span class="p">(</span><span class="n">amount</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_task_resources</span><span class="p">[</span><span class="n">resourceName</span><span class="p">]</span> <span class="o">=</span> <span class="n">TaskResourceRequest</span><span class="p">(</span><span class="n">resourceName</span><span class="p">,</span> <span class="n">amount</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">requests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_java_task_resource_requests</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">result</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">taskRes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_java_task_resource_requests</span><span class="o">.</span><span class="n">requestsJMap</span><span class="p">()</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">taskRes</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">result</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">TaskResourceRequest</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">resourceName</span><span class="p">(),</span> <span class="n">v</span><span class="o">.</span><span class="n">amount</span><span class="p">())</span>
<span class="k">return</span> <span class="n">result</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_task_resources</span></div>
</pre></div>
</div>
<div class='prev-next-bottom'>
</div>
</main>
</div>
</div>
<script src="../../../_static/js/index.3da636dd464baa7582d2.js"></script>
<footer class="footer mt-5 mt-md-0">
<div class="container">
<p>
&copy; Copyright .<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.4.<br/>
</p>
</div>
</footer>
</body>
</html>