This file is indexed.

/usr/share/doc/python-distributed-doc/html/_modules/distributed/deploy/adaptive.html is in python-distributed-doc 1.20.2+ds.1-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>distributed.deploy.adaptive &mdash; Dask.distributed 0+unknown documentation</title>
  

  
  
  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
  

  

  
        <link rel="index" title="Index"
              href="../../../genindex.html"/>
        <link rel="search" title="Search" href="../../../search.html"/>
    <link rel="top" title="Dask.distributed 0+unknown documentation" href="../../../index.html"/>
        <link rel="up" title="Module code" href="../../index.html"/> 

  
  <script src="../../../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="../../../index.html" class="icon icon-home"> Dask.distributed
          

          
          </a>

          
            
            
              <div class="version">
                0+unknown
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../install.html">Install Dask.Distributed</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../setup.html">Setup Network</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../faq.html">Frequently Asked Questions</a></li>
</ul>
<p class="caption"><span class="caption-text">Build Understanding</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../diagnosing-performance.html">Diagnosing Performance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../efficiency.html">Efficiency</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../limitations.html">Limitations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../locality.html">Data Locality</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../manage-computation.html">Managing Computation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../memory.html">Managing Memory</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../related-work.html">Related Work</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../resilience.html">Resilience</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../scheduling-policies.html">Scheduling Policies</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../scheduling-state.html">Scheduling State</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../worker.html">Worker</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../work-stealing.html">Work Stealing</a></li>
</ul>
<p class="caption"><span class="caption-text">Additional Features</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../adaptive.html">Adaptive Deployments</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../asynchronous.html">Asynchronous Operation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ec2.html">EC2 Startup Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../local-cluster.html">Local Cluster</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ipython.html">IPython Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../joblib.html">Joblib Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../publish.html">Publish Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../queues.html">Data Streams with Queues</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Worker Resources</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../submitting-applications.html">Submitting Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../task-launch.html">Launch Tasks from Tasks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tls.html">TLS/SSL</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../web.html">Web Interface</a></li>
</ul>
<p class="caption"><span class="caption-text">Developer Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../communications.html">Communications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../develop.html">Development Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../foundations.html">Foundations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../journey.html">Journey of a Task</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../protocol.html">Protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../serialization.html">Custom Serialization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../plugins.html">Scheduler Plugins</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../../index.html">Dask.distributed</a>
        
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../../../index.html">Docs</a> &raquo;</li>
        
          <li><a href="../../index.html">Module code</a> &raquo;</li>
        
      <li>distributed.deploy.adaptive</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <h1>Source code for distributed.deploy.adaptive</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">print_function</span><span class="p">,</span> <span class="n">division</span><span class="p">,</span> <span class="n">absolute_import</span>

<span class="kn">import</span> <span class="nn">logging</span>

<span class="kn">from</span> <span class="nn">tornado</span> <span class="k">import</span> <span class="n">gen</span>

<span class="kn">from</span> <span class="nn">..utils</span> <span class="k">import</span> <span class="n">log_errors</span><span class="p">,</span> <span class="n">PeriodicCallback</span>

<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>


<div class="viewcode-block" id="Adaptive"><a class="viewcode-back" href="../../../api.html#distributed.deploy.Adaptive">[docs]</a><span class="k">class</span> <span class="nc">Adaptive</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="sd">&#39;&#39;&#39;</span>
<span class="sd">    Adaptively allocate workers based on scheduler load.  A superclass.</span>

<span class="sd">    Contains logic to dynamically resize a Dask cluster based on current use.</span>

<span class="sd">    Parameters</span>
<span class="sd">    ----------</span>
<span class="sd">    scheduler: distributed.Scheduler</span>
<span class="sd">    cluster: object</span>
<span class="sd">        Must have scale_up and scale_down methods/coroutines</span>
<span class="sd">    startup_cost : int, default 1</span>
<span class="sd">        Factor representing how costly it is to start an additional worker.</span>
<span class="sd">        Affects quickly to adapt to high tasks per worker loads</span>
<span class="sd">    scale_factor : int, default 2</span>
<span class="sd">        Factor to scale by when it&#39;s determined additional workers are needed</span>

