Docs created (#337)

flyteorg · Jun 2, 2020 · b539711 · b539711
1 parent 2f0c4a3
commit b539711
Show file tree

Hide file tree

Showing 263 changed files with 2,150 additions and 461 deletions.
diff --git a/_modules/abc.html b/_modules/abc.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>abc &mdash; Flyte 0.3.0 documentation</title>
+  <title>abc &mdash; Flyte 0.4.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clients/friendly.html b/_modules/flytekit/clients/friendly.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clients.friendly &mdash; Flyte 0.3.0 documentation</title>
+  <title>flytekit.clients.friendly &mdash; Flyte 0.4.0 documentation</title>
 
 
 
@@ -163,16 +163,26 @@ <h1>Source code for flytekit.clients.friendly</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">flyteidl.admin</span> <span class="k">import</span> <span class="n">task_pb2</span> <span class="k">as</span> <span class="n">_task_pb2</span><span class="p">,</span> <span class="n">common_pb2</span> <span class="k">as</span> <span class="n">_common_pb2</span><span class="p">,</span> <span class="n">workflow_pb2</span> <span class="k">as</span> <span class="n">_workflow_pb2</span><span class="p">,</span> \
     <span class="n">launch_plan_pb2</span> <span class="k">as</span> <span class="n">_launch_plan_pb2</span><span class="p">,</span> <span class="n">execution_pb2</span> <span class="k">as</span> <span class="n">_execution_pb2</span><span class="p">,</span> <span class="n">node_execution_pb2</span> <span class="k">as</span> <span class="n">_node_execution_pb2</span><span class="p">,</span> \
     <span class="n">task_execution_pb2</span> <span class="k">as</span> <span class="n">_task_execution_pb2</span><span class="p">,</span> <span class="n">project_pb2</span> <span class="k">as</span> <span class="n">_project_pb2</span>
+<span class="kn">from</span> <span class="nn">flyteidl.core</span> <span class="k">import</span> <span class="n">identifier_pb2</span> <span class="k">as</span> <span class="n">_identifier_pb2</span>
 
 <span class="kn">from</span> <span class="nn">flytekit.clients.raw</span> <span class="k">import</span> <span class="n">RawSynchronousFlyteClient</span> <span class="k">as</span> <span class="n">_RawSynchronousFlyteClient</span>
 <span class="kn">from</span> <span class="nn">flytekit.models</span> <span class="k">import</span> <span class="n">filters</span> <span class="k">as</span> <span class="n">_filters</span><span class="p">,</span> <span class="n">common</span> <span class="k">as</span> <span class="n">_common</span><span class="p">,</span> <span class="n">launch_plan</span> <span class="k">as</span> <span class="n">_launch_plan</span><span class="p">,</span> <span class="n">task</span> <span class="k">as</span> <span class="n">_task</span><span class="p">,</span> \
     <span class="n">execution</span> <span class="k">as</span> <span class="n">_execution</span><span class="p">,</span> <span class="n">node_execution</span> <span class="k">as</span> <span class="n">_node_execution</span>
 <span class="kn">from</span> <span class="nn">flytekit.models.core</span> <span class="k">import</span> <span class="n">identifier</span> <span class="k">as</span> <span class="n">_identifier</span>
 <span class="kn">from</span> <span class="nn">flytekit.models.admin</span> <span class="k">import</span> <span class="n">workflow</span> <span class="k">as</span> <span class="n">_workflow</span><span class="p">,</span> <span class="n">task_execution</span> <span class="k">as</span> <span class="n">_task_execution</span>
+<span class="kn">from</span> <span class="nn">flytekit.common.exceptions.user</span> <span class="k">import</span> <span class="n">FlyteAssertion</span> <span class="k">as</span> <span class="n">_FlyteAssertion</span>
 
 
 <div class="viewcode-block" id="SynchronousFlyteClient"><a class="viewcode-back" href="../../../flytekit/flytekit.clients.html#flytekit.clients.friendly.SynchronousFlyteClient">[docs]</a><span class="k">class</span> <span class="nc">SynchronousFlyteClient</span><span class="p">(</span><span class="n">_RawSynchronousFlyteClient</span><span class="p">):</span>
 
+    <span class="nd">@property</span>
+    <span class="k">def</span> <span class="nf">raw</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Gives access to the raw client</span>
+<span class="sd">        :rtype: flytekit.clients.raw.RawSynchronousFlyteClient</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">SynchronousFlyteClient</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>
+
     <span class="c1">####################################################################################################################</span>
     <span class="c1">#</span>
     <span class="c1">#  Task Endpoints</span>
@@ -344,9 +354,6 @@ <h1>Source code for flytekit.clients.friendly</h1><div class="highlight"><pre>
 <span class="sd">            remains identical, calling this method multiple times will result in success.</span>
 
 <span class="sd">        :param: flytekit.models.core.identifier.Identifier workflow_identifier: The identifier for this workflow.</span>
-<span class="sd">        :param: Text version: The version identifier of this workflow. Used to distinguish between different iterations</span>
-<span class="sd">            of tasks with the same name. If any aspect of the underlying workflow definition changes, then the version</span>
-<span class="sd">            must also change to be accepted by the Flyte Admin Service.</span>
 <span class="sd">        :param: flytekit.models.admin.workflow.WorkflowSpec workflow_spec: This is the actual definition of the workflow</span>
 <span class="sd">            that should be created.</span>
 <span class="sd">        :raises flytekit.common.exceptions.user.FlyteEntityAlreadyExistsException: If an identical version of the</span>
@@ -497,9 +504,6 @@ <h1>Source code for flytekit.clients.friendly</h1><div class="highlight"><pre>
 <span class="sd">            remains identical, calling this method multiple times will result in success.</span>
 
 <span class="sd">        :param: flytekit.models.core.identifier.Identifier launch_plan_identifer: The identifier for this launch plan.</span>
-<span class="sd">        :param: Text version: The version identifier of this launch plan. Used to distinguish between different</span>
-<span class="sd">            iterations of tasks with the same name. If any aspect of the underlying launch plan definition changes,</span>
-<span class="sd">            then the version must also change to be accepted by the Flyte Admin Service.</span>
 <span class="sd">        :param: flytekit.models.launch_plan.LaunchPlanSpec launch_plan_spec: This is the actual definition of the</span>
 <span class="sd">            launch plan that should be created.</span>
 <span class="sd">        :raises flytekit.common.exceptions.user.FlyteEntityAlreadyExistsException: If an identical version of the</span>

diff --git a/_modules/flytekit/clients/helpers.html b/_modules/flytekit/clients/helpers.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clients.helpers &mdash; Flyte 0.3.0 documentation</title>
+  <title>flytekit.clients.helpers &mdash; Flyte 0.4.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clients/raw.html b/_modules/flytekit/clients/raw.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clients.raw &mdash; Flyte 0.3.0 documentation</title>
+  <title>flytekit.clients.raw &mdash; Flyte 0.4.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clis/auth/auth.html b/_modules/flytekit/clis/auth/auth.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.auth.auth &mdash; Flyte 0.3.0 documentation</title>
+  <title>flytekit.clis.auth.auth &mdash; Flyte 0.4.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clis/auth/credentials.html b/_modules/flytekit/clis/auth/credentials.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.auth.credentials &mdash; Flyte 0.3.0 documentation</title>
+  <title>flytekit.clis.auth.credentials &mdash; Flyte 0.4.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clis/auth/discovery.html b/_modules/flytekit/clis/auth/discovery.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.auth.discovery &mdash; Flyte 0.3.0 documentation</title>
+  <title>flytekit.clis.auth.discovery &mdash; Flyte 0.4.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clis/helpers.html b/_modules/flytekit/clis/helpers.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.helpers &mdash; Flyte 0.3.0 documentation</title>
+  <title>flytekit.clis.helpers &mdash; Flyte 0.4.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clis/sdk_in_container/basic_auth.html b/_modules/flytekit/clis/sdk_in_container/basic_auth.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.sdk_in_container.basic_auth &mdash; Flyte 0.3.0 documentation</title>
+  <title>flytekit.clis.sdk_in_container.basic_auth &mdash; Flyte 0.4.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clis/sdk_in_container/launch_plan.html b/_modules/flytekit/clis/sdk_in_container/launch_plan.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.sdk_in_container.launch_plan &mdash; Flyte 0.3.0 documentation</title>
+  <title>flytekit.clis.sdk_in_container.launch_plan &mdash; Flyte 0.4.0 documentation</title>
 
 
 
@@ -160,6 +160,7 @@ <h1>Source code for flytekit.clis.sdk_in_container.launch_plan</h1><div class="h
 
 <span class="kn">import</span> <span class="nn">click</span>
 <span class="kn">import</span> <span class="nn">six</span> <span class="k">as</span> <span class="nn">_six</span>
+<span class="kn">import</span> <span class="nn">logging</span> <span class="k">as</span> <span class="nn">_logging</span>
 
 <span class="kn">from</span> <span class="nn">flytekit.clis.helpers</span> <span class="k">import</span> <span class="n">construct_literal_map_from_parameter_map</span> <span class="k">as</span> <span class="n">_construct_literal_map_from_parameter_map</span>
 <span class="kn">from</span> <span class="nn">flytekit.clis.sdk_in_container</span> <span class="k">import</span> <span class="n">constants</span> <span class="k">as</span> <span class="n">_constants</span>
@@ -317,6 +318,7 @@ <h1>Source code for flytekit.clis.sdk_in_container.launch_plan</h1><div class="h
     <span class="c1"># TODO: We should optionally allow deactivation of missing launch plans</span>
 
     <span class="c1"># Discover all launch plans by loading the modules</span>
+    <span class="n">_logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">f</span><span class="s2">&quot;Setting this version&#39;s </span><span class="si">{version}</span><span class="s2"> launch plans active in </span><span class="si">{project}</span><span class="s2"> </span><span class="si">{domain}</span><span class="s2">&quot;</span><span class="p">)</span>
     <span class="k">for</span> <span class="n">m</span><span class="p">,</span> <span class="n">k</span><span class="p">,</span> <span class="n">lp</span> <span class="ow">in</span> <span class="n">iterate_registerable_entities_in_order</span><span class="p">(</span>
         <span class="n">pkgs</span><span class="p">,</span> <span class="n">include_entities</span><span class="o">=</span><span class="p">{</span><span class="n">_SdkLaunchPlan</span><span class="p">},</span> <span class="n">detect_unreferenced_entities</span><span class="o">=</span><span class="kc">False</span>
     <span class="p">):</span>
@@ -328,6 +330,7 @@ <h1>Source code for flytekit.clis.sdk_in_container.launch_plan</h1><div class="h
             <span class="n">version</span>
         <span class="p">)</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">lp</span><span class="o">.</span><span class="n">is_scheduled</span> <span class="ow">and</span> <span class="n">ignore_schedules</span><span class="p">):</span>
