Update documentation

dptech-corp · Sep 23, 2023 · 120f862 · 120f862
1 parent 63f8d5d
commit 120f862
Show file tree

Hide file tree

Showing 6 changed files with 268 additions and 1 deletion.
diff --git a/dflow.html b/dflow.html
diff --git a/dflow.python.html b/dflow.python.html
@@ -73,6 +73,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <dd><p>Run the OP</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="dflow.python.op.OP.from_graph">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_graph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">graph</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dflow.python.op.OP.from_graph" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="dflow.python.op.OP.function">
 <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">function</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dflow.python.op.OP.function" title="Link to this definition">¶</a></dt>
@@ -309,6 +314,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <span class="sig-name descname"><span class="pre">convert_to_graph</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dflow.python.python_op_template.PythonOPTemplate.convert_to_graph" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="dflow.python.python_op_template.PythonOPTemplate.from_graph">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_graph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">graph</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dflow.python.python_op_template.PythonOPTemplate.from_graph" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="dflow.python.python_op_template.PythonOPTemplate.get_slices">
 <span class="sig-name descname"><span class="pre">get_slices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">slices_dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dflow.python.python_op_template.PythonOPTemplate.get_slices" title="Link to this definition">¶</a></dt>
@@ -489,6 +499,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <dd><p>Run the OP</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="dflow.python.OP.from_graph">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_graph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">graph</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dflow.python.OP.from_graph" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="dflow.python.OP.function">
 <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">function</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dflow.python.OP.function" title="Link to this definition">¶</a></dt>
@@ -664,6 +679,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <span class="sig-name descname"><span class="pre">convert_to_graph</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dflow.python.PythonOPTemplate.convert_to_graph" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="dflow.python.PythonOPTemplate.from_graph">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_graph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">graph</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dflow.python.PythonOPTemplate.from_graph" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="dflow.python.PythonOPTemplate.get_slices">
 <span class="sig-name descname"><span class="pre">get_slices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">slices_dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dflow.python.PythonOPTemplate.get_slices" title="Link to this definition">¶</a></dt>
@@ -735,6 +755,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
 <li><a class="reference internal" href="#dflow.python.op.OP.convert_to_graph"><code class="docutils literal notranslate"><span class="pre">OP.convert_to_graph()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.op.OP.exec_sign_check"><code class="docutils literal notranslate"><span class="pre">OP.exec_sign_check()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.op.OP.execute"><code class="docutils literal notranslate"><span class="pre">OP.execute()</span></code></a></li>
+<li><a class="reference internal" href="#dflow.python.op.OP.from_graph"><code class="docutils literal notranslate"><span class="pre">OP.from_graph()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.op.OP.function"><code class="docutils literal notranslate"><span class="pre">OP.function()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.op.OP.get_info"><code class="docutils literal notranslate"><span class="pre">OP.get_info()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.op.OP.get_input_artifact_link"><code class="docutils literal notranslate"><span class="pre">OP.get_input_artifact_link()</span></code></a></li>
@@ -771,6 +792,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
 <li><a class="reference internal" href="#dflow.python.python_op_template.PythonOPTemplate.add_slices"><code class="docutils literal notranslate"><span class="pre">PythonOPTemplate.add_slices()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.python_op_template.PythonOPTemplate.convert_to_argo"><code class="docutils literal notranslate"><span class="pre">PythonOPTemplate.convert_to_argo()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.python_op_template.PythonOPTemplate.convert_to_graph"><code class="docutils literal notranslate"><span class="pre">PythonOPTemplate.convert_to_graph()</span></code></a></li>
+<li><a class="reference internal" href="#dflow.python.python_op_template.PythonOPTemplate.from_graph"><code class="docutils literal notranslate"><span class="pre">PythonOPTemplate.from_graph()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.python_op_template.PythonOPTemplate.get_slices"><code class="docutils literal notranslate"><span class="pre">PythonOPTemplate.get_slices()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.python_op_template.PythonOPTemplate.render_script"><code class="docutils literal notranslate"><span class="pre">PythonOPTemplate.render_script()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.python_op_template.PythonOPTemplate.render_slices"><code class="docutils literal notranslate"><span class="pre">PythonOPTemplate.render_slices()</span></code></a></li>
@@ -803,6 +825,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
 <li><a class="reference internal" href="#dflow.python.OP.convert_to_graph"><code class="docutils literal notranslate"><span class="pre">OP.convert_to_graph()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.OP.exec_sign_check"><code class="docutils literal notranslate"><span class="pre">OP.exec_sign_check()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.OP.execute"><code class="docutils literal notranslate"><span class="pre">OP.execute()</span></code></a></li>