<span class="sd">    Examples</span>
<span class="sd">    --------</span>
<span class="sd">    &gt;&gt;&gt; class MyCluster(object):</span>
<span class="sd">    ...     def scale_up(self, n):</span>
<span class="sd">    ...         &quot;&quot;&quot; Bring worker count up to n &quot;&quot;&quot;</span>
<span class="sd">    ...     def scale_down(self, workers):</span>
<span class="sd">    ...        &quot;&quot;&quot; Remove worker addresses from cluster &quot;&quot;&quot;</span>

<span class="sd">    Notes</span>
<span class="sd">    -----</span>
<span class="sd">    Subclasses can override :meth:`Adaptive.should_scale_up` and</span>
<span class="sd">    :meth:`Adaptive.should_scale_down` to control when the cluster should be</span>
<span class="sd">    resized. The default implementation checks if there are too many tasks</span>
<span class="sd">    per worker or too little memory available (see :meth:`Adaptive.needs_cpu`</span>
<span class="sd">    and :meth:`Adaptive.needs_memory`).</span>

<span class="sd">    :meth:`Adaptive.get_scale_up_kwargs` method controls the arguments passed to</span>
<span class="sd">    the cluster&#39;s ``scale_up`` method.</span>
<span class="sd">    &#39;&#39;&#39;</span>

    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">scheduler</span><span class="p">,</span> <span class="n">cluster</span><span class="p">,</span> <span class="n">interval</span><span class="o">=</span><span class="mi">1000</span><span class="p">,</span> <span class="n">startup_cost</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
                 <span class="n">scale_factor</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span> <span class="o">=</span> <span class="n">scheduler</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">cluster</span> <span class="o">=</span> <span class="n">cluster</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">startup_cost</span> <span class="o">=</span> <span class="n">startup_cost</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">scale_factor</span> <span class="o">=</span> <span class="n">scale_factor</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_adapt_callback</span> <span class="o">=</span> <span class="n">PeriodicCallback</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_adapt</span><span class="p">,</span> <span class="n">interval</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span><span class="o">.</span><span class="n">loop</span><span class="o">.</span><span class="n">add_callback</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_adapt_callback</span><span class="o">.</span><span class="n">start</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_adapting</span> <span class="o">=</span> <span class="kc">False</span>

<div class="viewcode-block" id="Adaptive.needs_cpu"><a class="viewcode-back" href="../../../api.html#distributed.deploy.Adaptive.needs_cpu">[docs]</a>    <span class="k">def</span> <span class="nf">needs_cpu</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Check if the cluster is CPU constrained (too many tasks per core)</span>

<span class="sd">        Notes</span>
<span class="sd">        -----</span>
<span class="sd">        Returns ``True`` if the occupancy per core is some factor larger</span>
<span class="sd">        than ``startup_cost``.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">total_occupancy</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span><span class="o">.</span><span class="n">total_occupancy</span>
        <span class="n">total_cores</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span><span class="o">.</span><span class="n">ncores</span><span class="o">.</span><span class="n">values</span><span class="p">())</span>

        <span class="k">if</span> <span class="n">total_occupancy</span> <span class="o">/</span> <span class="p">(</span><span class="n">total_cores</span> <span class="o">+</span> <span class="mf">1e-9</span><span class="p">)</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">startup_cost</span> <span class="o">*</span> <span class="mi">2</span><span class="p">:</span>
            <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;CPU limit exceeded [</span><span class="si">%d</span><span class="s2"> occupancy / </span><span class="si">%d</span><span class="s2"> cores]&quot;</span><span class="p">,</span>
                        <span class="n">total_occupancy</span><span class="p">,</span> <span class="n">total_cores</span><span class="p">)</span>
            <span class="k">return</span> <span class="kc">True</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="k">return</span> <span class="kc">False</span></div>

<div class="viewcode-block" id="Adaptive.needs_memory"><a class="viewcode-back" href="../../../api.html#distributed.deploy.Adaptive.needs_memory">[docs]</a>    <span class="k">def</span> <span class="nf">needs_memory</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Check if the cluster is RAM constrained</span>

