Skip to content

Commit

Permalink
Flyte v0.5.0 docs (#373)
Browse files Browse the repository at this point in the history 
* Flyte v0.5.0
  • Loading branch information
Ketan Umare authored Jun 30, 2020
1 parent b539711 commit b2cb7eb
Show file tree
Hide file tree
Showing 269 changed files with 4,156 additions and 493 deletions.
2 changes: 1 addition & 1 deletion _modules/abc.html
View file
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 &mdash; Flyte 0.4.0 documentation</title>
<title>abc &mdash; Flyte 0.5.0 documentation</title>



Expand Down
49 changes: 47 additions & 2 deletions _modules/flytekit/clients/friendly.html
View file
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>flytekit.clients.friendly &mdash; Flyte 0.4.0 documentation</title>
<title>flytekit.clients.friendly &mdash; Flyte 0.5.0 documentation</title>



Expand Down Expand Up @@ -162,7 +162,8 @@ <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="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="p">,</span> <span class="n">project_domain_attributes_pb2</span> <span class="k">as</span> \
<span class="n">_project_domain_attributes_pb2</span><span class="p">,</span> <span class="n">workflow_attributes_pb2</span> <span class="k">as</span> <span class="n">_workflow_attributes_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>
Expand Down Expand Up @@ -1042,6 +1043,50 @@ <h1>Source code for flytekit.clients.friendly</h1><div class="highlight"><pre>
<span class="n">_project_pb2</span><span class="o">.</span><span class="n">ProjectRegisterRequest</span><span class="p">(</span>
<span class="n">project</span><span class="o">=</span><span class="n">project</span><span class="o">.</span><span class="n">to_flyte_idl</span><span class="p">(),</span>
<span class="p">)</span>
<span class="p">)</span></div>

<span class="c1">####################################################################################################################</span>
<span class="c1">#</span>
<span class="c1"># Matching Attributes Endpoints</span>
<span class="c1">#</span>
<span class="c1">####################################################################################################################</span>

<div class="viewcode-block" id="SynchronousFlyteClient.update_project_domain_attributes"><a class="viewcode-back" href="../../../flytekit/flytekit.clients.html#flytekit.clients.friendly.SynchronousFlyteClient.update_project_domain_attributes">[docs]</a> <span class="k">def</span> <span class="nf">update_project_domain_attributes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project</span><span class="p">,</span> <span class="n">domain</span><span class="p">,</span> <span class="n">matching_attributes</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Sets custom attributes for a project and domain combination.</span>
<span class="sd"> :param Text project:</span>
<span class="sd"> :param Text domain:</span>
<span class="sd"> :param flytekit.models.MatchingAttributes matching_attributes:</span>
<span class="sd"> :return:</span>
<span class="sd"> &quot;&quot;&quot;</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="o">.</span><span class="n">update_project_domain_attributes</span><span class="p">(</span>
<span class="n">_project_domain_attributes_pb2</span><span class="o">.</span><span class="n">ProjectDomainAttributesUpdateRequest</span><span class="p">(</span>
<span class="n">attributes</span><span class="o">=</span><span class="n">_project_domain_attributes_pb2</span><span class="o">.</span><span class="n">ProjectDomainAttributes</span><span class="p">(</span>
<span class="n">project</span><span class="o">=</span><span class="n">project</span><span class="p">,</span>
<span class="n">domain</span><span class="o">=</span><span class="n">domain</span><span class="p">,</span>
<span class="n">matching_attributes</span><span class="o">=</span><span class="n">matching_attributes</span><span class="o">.</span><span class="n">to_flyte_idl</span><span class="p">(),</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="p">)</span></div>

<div class="viewcode-block" id="SynchronousFlyteClient.update_workflow_attributes"><a class="viewcode-back" href="../../../flytekit/flytekit.clients.html#flytekit.clients.friendly.SynchronousFlyteClient.update_workflow_attributes">[docs]</a> <span class="k">def</span> <span class="nf">update_workflow_attributes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project</span><span class="p">,</span> <span class="n">domain</span><span class="p">,</span> <span class="n">workflow</span><span class="p">,</span> <span class="n">matching_attributes</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Sets custom attributes for a project, domain, and workflow combination.</span>
<span class="sd"> :param Text project:</span>
<span class="sd"> :param Text domain:</span>
<span class="sd"> :param Text workflow:</span>
<span class="sd"> :param flytekit.models.MatchingAttributes matching_attributes:</span>
<span class="sd"> :return:</span>
<span class="sd"> &quot;&quot;&quot;</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="o">.</span><span class="n">update_workflow_attributes</span><span class="p">(</span>
<span class="n">_workflow_attributes_pb2</span><span class="o">.</span><span class="n">WorkflowAttributesUpdateRequest</span><span class="p">(</span>
<span class="n">attributes</span><span class="o">=</span><span class="n">_workflow_attributes_pb2</span><span class="o">.</span><span class="n">WorkflowAttributes</span><span class="p">(</span>
<span class="n">project</span><span class="o">=</span><span class="n">project</span><span class="p">,</span>
<span class="n">domain</span><span class="o">=</span><span class="n">domain</span><span class="p">,</span>
<span class="n">workflow</span><span class="o">=</span><span class="n">workflow</span><span class="p">,</span>
<span class="n">matching_attributes</span><span class="o">=</span><span class="n">matching_attributes</span><span class="o">.</span><span class="n">to_flyte_idl</span><span class="p">(),</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="p">)</span></div></div>
</pre></div>

Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/clients/helpers.html
View file
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>flytekit.clients.helpers &mdash; Flyte 0.4.0 documentation</title>
<title>flytekit.clients.helpers &mdash; Flyte 0.5.0 documentation</title>



Expand Down
Loading

0 comments on commit b2cb7eb

Please sign in to comment.