Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.5 / _modules / airflow / contrib / sensors / sagemaker_training_sensor.html
blob: 1318d48b17c780489f55234b52e964e17a398d2d [file] [log] [blame]
<!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>airflow.contrib.sensors.sagemaker_training_sensor &mdash; Airflow Documentation</title>
<script type="text/javascript" src="../../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></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/language_data.js"></script>
<script type="text/javascript" src="../../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<script>
document.addEventListener('DOMContentLoaded', function() {
var el = document.getElementById('changelog');
if (el !== null ) {
// [AIRFLOW-...]
el.innerHTML = el.innerHTML.replace(
/\[(AIRFLOW-[\d]+)\]/g,
`<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>`
);
// (#...)
el.innerHTML = el.innerHTML.replace(
/\(#([\d]+)\)/g,
`<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>`
);
};
})
</script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-140539454-1']);
_gaq.push(['_trackPageview']);
</script>
<style>
.example-header {
position: relative;
background: #9AAA7A;
padding: 8px 16px;
margin-bottom: 0;
}
.example-header--with-button {
padding-right: 166px;
}
.example-header:after{
content: '';
display: table;
clear: both;
}
.example-title {
display:block;
padding: 4px;
margin-right: 16px;
color: white;
overflow-x: auto;
}
.example-header-button {
top: 8px;
right: 16px;
position: absolute;
}
.example-header + .highlight-python {
margin-top: 0 !important;
}
.viewcode-button {
display: inline-block;
padding: 8px 16px;
border: 0;
margin: 0;
outline: 0;
border-radius: 2px;
-webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3);
box-shadow: 0 3px 6px 0 rgba(0,0,0,.3);
color: #404040;
background-color: #e7e7e7;
cursor: pointer;
font-size: 16px;
font-weight: 500;
line-height: 1;
text-decoration: none;
text-overflow: ellipsis;
overflow: hidden;
text-transform: uppercase;
-webkit-transition: background-color .2s;
transition: background-color .2s;
vertical-align: middle;
white-space: nowrap;
}
.viewcode-button:visited {
color: #404040;
}
.viewcode-button:hover, .viewcode-button:focus {
color: #404040;
background-color: #d6d6d6;
}
</style>
</head>
<body class="wy-body-for-nav">
<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"> Airflow
</a>
<div class="version">
1.10.5
</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">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../project.html">Project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling &amp; Triggers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../plugins.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../security.html">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../timezone.html">Time zones</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../api.html">REST API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../metrics.html">Metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../kubernetes.html">Kubernetes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../lineage.html">Lineage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../macros.html">Macros reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../_api/index.html">Python API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../privacy_notice.html">Privacy Notice</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../index.html">Airflow</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>airflow.contrib.sensors.sagemaker_training_sensor</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 airflow.contrib.sensors.sagemaker_training_sensor</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="c1"># or more contributor license agreements. See the NOTICE file</span>
<span class="c1"># distributed with this work for additional information</span>
<span class="c1"># regarding copyright ownership. The ASF licenses this file</span>
<span class="c1"># to you under the Apache License, Version 2.0 (the</span>
<span class="c1"># &quot;License&quot;); you may not use this file except in compliance</span>
<span class="c1"># with 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,</span>
<span class="c1"># software distributed under the License is distributed on an</span>
<span class="c1"># &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
<span class="c1"># KIND, either express or implied. See the License for the</span>
<span class="c1"># specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.hooks.sagemaker_hook</span> <span class="k">import</span> <span class="n">SageMakerHook</span><span class="p">,</span> <span class="n">LogState</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.sensors.sagemaker_base_sensor</span> <span class="k">import</span> <span class="n">SageMakerBaseSensor</span>
<span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span>
<div class="viewcode-block" id="SageMakerTrainingSensor"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/sagemaker_training_sensor/index.html#airflow.contrib.sensors.sagemaker_training_sensor.SageMakerTrainingSensor">[docs]</a><span class="k">class</span> <span class="nc">SageMakerTrainingSensor</span><span class="p">(</span><span class="n">SageMakerBaseSensor</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Asks for the state of the training state until it reaches a terminal state.</span>
<span class="sd"> If it fails the sensor errors, failing the task.</span>
<span class="sd"> :param job_name: name of the SageMaker training job to check the state of</span>
<span class="sd"> :type job_name: str</span>
<span class="sd"> :param print_log: if the operator should print the cloudwatch log</span>
<span class="sd"> :type print_log: bool</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="SageMakerTrainingSensor.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/sagemaker_training_sensor/index.html#airflow.contrib.sensors.sagemaker_training_sensor.SageMakerTrainingSensor.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;job_name&#39;</span><span class="p">]</span></div>
<div class="viewcode-block" id="SageMakerTrainingSensor.template_ext"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/sagemaker_training_sensor/index.html#airflow.contrib.sensors.sagemaker_training_sensor.SageMakerTrainingSensor.template_ext">[docs]</a> <span class="n">template_ext</span> <span class="o">=</span> <span class="p">()</span></div>
<span class="nd">@apply_defaults</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">job_name</span><span class="p">,</span>
<span class="n">print_log</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="o">*</span><span class="n">args</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">SageMakerTrainingSensor</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">job_name</span> <span class="o">=</span> <span class="n">job_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">print_log</span> <span class="o">=</span> <span class="n">print_log</span>
<span class="bp">self</span><span class="o">.</span><span class="n">positions</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stream_names</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">instance_count</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">state</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_description</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_describe_job_call</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log_resource_inited</span> <span class="o">=</span> <span class="kc">False</span>
<div class="viewcode-block" id="SageMakerTrainingSensor.init_log_resource"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/sagemaker_training_sensor/index.html#airflow.contrib.sensors.sagemaker_training_sensor.SageMakerTrainingSensor.init_log_resource">[docs]</a> <span class="k">def</span> <span class="nf">init_log_resource</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hook</span><span class="p">):</span>
<span class="n">description</span> <span class="o">=</span> <span class="n">hook</span><span class="o">.</span><span class="n">describe_training_job</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">job_name</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">instance_count</span> <span class="o">=</span> <span class="n">description</span><span class="p">[</span><span class="s1">&#39;ResourceConfig&#39;</span><span class="p">][</span><span class="s1">&#39;InstanceCount&#39;</span><span class="p">]</span>
<span class="n">status</span> <span class="o">=</span> <span class="n">description</span><span class="p">[</span><span class="s1">&#39;TrainingJobStatus&#39;</span><span class="p">]</span>
<span class="n">job_already_completed</span> <span class="o">=</span> <span class="n">status</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">non_terminal_states</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">state</span> <span class="o">=</span> <span class="n">LogState</span><span class="o">.</span><span class="n">TAILING</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">job_already_completed</span> <span class="k">else</span> <span class="n">LogState</span><span class="o">.</span><span class="n">COMPLETE</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_description</span> <span class="o">=</span> <span class="n">description</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_describe_job_call</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log_resource_inited</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="SageMakerTrainingSensor.non_terminal_states"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/sagemaker_training_sensor/index.html#airflow.contrib.sensors.sagemaker_training_sensor.SageMakerTrainingSensor.non_terminal_states">[docs]</a> <span class="k">def</span> <span class="nf">non_terminal_states</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">SageMakerHook</span><span class="o">.</span><span class="n">non_terminal_states</span></div>
<div class="viewcode-block" id="SageMakerTrainingSensor.failed_states"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/sagemaker_training_sensor/index.html#airflow.contrib.sensors.sagemaker_training_sensor.SageMakerTrainingSensor.failed_states">[docs]</a> <span class="k">def</span> <span class="nf">failed_states</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">SageMakerHook</span><span class="o">.</span><span class="n">failed_states</span></div>
<div class="viewcode-block" id="SageMakerTrainingSensor.get_sagemaker_response"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/sagemaker_training_sensor/index.html#airflow.contrib.sensors.sagemaker_training_sensor.SageMakerTrainingSensor.get_sagemaker_response">[docs]</a> <span class="k">def</span> <span class="nf">get_sagemaker_response</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">sagemaker_hook</span> <span class="o">=</span> <span class="n">SageMakerHook</span><span class="p">(</span><span class="n">aws_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">print_log</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_resource_inited</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">init_log_resource</span><span class="p">(</span><span class="n">sagemaker_hook</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">state</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_description</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_describe_job_call</span> <span class="o">=</span> \
<span class="n">sagemaker_hook</span><span class="o">.</span><span class="n">describe_training_job_with_log</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">job_name</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">positions</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">stream_names</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">instance_count</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">state</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_description</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_describe_job_call</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">last_description</span> <span class="o">=</span> <span class="n">sagemaker_hook</span><span class="o">.</span><span class="n">describe_training_job</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">job_name</span><span class="p">)</span>
<span class="n">status</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">state_from_response</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">last_description</span><span class="p">)</span>
<span class="k">if</span> <span class="n">status</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">non_terminal_states</span><span class="p">()</span> <span class="ow">and</span> <span class="n">status</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">failed_states</span><span class="p">():</span>
<span class="n">billable_time</span> <span class="o">=</span> \
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">last_description</span><span class="p">[</span><span class="s1">&#39;TrainingEndTime&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_description</span><span class="p">[</span><span class="s1">&#39;TrainingStartTime&#39;</span><span class="p">])</span> <span class="o">*</span> \
<span class="bp">self</span><span class="o">.</span><span class="n">last_description</span><span class="p">[</span><span class="s1">&#39;ResourceConfig&#39;</span><span class="p">][</span><span class="s1">&#39;InstanceCount&#39;</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Billable seconds: </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">billable_time</span><span class="o">.</span><span class="n">total_seconds</span><span class="p">())</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_description</span></div>
<div class="viewcode-block" id="SageMakerTrainingSensor.get_failed_reason_from_response"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/sagemaker_training_sensor/index.html#airflow.contrib.sensors.sagemaker_training_sensor.SageMakerTrainingSensor.get_failed_reason_from_response">[docs]</a> <span class="k">def</span> <span class="nf">get_failed_reason_from_response</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">):</span>
<span class="k">return</span> <span class="n">response</span><span class="p">[</span><span class="s1">&#39;FailureReason&#39;</span><span class="p">]</span></div>
<div class="viewcode-block" id="SageMakerTrainingSensor.state_from_response"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/sagemaker_training_sensor/index.html#airflow.contrib.sensors.sagemaker_training_sensor.SageMakerTrainingSensor.state_from_response">[docs]</a> <span class="k">def</span> <span class="nf">state_from_response</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">):</span>
<span class="k">return</span> <span class="n">response</span><span class="p">[</span><span class="s1">&#39;TrainingJobStatus&#39;</span><span class="p">]</span></div></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
<div class="footer">This page uses <a href="https://analytics.google.com/">
Google Analytics</a> to collect statistics. You can disable it by blocking
the JavaScript coming from www.google-analytics.com. Check our
<a href="../../../../privacy_notice.html">Privacy Policy</a>
for more details.
<script type="text/javascript">
(function() {
var ga = document.createElement('script');
ga.src = ('https:' == document.location.protocol ?
'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
ga.setAttribute('async', 'true');
var nodes = document.documentElement.childNodes;
var i = -1;
var node;
do {
i++;
node = nodes[i]
} while(node.nodeType !== Node.ELEMENT_NODE);
node.appendChild(ga);
})();
</script>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>