Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v0.3.0 docs updated #303

Merged
merged 1 commit into from
May 1, 2020
Merged

v0.3.0 docs updated #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _modules/abc.html
View file
Open in desktop
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.0.1 documentation</title>
<title>abc &mdash; Flyte 0.3.0 documentation</title>



Expand Down
25 changes: 24 additions & 1 deletion _modules/flytekit/clients/friendly.html
View file
Open in desktop
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.0.1 documentation</title>
<title>flytekit.clients.friendly &mdash; Flyte 0.3.0 documentation</title>



Expand Down Expand Up @@ -709,6 +709,29 @@ <h1>Source code for flytekit.clients.friendly</h1><div class="highlight"><pre>
<span class="p">)</span>
<span class="p">)</span></div>

<span class="c1">####################################################################################################################</span>
<span class="c1">#</span>
<span class="c1"># Named Entity Endpoints</span>
<span class="c1">#</span>
<span class="c1">####################################################################################################################</span>

<div class="viewcode-block" id="SynchronousFlyteClient.update_named_entity"><a class="viewcode-back" href="../../../flytekit/flytekit.clients.html#flytekit.clients.friendly.SynchronousFlyteClient.update_named_entity">[docs]</a> <span class="k">def</span> <span class="nf">update_named_entity</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resource_type</span><span class="p">,</span> <span class="nb">id</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Updates the metadata associated with a named entity. A named entity is designated a resource, e.g. a workflow,</span>
<span class="sd"> task or launch plan specified by {project, domain, name} across all versions of the resource.</span>