+            <span class="n">_logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">f</span><span class="s2">&quot;Setting active {_utils.fqdn(m.__name__, k, entity_type=lp.resource_type)}&quot;</span><span class="p">)</span>
             <span class="n">lp</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">_launch_plan_model</span><span class="o">.</span><span class="n">LaunchPlanState</span><span class="o">.</span><span class="n">ACTIVE</span><span class="p">)</span></div>
 
 

diff --git a/_modules/flytekit/clis/sdk_in_container/pyflyte.html b/_modules/flytekit/clis/sdk_in_container/pyflyte.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.sdk_in_container.pyflyte &mdash; Flyte 0.3.0 documentation</title>
+  <title>flytekit.clis.sdk_in_container.pyflyte &mdash; Flyte 0.4.0 documentation</title>
 
 
 
@@ -160,7 +160,7 @@ <h1>Source code for flytekit.clis.sdk_in_container.pyflyte</h1><div class="highl
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">print_function</span>
 
 <span class="kn">import</span> <span class="nn">os</span> <span class="k">as</span> <span class="nn">_os</span>
-
+<span class="kn">import</span> <span class="nn">logging</span> <span class="k">as</span> <span class="nn">_logging</span>
 <span class="kn">import</span> <span class="nn">click</span>
 
 <span class="k">try</span><span class="p">:</span>
