http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/1f06fa0e/_modules/airflow/contrib/operators/sagemaker_endpoint_operator.html ---------------------------------------------------------------------- diff --git a/_modules/airflow/contrib/operators/sagemaker_endpoint_operator.html b/_modules/airflow/contrib/operators/sagemaker_endpoint_operator.html new file mode 100644 index 0000000..563ec94 --- /dev/null +++ b/_modules/airflow/contrib/operators/sagemaker_endpoint_operator.html @@ -0,0 +1,362 @@ + + +<!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.operators.sagemaker_endpoint_operator — Airflow Documentation</title> + + + + + + + + + + + + + + + + <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 src="../../../../_static/js/modernizr.min.js"></script> + +</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 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</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling & 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">Experimental Rest API</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="../../../../lineage.html">Lineage</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="../../../../code.html">API Reference</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> »</li> + + <li><a href="../../../index.html">Module code</a> »</li> + + <li>airflow.contrib.operators.sagemaker_endpoint_operator</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.operators.sagemaker_endpoint_operator</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"># "License"); 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"># "AS IS" 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">from</span> <span class="nn">airflow.contrib.hooks.aws_hook</span> <span class="k">import</span> <span class="n">AwsHook</span> +<span class="kn">from</span> <span class="nn">airflow.contrib.operators.sagemaker_base_operator</span> <span class="k">import</span> <span class="n">SageMakerBaseOperator</span> +<span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span> +<span class="kn">from</span> <span class="nn">airflow.exceptions</span> <span class="k">import</span> <span class="n">AirflowException</span> + + +<div class="viewcode-block" id="SageMakerEndpointOperator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.sagemaker_endpoint_operator.SageMakerEndpointOperator">[docs]</a><span class="k">class</span> <span class="nc">SageMakerEndpointOperator</span><span class="p">(</span><span class="n">SageMakerBaseOperator</span><span class="p">):</span> + + <span class="sd">"""</span> +<span class="sd"> Create a SageMaker endpoint.</span> + +<span class="sd"> This operator returns The ARN of the endpoint created in Amazon SageMaker</span> + +<span class="sd"> :param config:</span> +<span class="sd"> The configuration necessary to create an endpoint.</span> + +<span class="sd"> If you need to create a SageMaker endpoint based on an existed SageMaker model and an existed SageMaker</span> +<span class="sd"> endpoint config,</span> + +<span class="sd"> config = endpoint_configuration;</span> + +<span class="sd"> If you need to create all of SageMaker model, SageMaker endpoint-config and SageMaker endpoint,</span> + +<span class="sd"> config = {</span> +<span class="sd"> 'Model': model_configuration,</span> + +<span class="sd"> 'EndpointConfig': endpoint_config_configuration,</span> + +<span class="sd"> 'Endpoint': endpoint_configuration</span> +<span class="sd"> }</span> + +<span class="sd"> For details of the configuration parameter of model_configuration, See:</span> +<span class="sd"> https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sagemaker.html#SageMaker.Client.create_model</span> + +<span class="sd"> For details of the configuration parameter of endpoint_config_configuration, See:</span> +<span class="sd"> https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sagemaker.html#SageMaker.Client.create_endpoint_config</span> + +<span class="sd"> For details of the configuration parameter of endpoint_configuration, See:</span> +<span class="sd"> https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sagemaker.html#SageMaker.Client.create_endpoint</span> +<span class="sd"> :type config: dict</span> +<span class="sd"> :param aws_conn_id: The AWS connection ID to use.</span> +<span class="sd"> :type aws_conn_id: str</span> +<span class="sd"> :param wait_for_completion: Whether the operator should wait until the endpoint creation finishes.</span> +<span class="sd"> :type wait_for_completion: bool</span> +<span class="sd"> :param check_interval: If wait is set to True, this is the time interval, in seconds, that this operation waits</span> +<span class="sd"> before polling the status of the endpoint creation.</span> +<span class="sd"> :type check_interval: int</span> +<span class="sd"> :param max_ingestion_time: If wait is set to True, this operation fails if the endpoint creation doesn't finish</span> +<span class="sd"> within max_ingestion_time seconds. If you set this parameter to None it never times out.</span> +<span class="sd"> :type max_ingestion_time: int</span> +<span class="sd"> :param operation: Whether to create an endpoint or update an endpoint. Must be either 'create or 'update'.</span> +<span class="sd"> :type operation: str</span> +<span class="sd"> """</span> <span class="c1"># noqa: E501</span> + + <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">config</span><span class="p">,</span> + <span class="n">wait_for_completion</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> + <span class="n">check_interval</span><span class="o">=</span><span class="mi">30</span><span class="p">,</span> + <span class="n">max_ingestion_time</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> + <span class="n">operation</span><span class="o">=</span><span class="s1">'create'</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">SageMakerEndpointOperator</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="n">config</span><span class="o">=</span><span class="n">config</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">config</span> <span class="o">=</span> <span class="n">config</span> + <span class="bp">self</span><span class="o">.</span><span class="n">wait_for_completion</span> <span class="o">=</span> <span class="n">wait_for_completion</span> + <span class="bp">self</span><span class="o">.</span><span class="n">check_interval</span> <span class="o">=</span> <span class="n">check_interval</span> + <span class="bp">self</span><span class="o">.</span><span class="n">max_ingestion_time</span> <span class="o">=</span> <span class="n">max_ingestion_time</span> + <span class="bp">self</span><span class="o">.</span><span class="n">operation</span> <span class="o">=</span> <span class="n">operation</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">operation</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'create'</span><span class="p">,</span> <span class="s1">'update'</span><span class="p">]:</span> + <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Invalid value! Argument operation has to be one of "create" and "update"'</span><span class="p">)</span> + <span class="bp">self</span><span class="o">.</span><span class="n">create_integer_fields</span><span class="p">()</span> + + <span class="k">def</span> <span class="nf">create_integer_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="k">if</span> <span class="s1">'EndpointConfig'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">:</span> + <span class="bp">self</span><span class="o">.</span><span class="n">integer_fields</span> <span class="o">=</span> <span class="p">[</span> + <span class="p">[</span><span class="s1">'EndpointConfig'</span><span class="p">,</span> <span class="s1">'ProductionVariants'</span><span class="p">,</span> <span class="s1">'InitialInstanceCount'</span><span class="p">]</span> + <span class="p">]</span> + + <span class="k">def</span> <span class="nf">expand_role</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="k">if</span> <span class="s1">'Model'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">:</span> + <span class="k">return</span> + <span class="n">hook</span> <span class="o">=</span> <span class="n">AwsHook</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span><span class="p">)</span> + <span class="n">config</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'Model'</span><span class="p">]</span> + <span class="k">if</span> <span class="s1">'ExecutionRoleArn'</span> <span class="ow">in</span> <span class="n">config</span><span class="p">:</span> + <span class="n">config</span><span class="p">[</span><span class="s1">'ExecutionRoleArn'</span><span class="p">]</span> <span class="o">=</span> <span class="n">hook</span><span class="o">.</span><span class="n">expand_role</span><span class="p">(</span><span class="n">config</span><span class="p">[</span><span class="s1">'ExecutionRoleArn'</span><span class="p">])</span> + +<div class="viewcode-block" id="SageMakerEndpointOperator.execute"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.sagemaker_endpoint_operator.SageMakerEndpointOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">preprocess_config</span><span class="p">()</span> + + <span class="n">model_info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Model'</span><span class="p">)</span> + <span class="n">endpoint_config_info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'EndpointConfig'</span><span class="p">)</span> + <span class="n">endpoint_info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Endpoint'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span> + + <span class="k">if</span> <span class="n">model_info</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">'Creating SageMaker model </span><span class="si">%s</span><span class="s1">.'</span><span class="p">,</span> <span class="n">model_info</span><span class="p">[</span><span class="s1">'ModelName'</span><span class="p">])</span> + <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">create_model</span><span class="p">(</span><span class="n">model_info</span><span class="p">)</span> + + <span class="k">if</span> <span class="n">endpoint_config_info</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">'Creating endpoint config </span><span class="si">%s</span><span class="s1">.'</span><span class="p">,</span> <span class="n">endpoint_config_info</span><span class="p">[</span><span class="s1">'EndpointConfigName'</span><span class="p">])</span> + <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">create_endpoint_config</span><span class="p">(</span><span class="n">endpoint_config_info</span><span class="p">)</span> + + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">operation</span> <span class="o">==</span> <span class="s1">'create'</span><span class="p">:</span> + <span class="n">sagemaker_operation</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">create_endpoint</span> + <span class="n">log_str</span> <span class="o">=</span> <span class="s1">'Creating'</span> + <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">operation</span> <span class="o">==</span> <span class="s1">'update'</span><span class="p">:</span> + <span class="n">sagemaker_operation</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">update_endpoint</span> + <span class="n">log_str</span> <span class="o">=</span> <span class="s1">'Updating'</span> + <span class="k">else</span><span class="p">:</span> + <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Invalid value! Argument operation has to be one of "create" and "update"'</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">'</span><span class="si">{}</span><span class="s1"> SageMaker endpoint </span><span class="si">{}</span><span class="s1">.'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">log_str</span><span class="p">,</span> <span class="n">endpoint_info</span><span class="p">[</span><span class="s1">'EndpointName'</span><span class="p">]))</span> + + <span class="n">response</span> <span class="o">=</span> <span class="n">sagemaker_operation</span><span class="p">(</span> + <span class="n">endpoint_info</span><span class="p">,</span> + <span class="n">wait_for_completion</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">wait_for_completion</span><span class="p">,</span> + <span class="n">check_interval</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">check_interval</span><span class="p">,</span> + <span class="n">max_ingestion_time</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">max_ingestion_time</span> + <span class="p">)</span> + <span class="k">if</span> <span class="n">response</span><span class="p">[</span><span class="s1">'ResponseMetadata'</span><span class="p">][</span><span class="s1">'HTTPStatusCode'</span><span class="p">]</span> <span class="o">!=</span> <span class="mi">200</span><span class="p">:</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> + <span class="s1">'Sagemaker endpoint creation failed: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">response</span><span class="p">)</span> + <span class="k">else</span><span class="p">:</span> + <span class="k">return</span> <span class="p">{</span> + <span class="s1">'EndpointConfig'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">describe_endpoint_config</span><span class="p">(</span> + <span class="n">endpoint_info</span><span class="p">[</span><span class="s1">'EndpointConfigName'</span><span class="p">]</span> + <span class="p">),</span> + <span class="s1">'Endpoint'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">describe_endpoint</span><span class="p">(</span> + <span class="n">endpoint_info</span><span class="p">[</span><span class="s1">'EndpointName'</span><span class="p">]</span> + <span class="p">)</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>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + + + <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/js/theme.js"></script> + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/1f06fa0e/_modules/airflow/contrib/operators/sagemaker_model_operator.html ---------------------------------------------------------------------- diff --git a/_modules/airflow/contrib/operators/sagemaker_model_operator.html b/_modules/airflow/contrib/operators/sagemaker_model_operator.html new file mode 100644 index 0000000..5cfd172 --- /dev/null +++ b/_modules/airflow/contrib/operators/sagemaker_model_operator.html @@ -0,0 +1,279 @@ + + +<!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.operators.sagemaker_model_operator — Airflow Documentation</title> + + + + + + + + + + + + + + + + <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 src="../../../../_static/js/modernizr.min.js"></script> + +</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 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</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling & 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">Experimental Rest API</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="../../../../lineage.html">Lineage</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="../../../../code.html">API Reference</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> »</li> + + <li><a href="../../../index.html">Module code</a> »</li> + + <li>airflow.contrib.operators.sagemaker_model_operator</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.operators.sagemaker_model_operator</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"># "License"); 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"># "AS IS" 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">from</span> <span class="nn">airflow.contrib.hooks.aws_hook</span> <span class="k">import</span> <span class="n">AwsHook</span> +<span class="kn">from</span> <span class="nn">airflow.contrib.operators.sagemaker_base_operator</span> <span class="k">import</span> <span class="n">SageMakerBaseOperator</span> +<span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span> +<span class="kn">from</span> <span class="nn">airflow.exceptions</span> <span class="k">import</span> <span class="n">AirflowException</span> + + +<div class="viewcode-block" id="SageMakerModelOperator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.sagemaker_model_operator.SageMakerModelOperator">[docs]</a><span class="k">class</span> <span class="nc">SageMakerModelOperator</span><span class="p">(</span><span class="n">SageMakerBaseOperator</span><span class="p">):</span> + + <span class="sd">"""</span> +<span class="sd"> Create a SageMaker model.</span> + +<span class="sd"> This operator returns The ARN of the model created in Amazon SageMaker</span> + +<span class="sd"> :param config: The configuration necessary to create a model.</span> + +<span class="sd"> For details of the configuration parameter, See:</span> +<span class="sd"> https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sagemaker.html#SageMaker.Client.create_model</span> +<span class="sd"> :type config: dict</span> +<span class="sd"> :param aws_conn_id: The AWS connection ID to use.</span> +<span class="sd"> :type aws_conn_id: str</span> +<span class="sd"> """</span> <span class="c1"># noqa: E501</span> + + <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">config</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">SageMakerModelOperator</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="n">config</span><span class="o">=</span><span class="n">config</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">config</span> <span class="o">=</span> <span class="n">config</span> + + <span class="k">def</span> <span class="nf">expand_role</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="k">if</span> <span class="s1">'ExecutionRoleArn'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">:</span> + <span class="n">hook</span> <span class="o">=</span> <span class="n">AwsHook</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span><span class="p">)</span> + <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'ExecutionRoleArn'</span><span class="p">]</span> <span class="o">=</span> <span class="n">hook</span><span class="o">.</span><span class="n">expand_role</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'ExecutionRoleArn'</span><span class="p">])</span> + +<div class="viewcode-block" id="SageMakerModelOperator.execute"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.sagemaker_model_operator.SageMakerModelOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">preprocess_config</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">'Creating SageMaker Model </span><span class="si">%s</span><span class="s1">.'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'ModelName'</span><span class="p">])</span> + <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">create_model</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span> + <span class="k">if</span> <span class="n">response</span><span class="p">[</span><span class="s1">'ResponseMetadata'</span><span class="p">][</span><span class="s1">'HTTPStatusCode'</span><span class="p">]</span> <span class="o">!=</span> <span class="mi">200</span><span class="p">:</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">'Sagemaker model creation failed: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">response</span><span class="p">)</span> + <span class="k">else</span><span class="p">:</span> + <span class="k">return</span> <span class="p">{</span> + <span class="s1">'Model'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">describe_model</span><span class="p">(</span> + <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'ModelName'</span><span class="p">]</span> + <span class="p">)</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>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + + + <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/js/theme.js"></script> + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/1f06fa0e/_modules/airflow/contrib/operators/sagemaker_training_operator.html ---------------------------------------------------------------------- diff --git a/_modules/airflow/contrib/operators/sagemaker_training_operator.html b/_modules/airflow/contrib/operators/sagemaker_training_operator.html new file mode 100644 index 0000000..1f9e55c --- /dev/null +++ b/_modules/airflow/contrib/operators/sagemaker_training_operator.html @@ -0,0 +1,310 @@ + + +<!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.operators.sagemaker_training_operator — Airflow Documentation</title> + + + + + + + + + + + + + + + + <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 src="../../../../_static/js/modernizr.min.js"></script> + +</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 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</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling & 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">Experimental Rest API</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="../../../../lineage.html">Lineage</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="../../../../code.html">API Reference</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> »</li> + + <li><a href="../../../index.html">Module code</a> »</li> + + <li>airflow.contrib.operators.sagemaker_training_operator</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.operators.sagemaker_training_operator</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"># "License"); 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"># "AS IS" 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">from</span> <span class="nn">airflow.contrib.hooks.aws_hook</span> <span class="k">import</span> <span class="n">AwsHook</span> +<span class="kn">from</span> <span class="nn">airflow.contrib.operators.sagemaker_base_operator</span> <span class="k">import</span> <span class="n">SageMakerBaseOperator</span> +<span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span> +<span class="kn">from</span> <span class="nn">airflow.exceptions</span> <span class="k">import</span> <span class="n">AirflowException</span> + + +<div class="viewcode-block" id="SageMakerTrainingOperator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.sagemaker_training_operator.SageMakerTrainingOperator">[docs]</a><span class="k">class</span> <span class="nc">SageMakerTrainingOperator</span><span class="p">(</span><span class="n">SageMakerBaseOperator</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Initiate a SageMaker training job.</span> + +<span class="sd"> This operator returns The ARN of the training job created in Amazon SageMaker.</span> + +<span class="sd"> :param config: The configuration necessary to start a training job (templated).</span> + +<span class="sd"> For details of the configuration parameter, See:</span> +<span class="sd"> https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sagemaker.html#SageMaker.Client.create_training_job</span> +<span class="sd"> :type config: dict</span> +<span class="sd"> :param aws_conn_id: The AWS connection ID to use.</span> +<span class="sd"> :type aws_conn_id: str</span> +<span class="sd"> :param wait_for_completion: If wait is set to True, the time interval, in seconds,</span> +<span class="sd"> that the operation waits to check the status of the training job.</span> +<span class="sd"> :type wait_for_completion: bool</span> +<span class="sd"> :param print_log: if the operator should print the cloudwatch log during training</span> +<span class="sd"> :type print_log: bool</span> +<span class="sd"> :param check_interval: if wait is set to be true, this is the time interval</span> +<span class="sd"> in seconds which the operator will check the status of the training job</span> +<span class="sd"> :type check_interval: int</span> +<span class="sd"> :param max_ingestion_time: If wait is set to True, the operation fails if the training job</span> +<span class="sd"> doesn't finish within max_ingestion_time seconds. If you set this parameter to None,</span> +<span class="sd"> the operation does not timeout.</span> +<span class="sd"> :type max_ingestion_time: int</span> +<span class="sd"> """</span> <span class="c1"># noqa: E501</span> + + <span class="n">integer_fields</span> <span class="o">=</span> <span class="p">[</span> + <span class="p">[</span><span class="s1">'ResourceConfig'</span><span class="p">,</span> <span class="s1">'InstanceCount'</span><span class="p">],</span> + <span class="p">[</span><span class="s1">'ResourceConfig'</span><span class="p">,</span> <span class="s1">'VolumeSizeInGB'</span><span class="p">],</span> + <span class="p">[</span><span class="s1">'StoppingCondition'</span><span class="p">,</span> <span class="s1">'MaxRuntimeInSeconds'</span><span class="p">]</span> + <span class="p">]</span> + + <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">config</span><span class="p">,</span> + <span class="n">wait_for_completion</span><span class="o">=</span><span class="kc">True</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="n">check_interval</span><span class="o">=</span><span class="mi">30</span><span class="p">,</span> + <span class="n">max_ingestion_time</span><span class="o">=</span><span class="kc">None</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">SageMakerTrainingOperator</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="n">config</span><span class="o">=</span><span class="n">config</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">wait_for_completion</span> <span class="o">=</span> <span class="n">wait_for_completion</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">check_interval</span> <span class="o">=</span> <span class="n">check_interval</span> + <span class="bp">self</span><span class="o">.</span><span class="n">max_ingestion_time</span> <span class="o">=</span> <span class="n">max_ingestion_time</span> + + <span class="k">def</span> <span class="nf">expand_role</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="k">if</span> <span class="s1">'RoleArn'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">:</span> + <span class="n">hook</span> <span class="o">=</span> <span class="n">AwsHook</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span><span class="p">)</span> + <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'RoleArn'</span><span class="p">]</span> <span class="o">=</span> <span class="n">hook</span><span class="o">.</span><span class="n">expand_role</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'RoleArn'</span><span class="p">])</span> + +<div class="viewcode-block" id="SageMakerTrainingOperator.execute"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.sagemaker_training_operator.SageMakerTrainingOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">preprocess_config</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">'Creating SageMaker Training Job </span><span class="si">%s</span><span class="s1">.'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'TrainingJobName'</span><span class="p">])</span> + + <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">create_training_job</span><span class="p">(</span> + <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> + <span class="n">wait_for_completion</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">wait_for_completion</span><span class="p">,</span> + <span class="n">print_log</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">print_log</span><span class="p">,</span> + <span class="n">check_interval</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">check_interval</span><span class="p">,</span> + <span class="n">max_ingestion_time</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">max_ingestion_time</span> + <span class="p">)</span> + <span class="k">if</span> <span class="n">response</span><span class="p">[</span><span class="s1">'ResponseMetadata'</span><span class="p">][</span><span class="s1">'HTTPStatusCode'</span><span class="p">]</span> <span class="o">!=</span> <span class="mi">200</span><span class="p">:</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">'Sagemaker Training Job creation failed: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">response</span><span class="p">)</span> + <span class="k">else</span><span class="p">:</span> + <span class="k">return</span> <span class="p">{</span> + <span class="s1">'Training'</span><span class="p">:</span> <span class="bp">self</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">config</span><span class="p">[</span><span class="s1">'TrainingJobName'</span><span class="p">]</span> + <span class="p">)</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>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + + + <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/js/theme.js"></script> + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/1f06fa0e/_modules/airflow/contrib/operators/sagemaker_transform_operator.html ---------------------------------------------------------------------- diff --git a/_modules/airflow/contrib/operators/sagemaker_transform_operator.html b/_modules/airflow/contrib/operators/sagemaker_transform_operator.html new file mode 100644 index 0000000..962a169 --- /dev/null +++ b/_modules/airflow/contrib/operators/sagemaker_transform_operator.html @@ -0,0 +1,336 @@ + + +<!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.operators.sagemaker_transform_operator — Airflow Documentation</title> + + + + + + + + + + + + + + + + <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 src="../../../../_static/js/modernizr.min.js"></script> + +</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 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</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling & 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">Experimental Rest API</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="../../../../lineage.html">Lineage</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="../../../../code.html">API Reference</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> »</li> + + <li><a href="../../../index.html">Module code</a> »</li> + + <li>airflow.contrib.operators.sagemaker_transform_operator</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.operators.sagemaker_transform_operator</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"># "License"); 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"># "AS IS" 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">from</span> <span class="nn">airflow.contrib.hooks.aws_hook</span> <span class="k">import</span> <span class="n">AwsHook</span> +<span class="kn">from</span> <span class="nn">airflow.contrib.operators.sagemaker_base_operator</span> <span class="k">import</span> <span class="n">SageMakerBaseOperator</span> +<span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span> +<span class="kn">from</span> <span class="nn">airflow.exceptions</span> <span class="k">import</span> <span class="n">AirflowException</span> + + +<div class="viewcode-block" id="SageMakerTransformOperator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.sagemaker_transform_operator.SageMakerTransformOperator">[docs]</a><span class="k">class</span> <span class="nc">SageMakerTransformOperator</span><span class="p">(</span><span class="n">SageMakerBaseOperator</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Initiate a SageMaker transform job.</span> + +<span class="sd"> This operator returns The ARN of the model created in Amazon SageMaker.</span> + +<span class="sd"> :param config: The configuration necessary to start a transform job (templated).</span> + +<span class="sd"> If you need to create a SageMaker transform job based on an existed SageMaker model,</span> + +<span class="sd"> config = transform_config;</span> + +<span class="sd"> If you need to create both SageMaker model and SageMaker Transform job,</span> + +<span class="sd"> config = {</span> +<span class="sd"> 'Model': model_config,</span> + +<span class="sd"> 'Transform': transform_config</span> +<span class="sd"> }</span> + +<span class="sd"> For details of the configuration parameter of transform_config, See:</span> +<span class="sd"> https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sagemaker.html#SageMaker.Client.create_transform_job</span> + +<span class="sd"> For details of the configuration parameter of model_config, See:</span> +<span class="sd"> https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sagemaker.html#SageMaker.Client.create_model</span> + +<span class="sd"> :type config: dict</span> +<span class="sd"> :param aws_conn_id: The AWS connection ID to use.</span> +<span class="sd"> :type aws_conn_id: string</span> +<span class="sd"> :param wait_for_completion: Set to True to wait until the transform job finishes.</span> +<span class="sd"> :type wait_for_completion: bool</span> +<span class="sd"> :param check_interval: If wait is set to True, the time interval, in seconds,</span> +<span class="sd"> that this operation waits to check the status of the transform job.</span> +<span class="sd"> :type check_interval: int</span> +<span class="sd"> :param max_ingestion_time: If wait is set to True, the operation fails</span> +<span class="sd"> if the transform job doesn't finish within max_ingestion_time seconds. If you</span> +<span class="sd"> set this parameter to None, the operation does not timeout.</span> +<span class="sd"> :type max_ingestion_time: int</span> +<span class="sd"> """</span> <span class="c1"># noqa: E501</span> + + <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">config</span><span class="p">,</span> + <span class="n">wait_for_completion</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> + <span class="n">check_interval</span><span class="o">=</span><span class="mi">30</span><span class="p">,</span> + <span class="n">max_ingestion_time</span><span class="o">=</span><span class="kc">None</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">SageMakerTransformOperator</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="n">config</span><span class="o">=</span><span class="n">config</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">config</span> <span class="o">=</span> <span class="n">config</span> + <span class="bp">self</span><span class="o">.</span><span class="n">wait_for_completion</span> <span class="o">=</span> <span class="n">wait_for_completion</span> + <span class="bp">self</span><span class="o">.</span><span class="n">check_interval</span> <span class="o">=</span> <span class="n">check_interval</span> + <span class="bp">self</span><span class="o">.</span><span class="n">max_ingestion_time</span> <span class="o">=</span> <span class="n">max_ingestion_time</span> + <span class="bp">self</span><span class="o">.</span><span class="n">create_integer_fields</span><span class="p">()</span> + + <span class="k">def</span> <span class="nf">create_integer_fields</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">integer_fields</span> <span class="o">=</span> <span class="p">[</span> + <span class="p">[</span><span class="s1">'Transform'</span><span class="p">,</span> <span class="s1">'TransformResources'</span><span class="p">,</span> <span class="s1">'InstanceCount'</span><span class="p">],</span> + <span class="p">[</span><span class="s1">'Transform'</span><span class="p">,</span> <span class="s1">'MaxConcurrentTransforms'</span><span class="p">],</span> + <span class="p">[</span><span class="s1">'Transform'</span><span class="p">,</span> <span class="s1">'MaxPayloadInMB'</span><span class="p">]</span> + <span class="p">]</span> + <span class="k">if</span> <span class="s1">'Transform'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">:</span> + <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">integer_fields</span><span class="p">:</span> + <span class="n">field</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> + + <span class="k">def</span> <span class="nf">expand_role</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="k">if</span> <span class="s1">'Model'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">:</span> + <span class="k">return</span> + <span class="n">config</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'Model'</span><span class="p">]</span> + <span class="k">if</span> <span class="s1">'ExecutionRoleArn'</span> <span class="ow">in</span> <span class="n">config</span><span class="p">:</span> + <span class="n">hook</span> <span class="o">=</span> <span class="n">AwsHook</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span><span class="p">)</span> + <span class="n">config</span><span class="p">[</span><span class="s1">'ExecutionRoleArn'</span><span class="p">]</span> <span class="o">=</span> <span class="n">hook</span><span class="o">.</span><span class="n">expand_role</span><span class="p">(</span><span class="n">config</span><span class="p">[</span><span class="s1">'ExecutionRoleArn'</span><span class="p">])</span> + +<div class="viewcode-block" id="SageMakerTransformOperator.execute"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.sagemaker_transform_operator.SageMakerTransformOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">preprocess_config</span><span class="p">()</span> + + <span class="n">model_config</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Model'</span><span class="p">)</span> + <span class="n">transform_config</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Transform'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span> + + <span class="k">if</span> <span class="n">model_config</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">'Creating SageMaker Model </span><span class="si">%s</span><span class="s1"> for transform job'</span><span class="p">,</span> <span class="n">model_config</span><span class="p">[</span><span class="s1">'ModelName'</span><span class="p">])</span> + <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">create_model</span><span class="p">(</span><span class="n">model_config</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">'Creating SageMaker transform Job </span><span class="si">%s</span><span class="s1">.'</span><span class="p">,</span> <span class="n">transform_config</span><span class="p">[</span><span class="s1">'TransformJobName'</span><span class="p">])</span> + <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">create_transform_job</span><span class="p">(</span> + <span class="n">transform_config</span><span class="p">,</span> + <span class="n">wait_for_completion</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">wait_for_completion</span><span class="p">,</span> + <span class="n">check_interval</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">check_interval</span><span class="p">,</span> + <span class="n">max_ingestion_time</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">max_ingestion_time</span><span class="p">)</span> + <span class="k">if</span> <span class="n">response</span><span class="p">[</span><span class="s1">'ResponseMetadata'</span><span class="p">][</span><span class="s1">'HTTPStatusCode'</span><span class="p">]</span> <span class="o">!=</span> <span class="mi">200</span><span class="p">:</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">'Sagemaker transform Job creation failed: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">response</span><span class="p">)</span> + <span class="k">else</span><span class="p">:</span> + <span class="k">return</span> <span class="p">{</span> + <span class="s1">'Model'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">describe_model</span><span class="p">(</span> + <span class="n">transform_config</span><span class="p">[</span><span class="s1">'ModelName'</span><span class="p">]</span> + <span class="p">),</span> + <span class="s1">'Transform'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">describe_transform_job</span><span class="p">(</span> + <span class="n">transform_config</span><span class="p">[</span><span class="s1">'TransformJobName'</span><span class="p">]</span> + <span class="p">)</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>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + + + <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/js/theme.js"></script> + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html> \ No newline at end of file