<span class="sd"> :param int resource_type: Enum value from flytekit.models.identifier.ResourceType</span>
<span class="sd"> :param flytekit.models.admin.named_entity.NamedEntityIdentifier id: identifier for named entity to update</span>
<span class="sd"> :param flytekit.models.admin.named_entity.NamedEntityIdentifierMetadata metadata:</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_named_entity</span><span class="p">(</span>
<span class="n">_common_pb2</span><span class="o">.</span><span class="n">NamedEntityUpdateRequest</span><span class="p">(</span>
<span class="n">resource_type</span><span class="o">=</span><span class="n">resource_type</span><span class="p">,</span>
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="o">.</span><span class="n">to_flyte_idl</span><span class="p">(),</span>
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</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"># Execution Endpoints</span>
Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/clients/helpers.html
View file
Open in desktop
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.0.1 documentation</title>
<title>flytekit.clients.helpers &mdash; Flyte 0.3.0 documentation</title>



Expand Down
16 changes: 15 additions & 1 deletion _modules/flytekit/clients/raw.html
View file
Open in desktop
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.raw &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.clients.raw &mdash; Flyte 0.3.0 documentation</title>



Expand Down Expand Up @@ -558,6 +558,20 @@ <h1>Source code for flytekit.clients.raw</h1><div class="highlight"><pre>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stub</span><span class="o">.</span><span class="n">ListActiveLaunchPlans</span><span class="p">(</span><span class="n">active_launch_plan_list_request</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_metadata</span><span class="p">)</span></div>

<span class="c1">####################################################################################################################</span>
<span class="c1">#</span>
<span class="c1"># Named Entity Endpoints</span>
<span class="c1">#</span>
<span class="c1">####################################################################################################################</span>

<div class="viewcode-block" id="RawSynchronousFlyteClient.update_named_entity"><a class="viewcode-back" href="../../../flytekit/flytekit.clients.html#flytekit.clients.raw.RawSynchronousFlyteClient.update_named_entity">[docs]</a> <span class="nd">@_handle_rpc_error</span>
<span class="k">def</span> <span class="nf">update_named_entity</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">update_named_entity_request</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> :param flyteidl.admin.common_pb2.NamedEntityUpdateRequest update_named_entity_request:</span>
<span class="sd"> :rtype: flyteidl.admin.common_pb2.NamedEntityUpdateResponse</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stub</span><span class="o">.</span><span class="n">UpdateNamedEntity</span><span class="p">(</span><span class="n">update_named_entity_request</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_metadata</span><span class="p">)</span></div>

<span class="c1">####################################################################################################################</span>
<span class="c1">#</span>
<span class="c1"># Workflow Execution Endpoints</span>
Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/clis/auth/auth.html
View file
Open in desktop
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.clis.auth.auth &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.clis.auth.auth &mdash; Flyte 0.3.0 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/clis/auth/credentials.html
View file
Open in desktop
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.clis.auth.credentials &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.clis.auth.credentials &mdash; Flyte 0.3.0 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/clis/auth/discovery.html
View file
Open in desktop
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.clis.auth.discovery &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.clis.auth.discovery &mdash; Flyte 0.3.0 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/clis/helpers.html
View file
Open in desktop
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.clis.helpers &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.clis.helpers &mdash; Flyte 0.3.0 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/clis/sdk_in_container/basic_auth.html
View file
Open in desktop
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.clis.sdk_in_container.basic_auth &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.clis.sdk_in_container.basic_auth &mdash; Flyte 0.3.0 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/clis/sdk_in_container/launch_plan.html
View file
Open in desktop
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.clis.sdk_in_container.launch_plan &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.clis.sdk_in_container.launch_plan &mdash; Flyte 0.3.0 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/clis/sdk_in_container/pyflyte.html
View file
Open in desktop
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.clis.sdk_in_container.pyflyte &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.clis.sdk_in_container.pyflyte &mdash; Flyte 0.3.0 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/clis/sdk_in_container/register.html
View file
Open in desktop
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.clis.sdk_in_container.register &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.clis.sdk_in_container.register &mdash; Flyte 0.3.0 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/clis/sdk_in_container/serialize.html
View file
Open in desktop
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.clis.sdk_in_container.serialize &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.clis.sdk_in_container.serialize &mdash; Flyte 0.3.0 documentation</title>



Expand Down
19 changes: 17 additions & 2 deletions _modules/flytekit/common/component_nodes.html
View file
Open in desktop
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.common.component_nodes &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.common.component_nodes &mdash; Flyte 0.3.0 documentation</title>



Expand Down Expand Up @@ -223,9 +223,24 @@ <h1>Source code for flytekit.common.component_nodes</h1><div class="highlight"><
<span class="sd"> :param flytekit.common.workflow.SdkWorkflow sdk_workflow:</span>
<span class="sd"> :param flytekit.common.launch_plan.SdkLaunchPlan sdk_launch_plan:</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">sdk_workflow</span> <span class="ow">and</span> <span class="n">sdk_launch_plan</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">_system_exceptions</span><span class="o">.</span><span class="n">FlyteSystemException</span><span class="p">(</span><span class="s2">&quot;SdkWorkflowNode cannot be called with both a workflow and &quot;</span>
<span class="s2">&quot;a launchplan specified, please pick one. WF: </span><span class="si">{}</span><span class="s2"> LP: </span><span class="si">{}</span><span class="s2">&quot;</span><span class="p">,</span>
<span class="n">sdk_workflow</span><span class="p">,</span> <span class="n">sdk_launch_plan</span><span class="p">)</span>

<span class="bp">self</span><span class="o">.</span><span class="n">_sdk_workflow</span> <span class="o">=</span> <span class="n">sdk_workflow</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_sdk_launch_plan</span> <span class="o">=</span> <span class="n">sdk_launch_plan</span>
<span class="nb">super</span><span class="p">(</span><span class="n">SdkWorkflowNode</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">sdk_wf_id</span> <span class="o">=</span> <span class="n">sdk_workflow</span><span class="o">.</span><span class="n">id</span> <span class="k">if</span> <span class="n">sdk_workflow</span> <span class="k">else</span> <span class="kc">None</span>
<span class="n">sdk_lp_id</span> <span class="o">=</span> <span class="n">sdk_launch_plan</span><span class="o">.</span><span class="n">id</span> <span class="k">if</span> <span class="n">sdk_launch_plan</span> <span class="k">else</span> <span class="kc">None</span>
<span class="nb">super</span><span class="p">(</span><span class="n">SdkWorkflowNode</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">launchplan_ref</span><span class="o">=</span><span class="n">sdk_lp_id</span><span class="p">,</span> <span class="n">sub_workflow_ref</span><span class="o">=</span><span class="n">sdk_wf_id</span><span class="p">)</span>

<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> :rtype: Text</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sdk_workflow</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;SdkWorkflowNode with workflow: </span><span class="si">{}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sdk_workflow</span><span class="p">)</span>
<span class="k">return</span> <span class="s2">&quot;SdkWorkflowNode with launch plan: </span><span class="si">{}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sdk_launch_plan</span><span class="p">)</span>

<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">launchplan_ref</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/common/constants.html
View file
Open in desktop
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.common.constants &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.common.constants &mdash; Flyte 0.3.0 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/common/core/identifier.html
View file
Open in desktop
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.common.core.identifier &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.common.core.identifier &mdash; Flyte 0.3.0 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/common/exceptions/base.html
View file
Open in desktop
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.common.exceptions.base &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.common.exceptions.base &mdash; Flyte 0.3.0 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/common/exceptions/scopes.html
View file
Open in desktop
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.common.exceptions.scopes &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.common.exceptions.scopes &mdash; Flyte 0.3.0 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/common/exceptions/system.html
View file
Open in desktop
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.common.exceptions.system &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.common.exceptions.system &mdash; Flyte 0.3.0 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/common/exceptions/user.html
View file
Open in desktop
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.common.exceptions.user &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.common.exceptions.user &mdash; Flyte 0.3.0 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion _modules/flytekit/common/interface.html
View file
Open in desktop
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.common.interface &mdash; Flyte 0.0.1 documentation</title>
<title>flytekit.common.interface &mdash; Flyte 0.3.0 documentation</title>



Expand Down
Loading