@@ -173,7 +173,7 @@ <h1>Source code for flytekit.clis.sdk_in_container.pyflyte</h1><div class="highl
 <span class="kn">from</span> <span class="nn">flytekit.clis.sdk_in_container.serialize</span> <span class="k">import</span> <span class="n">serialize</span>
 <span class="kn">from</span> <span class="nn">flytekit.clis.sdk_in_container.constants</span> <span class="k">import</span> <span class="n">CTX_PROJECT</span><span class="p">,</span> <span class="n">CTX_DOMAIN</span><span class="p">,</span> <span class="n">CTX_VERSION</span>
 <span class="kn">from</span> <span class="nn">flytekit.clis.sdk_in_container.launch_plan</span> <span class="k">import</span> <span class="n">launch_plans</span>
-<span class="kn">from</span> <span class="nn">flytekit.configuration</span> <span class="k">import</span> <span class="n">internal</span> <span class="k">as</span> <span class="n">_internal_config</span><span class="p">,</span> <span class="n">platform</span> <span class="k">as</span> <span class="n">_platform_config</span>
+<span class="kn">from</span> <span class="nn">flytekit.configuration</span> <span class="k">import</span> <span class="n">internal</span> <span class="k">as</span> <span class="n">_internal_config</span><span class="p">,</span> <span class="n">platform</span> <span class="k">as</span> <span class="n">_platform_config</span><span class="p">,</span> <span class="n">sdk</span> <span class="k">as</span> <span class="n">_sdk_config</span>
 
 <span class="kn">from</span> <span class="nn">flytekit.configuration.internal</span> <span class="k">import</span> <span class="n">CONFIGURATION_PATH</span>
 <span class="kn">from</span> <span class="nn">flytekit.configuration.platform</span> <span class="k">import</span> <span class="n">URL</span> <span class="k">as</span> <span class="n">_URL</span>