<span class="sd">        Notes</span>
<span class="sd">        -----</span>
<span class="sd">        Returns ``True`` if  the required bytes in distributed memory is some</span>
<span class="sd">        factor larger than the actual distributed memory available.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">limit_bytes</span> <span class="o">=</span> <span class="p">{</span><span class="n">w</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span><span class="o">.</span><span class="n">worker_info</span><span class="p">[</span><span class="n">w</span><span class="p">][</span><span class="s1">&#39;memory_limit&#39;</span><span class="p">]</span>
                        <span class="k">for</span> <span class="n">w</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span><span class="o">.</span><span class="n">worker_info</span><span class="p">}</span>
        <span class="n">worker_bytes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span><span class="o">.</span><span class="n">worker_bytes</span>

        <span class="n">limit</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">(</span><span class="n">limit_bytes</span><span class="o">.</span><span class="n">values</span><span class="p">())</span>
        <span class="n">total</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">(</span><span class="n">worker_bytes</span><span class="o">.</span><span class="n">values</span><span class="p">())</span>
        <span class="k">if</span> <span class="n">total</span> <span class="o">&gt;</span> <span class="mf">0.6</span> <span class="o">*</span> <span class="n">limit</span><span class="p">:</span>
            <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Ram limit exceeded [</span><span class="si">%d</span><span class="s2">/</span><span class="si">%d</span><span class="s2">]&quot;</span><span class="p">,</span> <span class="n">limit</span><span class="p">,</span> <span class="n">total</span><span class="p">)</span>
            <span class="k">return</span> <span class="kc">True</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="k">return</span> <span class="kc">False</span></div>

<div class="viewcode-block" id="Adaptive.should_scale_up"><a class="viewcode-back" href="../../../api.html#distributed.deploy.Adaptive.should_scale_up">[docs]</a>    <span class="k">def</span> <span class="nf">should_scale_up</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Determine whether additional workers should be added to the cluster</span>

<span class="sd">        Returns</span>
<span class="sd">        -------</span>
<span class="sd">        scale_up : bool</span>

<span class="sd">        Notes</span>
<span class="sd">        ----</span>
<span class="sd">        Additional workers are added whenever</span>

<span class="sd">        1. There are unrunnable tasks and no workers</span>
<span class="sd">        2. The cluster is CPU constrained</span>
<span class="sd">        3. The cluster is RAM constrained</span>

<span class="sd">        See Also</span>
<span class="sd">        --------</span>
<span class="sd">        needs_cpu</span>
<span class="sd">        needs_memory</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">with</span> <span class="n">log_errors</span><span class="p">():</span>
            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span><span class="o">.</span><span class="n">unrunnable</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span><span class="o">.</span><span class="n">ncores</span><span class="p">:</span>
                <span class="k">return</span> <span class="kc">True</span>

            <span class="n">needs_cpu</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">needs_cpu</span><span class="p">()</span>
            <span class="n">needs_memory</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">needs_memory</span><span class="p">()</span>

            <span class="k">if</span> <span class="n">needs_cpu</span> <span class="ow">or</span> <span class="n">needs_memory</span><span class="p">:</span>
                <span class="k">return</span> <span class="kc">True</span>

            <span class="k">return</span> <span class="kc">False</span></div>

<div class="viewcode-block" id="Adaptive.should_scale_down"><a class="viewcode-back" href="../../../api.html#distributed.deploy.Adaptive.should_scale_down">[docs]</a>    <span class="k">def</span> <span class="nf">should_scale_down</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Determine whether any workers should potentially be removed from</span>
<span class="sd">        the cluster.</span>

<span class="sd">        Returns</span>
<span class="sd">        -------</span>
<span class="sd">        scale_down : bool</span>

<span class="sd">        Notes</span>
<span class="sd">        -----</span>
<span class="sd">        ``Adaptive.should_scale_down`` always returns True, so we will always</span>
<span class="sd">        attempt to remove workers as determined by</span>
<span class="sd">        ``Scheduler.workers_to_close``.</span>