+<li><a class="reference internal" href="#dflow.python.OP.from_graph"><code class="docutils literal notranslate"><span class="pre">OP.from_graph()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.OP.function"><code class="docutils literal notranslate"><span class="pre">OP.function()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.OP.get_info"><code class="docutils literal notranslate"><span class="pre">OP.get_info()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.OP.get_input_artifact_link"><code class="docutils literal notranslate"><span class="pre">OP.get_input_artifact_link()</span></code></a></li>
@@ -827,6 +850,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
 <li><a class="reference internal" href="#dflow.python.PythonOPTemplate.add_slices"><code class="docutils literal notranslate"><span class="pre">PythonOPTemplate.add_slices()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.PythonOPTemplate.convert_to_argo"><code class="docutils literal notranslate"><span class="pre">PythonOPTemplate.convert_to_argo()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.PythonOPTemplate.convert_to_graph"><code class="docutils literal notranslate"><span class="pre">PythonOPTemplate.convert_to_graph()</span></code></a></li>
+<li><a class="reference internal" href="#dflow.python.PythonOPTemplate.from_graph"><code class="docutils literal notranslate"><span class="pre">PythonOPTemplate.from_graph()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.PythonOPTemplate.get_slices"><code class="docutils literal notranslate"><span class="pre">PythonOPTemplate.get_slices()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.PythonOPTemplate.render_script"><code class="docutils literal notranslate"><span class="pre">PythonOPTemplate.render_script()</span></code></a></li>
 <li><a class="reference internal" href="#dflow.python.PythonOPTemplate.render_slices"><code class="docutils literal notranslate"><span class="pre">PythonOPTemplate.render_slices()</span></code></a></li>

diff --git a/genindex.html b/genindex.html
@@ -900,6 +900,70 @@ <h2 id="F">F</h2>
       </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="dflow.html#dflow.DAG.from_graph">from_graph() (dflow.DAG class method)</a>
+
+      <ul>
+        <li><a href="dflow.html#dflow.dag.DAG.from_graph">(dflow.dag.DAG class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.InputArtifact.from_graph">(dflow.InputArtifact class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.InputParameter.from_graph">(dflow.InputParameter class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.Inputs.from_graph">(dflow.Inputs class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.io.InputArtifact.from_graph">(dflow.io.InputArtifact class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.io.InputParameter.from_graph">(dflow.io.InputParameter class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.io.Inputs.from_graph">(dflow.io.Inputs class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.io.OutputArtifact.from_graph">(dflow.io.OutputArtifact class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.io.OutputParameter.from_graph">(dflow.io.OutputParameter class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.io.Outputs.from_graph">(dflow.io.Outputs class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.op_template.ScriptOPTemplate.from_graph">(dflow.op_template.ScriptOPTemplate class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.OutputArtifact.from_graph">(dflow.OutputArtifact class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.OutputParameter.from_graph">(dflow.OutputParameter class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.Outputs.from_graph">(dflow.Outputs class method)</a>
+</li>
+        <li><a href="dflow.python.html#dflow.python.OP.from_graph">(dflow.python.OP class method)</a>
+</li>
+        <li><a href="dflow.python.html#dflow.python.op.OP.from_graph">(dflow.python.op.OP class method)</a>
+</li>
+        <li><a href="dflow.python.html#dflow.python.python_op_template.PythonOPTemplate.from_graph">(dflow.python.python_op_template.PythonOPTemplate class method)</a>
+</li>
+        <li><a href="dflow.python.html#dflow.python.PythonOPTemplate.from_graph">(dflow.python.PythonOPTemplate class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.Step.from_graph">(dflow.Step class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.step.Step.from_graph">(dflow.step.Step class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.Steps.from_graph">(dflow.Steps class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.steps.Steps.from_graph">(dflow.steps.Steps class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.Workflow.from_graph">(dflow.Workflow class method)</a>
+</li>
+        <li><a href="dflow.html#dflow.workflow.Workflow.from_graph">(dflow.workflow.Workflow class method)</a>
+</li>
+      </ul></li>
+      <li><a href="dflow.html#dflow.Workflow.from_graph_json">from_graph_json() (dflow.Workflow class method)</a>
+
+      <ul>
+        <li><a href="dflow.html#dflow.workflow.Workflow.from_graph_json">(dflow.workflow.Workflow class method)</a>
+</li>
+      </ul></li>
+      <li><a href="dflow.html#dflow.Workflow.from_graph_yaml">from_graph_yaml() (dflow.Workflow class method)</a>
+
+      <ul>
+        <li><a href="dflow.html#dflow.workflow.Workflow.from_graph_yaml">(dflow.workflow.Workflow class method)</a>
+</li>
+      </ul></li>
       <li><a href="dflow.html#dflow.Workflow.from_json">from_json() (dflow.Workflow class method)</a>
 
       <ul>