@@ -201,6 +201,11 @@ <h1>Source code for flytekit.clis.sdk_in_container.pyflyte</h1><div class="highl
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">update_configuration_file</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
 
+    <span class="c1"># Update the logger if it&#39;s set</span>
+    <span class="n">log_level</span> <span class="o">=</span> <span class="n">_internal_config</span><span class="o">.</span><span class="n">LOGGING_LEVEL</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> <span class="ow">or</span> <span class="n">_sdk_config</span><span class="o">.</span><span class="n">LOGGING_LEVEL</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
+    <span class="k">if</span> <span class="n">log_level</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+        <span class="n">_logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">()</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">log_level</span><span class="p">)</span>
+
     <span class="n">ctx</span><span class="o">.</span><span class="n">obj</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
     <span class="n">ctx</span><span class="o">.</span><span class="n">obj</span><span class="p">[</span><span class="n">CTX_PROJECT</span><span class="p">]</span> <span class="o">=</span> <span class="n">project</span>
     <span class="n">ctx</span><span class="o">.</span><span class="n">obj</span><span class="p">[</span><span class="n">CTX_DOMAIN</span><span class="p">]</span> <span class="o">=</span> <span class="n">domain</span>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,7 +8,7 @@

		<meta name="viewport" content="width=device-width, initial-scale=1.0">

		<title>abc — Flyte 0.3.0 documentation</title>
		<title>abc — Flyte 0.4.0 documentation</title>



Expand Down