<span class="sd">        See Also</span>
<span class="sd">        --------</span>
<span class="sd">        Scheduler.workers_to_close</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span><span class="o">.</span><span class="n">workers_to_close</span><span class="p">())</span> <span class="o">&gt;</span> <span class="mi">0</span></div>

    <span class="nd">@gen</span><span class="o">.</span><span class="n">coroutine</span>
    <span class="k">def</span> <span class="nf">_retire_workers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">with</span> <span class="n">log_errors</span><span class="p">():</span>
            <span class="n">workers</span> <span class="o">=</span> <span class="k">yield</span> <span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span><span class="o">.</span><span class="n">retire_workers</span><span class="p">(</span><span class="n">remove</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
                                                          <span class="n">close_workers</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

            <span class="k">if</span> <span class="n">workers</span><span class="p">:</span>
                <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Retiring workers </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">workers</span><span class="p">)</span>
                <span class="n">f</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cluster</span><span class="o">.</span><span class="n">scale_down</span><span class="p">(</span><span class="n">workers</span><span class="p">)</span>
                <span class="k">if</span> <span class="n">gen</span><span class="o">.</span><span class="n">is_future</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
                    <span class="k">yield</span> <span class="n">f</span>

<div class="viewcode-block" id="Adaptive.get_scale_up_kwargs"><a class="viewcode-back" href="../../../api.html#distributed.deploy.Adaptive.get_scale_up_kwargs">[docs]</a>    <span class="k">def</span> <span class="nf">get_scale_up_kwargs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Get the arguments to be passed to ``self.cluster.scale_up``.</span>

<span class="sd">        Notes</span>
<span class="sd">        -----</span>
<span class="sd">        By default the desired number of total workers is returned (``n``).</span>
<span class="sd">        Subclasses should ensure that the return dictionary includes a key-</span>
<span class="sd">        value pair for ``n``, either by implementing it or by calling the</span>
<span class="sd">        parent&#39;s ``get_scale_up_kwargs``.</span>

<span class="sd">        See Also</span>
<span class="sd">        --------</span>
<span class="sd">        LocalCluster.scale_up</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">instances</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span><span class="o">.</span><span class="n">ncores</span><span class="p">)</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">scale_factor</span><span class="p">)</span>
        <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Scaling up to </span><span class="si">%d</span><span class="s2"> workers&quot;</span><span class="p">,</span> <span class="n">instances</span><span class="p">)</span>
        <span class="k">return</span> <span class="p">{</span><span class="s1">&#39;n&#39;</span><span class="p">:</span> <span class="n">instances</span><span class="p">}</span></div>

    <span class="nd">@gen</span><span class="o">.</span><span class="n">coroutine</span>
    <span class="k">def</span> <span class="nf">_adapt</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">_adapting</span><span class="p">:</span>  <span class="c1"># Semaphore to avoid overlapping adapt calls</span>
            <span class="k">return</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">_adapting</span> <span class="o">=</span> <span class="kc">True</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="n">should_scale_up</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">should_scale_up</span><span class="p">()</span>
            <span class="n">should_scale_down</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">should_scale_down</span><span class="p">()</span>
            <span class="k">if</span> <span class="n">should_scale_up</span> <span class="ow">and</span> <span class="n">should_scale_down</span><span class="p">:</span>
                <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Attempting to scale up and scale down simultaneously.&quot;</span><span class="p">)</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="k">if</span> <span class="n">should_scale_up</span><span class="p">:</span>
                    <span class="n">kwargs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_scale_up_kwargs</span><span class="p">()</span>
                    <span class="n">f</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cluster</span><span class="o">.</span><span class="n">scale_up</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
                    <span class="k">if</span> <span class="n">gen</span><span class="o">.</span><span class="n">is_future</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
                        <span class="k">yield</span> <span class="n">f</span>

                <span class="k">if</span> <span class="n">should_scale_down</span><span class="p">:</span>
                    <span class="k">yield</span> <span class="bp">self</span><span class="o">.</span><span class="n">_retire_workers</span><span class="p">()</span>
        <span class="k">finally</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">_adapting</span> <span class="o">=</span> <span class="kc">False</span>

    <span class="k">def</span> <span class="nf">adapt</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span><span class="o">.</span><span class="n">loop</span><span class="o">.</span><span class="n">add_callback</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_adapt</span><span class="p">)</span></div>
</pre></div>

           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2017, Anaconda, Inc..

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../../../',
            VERSION:'0+unknown',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="../../../_static/jquery.js"></script>
      <script type="text/javascript" src="../../../_static/underscore.js"></script>
      <script type="text/javascript" src="../../../_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="../../../_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>