This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 674897d22 Automated deployment:
bd5d4b4eadf206439824a437649690f6710ca0d8
674897d22 is described below
commit 674897d227ef3909f289656152245be1b307bf66
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue May 24 05:10:28 2022 +0000
Automated deployment: bd5d4b4eadf206439824a437649690f6710ca0d8
---
.../development/development-environment-setup.html | 7 ++-
.../development/development-environment-setup.json | 2 +-
.../guide/project/workflow-definition.html | 2 +-
.../guide/project/workflow-definition.json | 2 +-
en-us/docs/dev/user_doc/guide/task/mlflow.html | 27 +++++---
en-us/docs/dev/user_doc/guide/task/mlflow.json | 2 +-
img/tasks/demo/mlflow-custom-project-template.png | Bin 0 -> 66296 bytes
img/tasks/demo/mlflow-custom-project.png | Bin 0 -> 84087 bytes
python/_modules/pydolphinscheduler/constants.html | 7 ---
.../core/process_definition.html | 26 +++++++-
python/_sources/config.rst.txt | 68 +++++++++++----------
python/api.html | 25 +++-----
python/config.html | 15 ++++-
python/genindex.html | 10 +--
python/objects.inv | Bin 5817 -> 5793 bytes
python/searchindex.js | 2 +-
.../development/development-environment-setup.html | 5 +-
.../development/development-environment-setup.json | 2 +-
.../guide/project/workflow-definition.html | 2 +-
.../guide/project/workflow-definition.json | 2 +-
zh-cn/docs/dev/user_doc/guide/task/mlflow.html | 27 +++++---
zh-cn/docs/dev/user_doc/guide/task/mlflow.json | 2 +-
22 files changed, 136 insertions(+), 99 deletions(-)
diff --git a/en-us/development/development-environment-setup.html
b/en-us/development/development-environment-setup.html
index 89d6ae384..3be4bc2ab 100644
--- a/en-us/development/development-environment-setup.html
+++ b/en-us/development/development-environment-setup.html
@@ -26,7 +26,12 @@ cd dolphinscheduler
git clone [email protected]:apache/dolphinscheduler.git
</code></pre>
<h3>compile source code</h3>
-<p>ii. Run <code>mvn clean install -Prelease -Dmaven.test.skip=true</code></p>
+<p>Supporting system:</p>
+<ul>
+<li>MacOS</li>
+<li>Liunx</li>
+</ul>
+<p>Run <code>mvn clean install -Prelease -Dmaven.test.skip=true</code></p>
<h2>Docker image build</h2>
<p>DolphinScheduler will release new Docker images after it released, you
could find them in <a
href="https://hub.docker.com/search?q=DolphinScheduler">Docker Hub</a>.</p>
<ul>
diff --git a/en-us/development/development-environment-setup.json
b/en-us/development/development-environment-setup.json
index c3ecf9e00..26edf362d 100644
--- a/en-us/development/development-environment-setup.json
+++ b/en-us/development/development-environment-setup.json
@@ -1,6 +1,6 @@
{
"filename": "development-environment-setup.md",
- "__html": "<h1>DolphinScheduler development</h1>\n<h2>Software
Requests</h2>\n<p>Before setting up the DolphinScheduler development
environment, please make sure you have installed the software as
below:</p>\n<ul>\n<li><a href=\"https://git-scm.com/downloads\">Git</a>:
DolphinScheduler version control system</li>\n<li><a
href=\"https://www.oracle.com/technetwork/java/javase/downloads/index.html\">JDK</a>:
DolphinScheduler backend language, have to use version after JDK
1.8</li>\n<li><a [...]
+ "__html": "<h1>DolphinScheduler development</h1>\n<h2>Software
Requests</h2>\n<p>Before setting up the DolphinScheduler development
environment, please make sure you have installed the software as
below:</p>\n<ul>\n<li><a href=\"https://git-scm.com/downloads\">Git</a>:
DolphinScheduler version control system</li>\n<li><a
href=\"https://www.oracle.com/technetwork/java/javase/downloads/index.html\">JDK</a>:
DolphinScheduler backend language, have to use version after JDK
1.8</li>\n<li><a [...]
"link": "/dist/en-us/development/development-environment-setup.html",
"meta": {}
}
\ No newline at end of file
diff --git a/en-us/docs/dev/user_doc/guide/project/workflow-definition.html
b/en-us/docs/dev/user_doc/guide/project/workflow-definition.html
index 6acfff6d6..fd69f9d78 100644
--- a/en-us/docs/dev/user_doc/guide/project/workflow-definition.html
+++ b/en-us/docs/dev/user_doc/guide/project/workflow-definition.html
@@ -62,7 +62,7 @@
<li><strong>Run:</strong> Only workflow in the online state can run. See <a
href="#run-the-workflow">2.3.3 Run Workflow</a> for the operation steps.</li>
<li><strong>Timing:</strong> Timing can only set to online workflows, and the
system automatically schedules to run the workflow on time. The status after
creating a timing setting is "offline", and the timing must set
online on the timing management page to make effect. See <a
href="#workflow-timing">2.3.4 Workflow Timing</a> for timing operation
steps</li>
<li><strong>Timing Management:</strong> The timing management page can edit,
online or offline and delete timing</li>
-<li><strong>Delete:</strong> Delete the workflow definition</li>
+<li><strong>Delete:</strong> Delete the workflow definition. In the same
project, only the workflow definition created by yourself can be deleted, and
the workflow definition of other users cannot be deleted. If you need to delete
it, please contact the user who created it or the administrator.</li>
<li><strong>Download:</strong> Download workflow definition to local</li>
<li><strong>Tree Diagram:</strong> Display the task node type and task status
in a tree structure, as shown in the figure below:</li>
</ul>
diff --git a/en-us/docs/dev/user_doc/guide/project/workflow-definition.json
b/en-us/docs/dev/user_doc/guide/project/workflow-definition.json
index ffdf73e1a..bde683c6c 100644
--- a/en-us/docs/dev/user_doc/guide/project/workflow-definition.json
+++ b/en-us/docs/dev/user_doc/guide/project/workflow-definition.json
@@ -1,6 +1,6 @@
{
"filename": "workflow-definition.md",
- "__html": "<h1>Workflow Definition</h1>\n<h2>Create workflow
definition</h2>\n<ul>\n<li>\n<p>Click Project Management -> Workflow ->
Workflow Definition, enter the workflow definition page, and click the
"Create Workflow" button to enter the <strong>workflow DAG
edit</strong> page, as shown in the following figure:</p>\n<p><img
src=\"/img/new_ui/dev/project/workflow-dag.png\"
alt=\"workflow-dag\"></p>\n</li>\n<li>\n<p>Drag from the toolbar <img
src=\"/img/tasks/icons/sh [...]
+ "__html": "<h1>Workflow Definition</h1>\n<h2>Create workflow
definition</h2>\n<ul>\n<li>\n<p>Click Project Management -> Workflow ->
Workflow Definition, enter the workflow definition page, and click the
"Create Workflow" button to enter the <strong>workflow DAG
edit</strong> page, as shown in the following figure:</p>\n<p><img
src=\"/img/new_ui/dev/project/workflow-dag.png\"
alt=\"workflow-dag\"></p>\n</li>\n<li>\n<p>Drag from the toolbar <img
src=\"/img/tasks/icons/sh [...]
"link":
"/dist/en-us/docs/dev/user_doc/guide/project/workflow-definition.html",
"meta": {}
}
\ No newline at end of file
diff --git a/en-us/docs/dev/user_doc/guide/task/mlflow.html
b/en-us/docs/dev/user_doc/guide/task/mlflow.html
index 4e5d5a5d3..6ed177206 100644
--- a/en-us/docs/dev/user_doc/guide/task/mlflow.html
+++ b/en-us/docs/dev/user_doc/guide/task/mlflow.html
@@ -22,11 +22,11 @@ reproducibility, deployment, and a central model
registry.</p>
</ul>
<p>The Mlflow plugin currently supports and will support the following:</p>
<ul>
-<li>[ ] MLflow Projects
+<li>[x] MLflow Projects
<ul>
-<li>[x] BasicAlgorithm: contains lr, svm, lightgbm, xgboost</li>
+<li>[x] BasicAlgorithm: contains LogisticRegression, svm, lightgbm,
xgboost</li>
<li>[x] AutoML: AutoML tool,contains autosklean, flaml</li>
-<li>[ ] Custom projects: Support for running your own MLflow projects</li>
+<li>[x] Custom projects: Support for running your own MLflow projects</li>
</ul>
</li>
<li>[ ] MLflow Models
@@ -77,9 +77,7 @@ upstream of the current task.</li>
<p><strong>Task Parameter</strong></p>
<ul>
<li><strong>mlflow server tracking uri</strong> :MLflow server uri, default <a
href="http://localhost:5000">http://localhost:5000</a>.</li>
-<li><strong>job type</strong> : The type of task to run, currently including
the underlying algorithm and AutoML. (User-defined
-MLFlow project task execution will be supported in the near future)</li>
-<li><strong>experiment name</strong> :The experiment in which the task is
running, if none, is created.</li>
+<li><strong>experiment name</strong> :Create the experiment where the task is
running, if the experiment does not exist. If the name is empty, it is set to
<code>Default</code>, the same as MLflow.</li>
<li><strong>register model</strong> :Register the model or not. If register is
selected, the following parameters are expanded.
<ul>
<li><strong>model name</strong> : The registered model name is added to the
original model version and registered as
@@ -111,9 +109,7 @@ and using the name after the equal sign to get the
corresponding parameter value
<p><strong>Task Parameter</strong></p>
<ul>
<li><strong>mlflow server tracking uri</strong> :MLflow server uri, default <a
href="http://localhost:5000">http://localhost:5000</a>.</li>
-<li><strong>job type</strong> : The type of task to run, currently including
the underlying algorithm and AutoML. (User-defined
-MLFlow project task execution will be supported in the near future)</li>
-<li><strong>experiment name</strong> :The experiment in which the task is
running, if none, is created.</li>
+<li><strong>experiment name</strong> :Create the experiment where the task is
running, if the experiment does not exist. If the name is empty, it is set to
<code>Default</code>, the same as MLflow.</li>
<li><strong>register model</strong> :Register the model or not. If register is
selected, the following parameters are expanded.
<ul>
<li><strong>model name</strong> : The registered model name is added to the
original model version and registered as
@@ -135,6 +131,19 @@ sign to get the corresponding parameter value through
<code>python eval()</code>
supports <a href="https://github.com/automl/auto-sklearn">autosklearn</a>
and <a href="https://github.com/microsoft/FLAML">flaml</a></li>
</ul>
+<h4>Custom projects</h4>
+<p><img src="/img/tasks/demo/mlflow-custom-project-template.png"
alt="mlflow-custom-project-template.png"></p>
+<p><strong>Task Parameter</strong></p>
+<ul>
+<li><strong>mlflow server tracking uri</strong> :MLflow server uri, default <a
href="http://localhost:5000">http://localhost:5000</a>.</li>
+<li><strong>experiment name</strong> :Create the experiment where the task is
running, if the experiment does not exist. If the name is empty, it is set to
<code>Default</code>, the same as MLflow.</li>
+<li><strong>parameters</strong> : <code>--param-list</code> in <code>mlflow
run</code>. For example <code>-P learning_rate=0.2 -P colsample_bytree=0.8 -P
subsample=0.9</code></li>
+<li><strong>Repository</strong> : Repository url of MLflow Project,Support git
address and directory on worker. If it's in a subdirectory,We add
<code>#</code> to support this (same as <code>mlflow run</code>) , for example
<code>https://github.com/mlflow/mlflow#examples/xgboost/xgboost_native</code></li>
+<li><strong>Project Version</strong> : Version of the project,default
master</li>
+</ul>
+<p>You can now use this feature to run all mlFlow projects on Github (For
example <a href="https://github.com/mlflow/mlflow/tree/master/examples">MLflow
examples</a> )了。You can also create your own machine learning library to reuse
your work, and then use DolphinScheduler to use your library with one click.</p>
+<p>The actual interface is as follows</p>
+<p><img src="/img/tasks/demo/mlflow-custom-project.png"
alt="mlflow-custom-project.png"></p>
<h3>MLflow Models</h3>
<h4>MLFLOW</h4>
<p><img src="/img/tasks/demo/mlflow-models-mlflow.png"
alt="mlflow-models-mlflow"></p>
diff --git a/en-us/docs/dev/user_doc/guide/task/mlflow.json
b/en-us/docs/dev/user_doc/guide/task/mlflow.json
index d83198390..e4b4ac0c9 100644
--- a/en-us/docs/dev/user_doc/guide/task/mlflow.json
+++ b/en-us/docs/dev/user_doc/guide/task/mlflow.json
@@ -1,6 +1,6 @@
{
"filename": "mlflow.md",
- "__html": "<h1>MLflow Node</h1>\n<h2>Overview</h2>\n<p><a
href=\"https://mlflow.org\">MLflow</a> is an excellent open source platform to
manage the ML lifecycle, including experimentation,\nreproducibility,
deployment, and a central model registry.</p>\n<p>MLflow task plugin used to
execute MLflow tasks,Currently contains Mlflow Projects and MLflow
Models.(Model Registry will soon be rewarded for support)</p>\n<ul>\n<li>Mlflow
Projects: Package data science code in a format to reproduc [...]
+ "__html": "<h1>MLflow Node</h1>\n<h2>Overview</h2>\n<p><a
href=\"https://mlflow.org\">MLflow</a> is an excellent open source platform to
manage the ML lifecycle, including experimentation,\nreproducibility,
deployment, and a central model registry.</p>\n<p>MLflow task plugin used to
execute MLflow tasks,Currently contains Mlflow Projects and MLflow
Models.(Model Registry will soon be rewarded for support)</p>\n<ul>\n<li>Mlflow
Projects: Package data science code in a format to reproduc [...]
"link": "/dist/en-us/docs/dev/user_doc/guide/task/mlflow.html",
"meta": {}
}
\ No newline at end of file
diff --git a/img/tasks/demo/mlflow-custom-project-template.png
b/img/tasks/demo/mlflow-custom-project-template.png
new file mode 100644
index 000000000..cbb2d6f73
Binary files /dev/null and b/img/tasks/demo/mlflow-custom-project-template.png
differ
diff --git a/img/tasks/demo/mlflow-custom-project.png
b/img/tasks/demo/mlflow-custom-project.png
new file mode 100644
index 000000000..54a8cb0ab
Binary files /dev/null and b/img/tasks/demo/mlflow-custom-project.png differ
diff --git a/python/_modules/pydolphinscheduler/constants.html
b/python/_modules/pydolphinscheduler/constants.html
index 449946eae..df292a105 100644
--- a/python/_modules/pydolphinscheduler/constants.html
+++ b/python/_modules/pydolphinscheduler/constants.html
@@ -92,13 +92,6 @@
<span class="sd">"""Constants for
pydolphinscheduler."""</span>
-<div class="viewcode-block" id="ProcessDefinitionReleaseState"><a
class="viewcode-back"
href="../../api.html#pydolphinscheduler.constants.ProcessDefinitionReleaseState">[docs]</a><span
class="k">class</span> <span
class="nc">ProcessDefinitionReleaseState</span><span class="p">:</span>
- <span class="sd">"""Constants for
:class:`pydolphinscheduler.core.process_definition.ProcessDefinition` release
state."""</span>
-
- <span class="n">ONLINE</span><span class="p">:</span> <span
class="nb">str</span> <span class="o">=</span> <span
class="s2">"ONLINE"</span>
- <span class="n">OFFLINE</span><span class="p">:</span> <span
class="nb">str</span> <span class="o">=</span> <span
class="s2">"OFFLINE"</span></div>
-
-
<div class="viewcode-block" id="TaskPriority"><a class="viewcode-back"
href="../../api.html#pydolphinscheduler.constants.TaskPriority">[docs]</a><span
class="k">class</span> <span class="nc">TaskPriority</span><span
class="p">(</span><span class="nb">str</span><span class="p">):</span>
<span class="sd">"""Constants for task
priority."""</span>
diff --git a/python/_modules/pydolphinscheduler/core/process_definition.html
b/python/_modules/pydolphinscheduler/core/process_definition.html
index d78fa18cb..45ef58496 100644
--- a/python/_modules/pydolphinscheduler/core/process_definition.html
+++ b/python/_modules/pydolphinscheduler/core/process_definition.html
@@ -95,7 +95,7 @@
<span class="kn">from</span> <span class="nn">datetime</span> <span
class="kn">import</span> <span class="n">datetime</span>
<span class="kn">from</span> <span class="nn">typing</span> <span
class="kn">import</span> <span class="n">Any</span><span class="p">,</span>
<span class="n">Dict</span><span class="p">,</span> <span
class="n">List</span><span class="p">,</span> <span
class="n">Optional</span><span class="p">,</span> <span class="n">Set</span>
-<span class="kn">from</span> <span
class="nn">pydolphinscheduler.constants</span> <span class="kn">import</span>
<span class="n">ProcessDefinitionReleaseState</span><span class="p">,</span>
<span class="n">TaskType</span>
+<span class="kn">from</span> <span
class="nn">pydolphinscheduler.constants</span> <span class="kn">import</span>
<span class="n">TaskType</span>
<span class="kn">from</span> <span class="nn">pydolphinscheduler.core</span>
<span class="kn">import</span> <span class="n">configuration</span>
<span class="kn">from</span> <span
class="nn">pydolphinscheduler.core.base</span> <span class="kn">import</span>
<span class="n">Base</span>
<span class="kn">from</span> <span
class="nn">pydolphinscheduler.exceptions</span> <span class="kn">import</span>
<span class="n">PyDSParamException</span><span class="p">,</span> <span
class="n">PyDSTaskNoFoundException</span>
@@ -179,7 +179,7 @@
<span class="n">warning_type</span><span class="p">:</span> <span
class="n">Optional</span><span class="p">[</span><span
class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span
class="n">configuration</span><span class="o">.</span><span
class="n">WORKFLOW_WARNING_TYPE</span><span class="p">,</span>
<span class="n">warning_group_id</span><span class="p">:</span> <span
class="n">Optional</span><span class="p">[</span><span
class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span
class="mi">0</span><span class="p">,</span>
<span class="n">timeout</span><span class="p">:</span> <span
class="n">Optional</span><span class="p">[</span><span
class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span
class="mi">0</span><span class="p">,</span>
- <span class="n">release_state</span><span class="p">:</span> <span
class="n">Optional</span><span class="p">[</span><span
class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span
class="n">ProcessDefinitionReleaseState</span><span class="o">.</span><span
class="n">ONLINE</span><span class="p">,</span>
+ <span class="n">release_state</span><span class="p">:</span> <span
class="n">Optional</span><span class="p">[</span><span
class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span
class="n">configuration</span><span class="o">.</span><span
class="n">WORKFLOW_RELEASE_STATE</span><span class="p">,</span>
<span class="n">param</span><span class="p">:</span> <span
class="n">Optional</span><span class="p">[</span><span
class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span
class="kc">None</span><span class="p">,</span>
<span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span
class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span
class="n">name</span><span class="p">,</span> <span
class="n">description</span><span class="p">)</span>
@@ -200,7 +200,7 @@
<span class="bp">self</span><span class="o">.</span><span
class="n">warning_type</span> <span class="o">=</span> <span
class="n">warning_type</span><span class="o">.</span><span
class="n">strip</span><span class="p">()</span><span class="o">.</span><span
class="n">upper</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span
class="n">warning_group_id</span> <span class="o">=</span> <span
class="n">warning_group_id</span>
<span class="bp">self</span><span class="o">.</span><span
class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span>
- <span class="bp">self</span><span class="o">.</span><span
class="n">release_state</span> <span class="o">=</span> <span
class="n">release_state</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">_release_state</span> <span class="o">=</span> <span
class="n">release_state</span>
<span class="bp">self</span><span class="o">.</span><span
class="n">param</span> <span class="o">=</span> <span class="n">param</span>
<span class="bp">self</span><span class="o">.</span><span
class="n">tasks</span><span class="p">:</span> <span class="nb">dict</span>
<span class="o">=</span> <span class="p">{}</span>
<span class="c1"># TODO how to fix circle import</span>
@@ -271,6 +271,25 @@
<span class="sd">"""Set attribute
end_time."""</span>
<span class="bp">self</span><span class="o">.</span><span
class="n">_end_time</span> <span class="o">=</span> <span class="n">val</span>
+ <span class="nd">@property</span>
+ <span class="k">def</span> <span class="nf">release_state</span><span
class="p">(</span><span class="bp">self</span><span class="p">)</span> <span
class="o">-></span> <span class="nb">int</span><span class="p">:</span>
+ <span class="sd">"""Get attribute
release_state."""</span>
+ <span class="n">rs_ref</span> <span class="o">=</span> <span
class="p">{</span>
+ <span class="s2">"online"</span><span class="p">:</span>
<span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span
class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="k">if</span> <span class="bp">self</span><span
class="o">.</span><span class="n">_release_state</span> <span
class="ow">not</span> <span class="ow">in</span> <span
class="n">rs_ref</span><span class="p">:</span>
+ <span class="k">raise</span> <span
class="n">PyDSParamException</span><span class="p">(</span>
+ <span class="s2">"Parameter release_state only support
`online` or `offline` but get %"</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">_release_state</span><span class="p">,</span>
+ <span class="p">)</span>
+ <span class="k">return</span> <span class="n">rs_ref</span><span
class="p">[</span><span class="bp">self</span><span class="o">.</span><span
class="n">_release_state</span><span class="p">]</span>
+
+ <span class="nd">@release_state</span><span class="o">.</span><span
class="n">setter</span>
+ <span class="k">def</span> <span class="nf">release_state</span><span
class="p">(</span><span class="bp">self</span><span class="p">,</span> <span
class="n">val</span><span class="p">:</span> <span class="nb">str</span><span
class="p">)</span> <span class="o">-></span> <span
class="kc">None</span><span class="p">:</span>
+ <span class="sd">"""Set attribute
release_state."""</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">_release_state</span> <span class="o">=</span> <span
class="n">val</span><span class="o">.</span><span class="n">lower</span><span
class="p">()</span>
+
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">param_json</span><span
class="p">(</span><span class="bp">self</span><span class="p">)</span> <span
class="o">-></span> <span class="n">Optional</span><span
class="p">[</span><span class="n">List</span><span class="p">[</span><span
class="n">Dict</span><span class="p">]]:</span>
<span class="sd">"""Return param json base on
self.param."""</span>
@@ -455,6 +474,7 @@
<span class="bp">self</span><span class="o">.</span><span
class="n">timeout</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span
class="n">worker_group</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span
class="n">_tenant</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">release_state</span><span class="p">,</span>
<span class="c1"># TODO add serialization function</span>
<span class="n">json</span><span class="o">.</span><span
class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span
class="o">.</span><span class="n">task_relation_json</span><span
class="p">),</span>
<span class="n">json</span><span class="o">.</span><span
class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span
class="o">.</span><span class="n">task_definition_json</span><span
class="p">),</span>
diff --git a/python/_sources/config.rst.txt b/python/_sources/config.rst.txt
index b7879dd94..2b804d0c6 100644
--- a/python/_sources/config.rst.txt
+++ b/python/_sources/config.rst.txt
@@ -78,39 +78,41 @@ All Configurations in Environment Variables
All environment variables as below, and you could modify their value via `Bash
<by bash>`_ or `Python OS Module <by python os module>`_
-+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| Variable Section | Variable Name | description
|
-+==================+====================================+==================================================================================================================+
-| | ``PYDS_JAVA_GATEWAY_ADDRESS`` | Default Java gateway
address, will use its value when it is set.
|
-+
+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| Java Gateway | ``PYDS_JAVA_GATEWAY_PORT`` | Default Java gateway
port, will use its value when it is set.
|
-+
+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| | ``PYDS_JAVA_GATEWAY_AUTO_CONVERT`` | Default boolean Java
gateway auto convert, will use its value when it is set.
|
-+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| | ``PYDS_USER_NAME`` | Default user name,
will use when user's ``name`` when does not specify.
|
-+
+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| | ``PYDS_USER_PASSWORD`` | Default user
password, will use when user's ``password`` when does not specify.
|
-+
+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| Default User | ``PYDS_USER_EMAIL`` | Default user email,
will use when user's ``email`` when does not specify.
|
-+
+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| | ``PYDS_USER_PHONE`` | Default user phone,
will use when user's ``phone`` when does not specify.
|
-+
+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| | ``PYDS_USER_STATE`` | Default user state,
will use when user's ``state`` when does not specify.
|
-+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| | ``PYDS_WORKFLOW_PROJECT`` | Default workflow
project name, will use its value when workflow does not specify the attribute
``project``. |
-+
+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| | ``PYDS_WORKFLOW_TENANT`` | Default workflow
tenant, will use its value when workflow does not specify the attribute
``tenant``. |
-+
+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| Default Workflow | ``PYDS_WORKFLOW_USER`` | Default workflow
user, will use its value when workflow does not specify the attribute ``user``.
|
-+
+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| | ``PYDS_WORKFLOW_QUEUE`` | Default workflow
queue, will use its value when workflow does not specify the attribute
``queue``. |
-+
+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| | ``PYDS_WORKFLOW_WORKER_GROUP`` | Default workflow
worker group, will use its value when workflow does not specify the attribute
``worker_group``. |
-+
+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| | ``PYDS_WORKFLOW_TIME_ZONE`` | Default workflow
worker group, will use its value when workflow does not specify the attribute
``timezone``. |
-+
+------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| | ``PYDS_WORKFLOW_WARNING_TYPE`` | Default workflow
warning type, will use its value when workflow does not specify the attribute
``warning_type``. |
-+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------+
++------------------+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| Variable Section | Variable Name | description
|
++==================+====================================+====================================================================================================================+
+| | ``PYDS_JAVA_GATEWAY_ADDRESS`` | Default Java gateway
address, will use its value when it is set.
|
++
+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| Java Gateway | ``PYDS_JAVA_GATEWAY_PORT`` | Default Java gateway
port, will use its value when it is set.
|
++
+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| | ``PYDS_JAVA_GATEWAY_AUTO_CONVERT`` | Default boolean Java
gateway auto convert, will use its value when it is set.
|
++------------------+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| | ``PYDS_USER_NAME`` | Default user name,
will use when user's ``name`` when does not specify.
|
++
+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| | ``PYDS_USER_PASSWORD`` | Default user
password, will use when user's ``password`` when does not specify.
|
++
+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| Default User | ``PYDS_USER_EMAIL`` | Default user email,
will use when user's ``email`` when does not specify.
|
++
+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| | ``PYDS_USER_PHONE`` | Default user phone,
will use when user's ``phone`` when does not specify.
|
++
+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| | ``PYDS_USER_STATE`` | Default user state,
will use when user's ``state`` when does not specify.
|
++------------------+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| | ``PYDS_WORKFLOW_PROJECT`` | Default workflow
project name, will use its value when workflow does not specify the attribute
``project``. |
++
+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| | ``PYDS_WORKFLOW_TENANT`` | Default workflow
tenant, will use its value when workflow does not specify the attribute
``tenant``. |
++
+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| Default Workflow | ``PYDS_WORKFLOW_USER`` | Default workflow
user, will use its value when workflow does not specify the attribute ``user``.
|
++
+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| | ``PYDS_WORKFLOW_QUEUE`` | Default workflow
queue, will use its value when workflow does not specify the attribute
``queue``. |
++
+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| | ``PYDS_WORKFLOW_WORKER_GROUP`` | Default workflow
worker group, will use its value when workflow does not specify the attribute
``worker_group``. |
++
+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| | ``PYDS_WORKFLOW_RELEASE_STATE`` | Default workflow
release state, will use its value when workflow does not specify the attribute
``release_state``. |
++
+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| | ``PYDS_WORKFLOW_TIME_ZONE`` | Default workflow
worker group, will use its value when workflow does not specify the attribute
``timezone``. |
++
+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+| | ``PYDS_WORKFLOW_WARNING_TYPE`` | Default workflow
warning type, will use its value when workflow does not specify the attribute
``warning_type``. |
++------------------+------------------------------------+--------------------------------------------------------------------------------------------------------------------+
.. note::
diff --git a/python/api.html b/python/api.html
index fd48d4810..43522eb4c 100644
--- a/python/api.html
+++ b/python/api.html
@@ -285,7 +285,7 @@ directly set as python property, so we Override
Task.task_params here.</p>
<dl class="py class">
<dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition">
-<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-prename descclassname"><span
class="pre">pydolphinscheduler.core.</span></span><span class="sig-name
descname"><span class="pre">ProcessDefinition</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">name</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span></em> [...]
+<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-prename descclassname"><span
class="pre">pydolphinscheduler.core.</span></span><span class="sig-name
descname"><span class="pre">ProcessDefinition</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">name</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span></em> [...]
<dd><p>Bases: <code class="xref py py-class docutils literal
notranslate"><span
class="pre">pydolphinscheduler.core.base.Base</span></code></p>
<p>process definition object, will define process definition attribute, task,
relation.</p>
<p>TODO: maybe we should rename this class, currently use DS object name.</p>
@@ -435,6 +435,12 @@ for now, and schedule run will coming soon.
<dd><p>Get attribute project.</p>
</dd></dl>
+<dl class="py property">
+<dt class="sig sig-object py"
id="pydolphinscheduler.core.ProcessDefinition.release_state">
+<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">release_state</span></span><em class="property"><span
class="p"><span class="pre">:</span></span><span class="w"> </span><span
class="pre">int</span></em><a class="headerlink"
href="#pydolphinscheduler.core.ProcessDefinition.release_state"
title="Permalink to this definition"></a></dt>
+<dd><p>Get attribute release_state.</p>
+</dd></dl>
+
<dl class="py property">
<dt class="sig sig-object py"
id="pydolphinscheduler.core.ProcessDefinition.schedule_json">
<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">schedule_json</span></span><em class="property"><span
class="p"><span class="pre">:</span></span><span class="w"> </span><span
class="pre">Optional</span><span class="p"><span
class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span
class="pre">]</span></span></em><a class="headerlink"
href="#pydolphinscheduler.core.ProcessDefinition.sc [...]
@@ -2449,23 +2455,6 @@ attribute <cite>_task_custom_attr</cite> due to avoid
attribute cover.</p>
</dd></dl>
-<dl class="py class">
-<dt class="sig sig-object py"
id="pydolphinscheduler.constants.ProcessDefinitionReleaseState">
-<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-prename descclassname"><span
class="pre">pydolphinscheduler.constants.</span></span><span class="sig-name
descname"><span class="pre">ProcessDefinitionReleaseState</span></span><a
class="reference internal"
href="_modules/pydolphinscheduler/constants.html#ProcessDefinitionReleaseState"><span
class="viewcode-link"><span class="pre">[source]</span></span></a><a
class="headerlink" href="#pydolph [...]
-<dd><p>Bases: <code class="xref py py-class docutils literal
notranslate"><span class="pre">object</span></code></p>
-<p>Constants for <a class="reference internal"
href="#pydolphinscheduler.core.ProcessDefinition"
title="pydolphinscheduler.core.process_definition.ProcessDefinition"><code
class="xref py py-class docutils literal notranslate"><span
class="pre">pydolphinscheduler.core.process_definition.ProcessDefinition</span></code></a>
release state.</p>
-<dl class="py attribute">
-<dt class="sig sig-object py"
id="pydolphinscheduler.constants.ProcessDefinitionReleaseState.OFFLINE">
-<span class="sig-name descname"><span class="pre">OFFLINE</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">str</span></em><em class="property"><span
class="w"> </span><span class="p"><span class="pre">=</span></span><span
class="w"> </span><span class="pre">'OFFLINE'</span></em><a class="headerlink"
href="#pydolphinscheduler.constants.ProcessDefinitionReleaseState.OFFLINE"
title="Permalink to this definition"></a></dt>
-<dd></dd></dl>
-
-<dl class="py attribute">
-<dt class="sig sig-object py"
id="pydolphinscheduler.constants.ProcessDefinitionReleaseState.ONLINE">
-<span class="sig-name descname"><span class="pre">ONLINE</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">str</span></em><em class="property"><span
class="w"> </span><span class="p"><span class="pre">=</span></span><span
class="w"> </span><span class="pre">'ONLINE'</span></em><a class="headerlink"
href="#pydolphinscheduler.constants.ProcessDefinitionReleaseState.ONLINE"
title="Permalink to this definition"></a></dt>
-<dd></dd></dl>
-
-</dd></dl>
-
<dl class="py class">
<dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskFlag">
<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-prename descclassname"><span
class="pre">pydolphinscheduler.constants.</span></span><span class="sig-name
descname"><span class="pre">TaskFlag</span></span><a class="reference internal"
href="_modules/pydolphinscheduler/constants.html#TaskFlag"><span
class="viewcode-link"><span class="pre">[source]</span></span></a><a
class="headerlink" href="#pydolphinscheduler.constants.TaskFlag" title="Per
[...]
diff --git a/python/config.html b/python/config.html
index 9ed44c62f..136a0dfd8 100644
--- a/python/config.html
+++ b/python/config.html
@@ -180,7 +180,7 @@ method next to <code class="docutils literal
notranslate"><span class="pre">os.e
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span
class="pre">PYDS_USER_STATE</span></code></p></td>
<td><p>Default user state, will use when user’s <code class="docutils literal
notranslate"><span class="pre">state</span></code> when does not
specify.</p></td>
</tr>
-<tr class="row-even"><td rowspan="7"><p>Default Workflow</p></td>
+<tr class="row-even"><td rowspan="8"><p>Default Workflow</p></td>
<td><p><code class="docutils literal notranslate"><span
class="pre">PYDS_WORKFLOW_PROJECT</span></code></p></td>
<td><p>Default workflow project name, will use its value when workflow does
not specify the attribute <code class="docutils literal notranslate"><span
class="pre">project</span></code>.</p></td>
</tr>
@@ -196,10 +196,13 @@ method next to <code class="docutils literal
notranslate"><span class="pre">os.e
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span
class="pre">PYDS_WORKFLOW_WORKER_GROUP</span></code></p></td>
<td><p>Default workflow worker group, will use its value when workflow does
not specify the attribute <code class="docutils literal notranslate"><span
class="pre">worker_group</span></code>.</p></td>
</tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span
class="pre">PYDS_WORKFLOW_TIME_ZONE</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span
class="pre">PYDS_WORKFLOW_RELEASE_STATE</span></code></p></td>
+<td><p>Default workflow release state, will use its value when workflow does
not specify the attribute <code class="docutils literal notranslate"><span
class="pre">release_state</span></code>.</p></td>
+</tr>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span
class="pre">PYDS_WORKFLOW_TIME_ZONE</span></code></p></td>
<td><p>Default workflow worker group, will use its value when workflow does
not specify the attribute <code class="docutils literal notranslate"><span
class="pre">timezone</span></code>.</p></td>
</tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span
class="pre">PYDS_WORKFLOW_WARNING_TYPE</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span
class="pre">PYDS_WORKFLOW_WARNING_TYPE</span></code></p></td>
<td><p>Default workflow warning type, will use its value when workflow does
not specify the attribute <code class="docutils literal notranslate"><span
class="pre">warning_type</span></code>.</p></td>
</tr>
</tbody>
@@ -311,7 +314,13 @@ Raise error.
<span class="w"> </span><span class="nt">user</span><span
class="p">:</span><span class="w"> </span><span class="l l-Scalar
l-Scalar-Plain">userPythonGateway</span><span class="w"></span>
<span class="w"> </span><span class="nt">queue</span><span
class="p">:</span><span class="w"> </span><span class="l l-Scalar
l-Scalar-Plain">queuePythonGateway</span><span class="w"></span>
<span class="w"> </span><span class="nt">worker_group</span><span
class="p">:</span><span class="w"> </span><span class="l l-Scalar
l-Scalar-Plain">default</span><span class="w"></span>
+<span class="w"> </span><span class="c1"># Release state of workflow,
default value is ``online`` which mean setting workflow online when it
submits</span><span class="w"></span>
+<span class="w"> </span><span class="c1"># to Java gateway, if you want to
set workflow offline set its value to ``offline``</span><span class="w"></span>
+<span class="w"> </span><span class="nt">release_state</span><span
class="p">:</span><span class="w"> </span><span class="l l-Scalar
l-Scalar-Plain">online</span><span class="w"></span>
<span class="w"> </span><span class="nt">time_zone</span><span
class="p">:</span><span class="w"> </span><span class="l l-Scalar
l-Scalar-Plain">Asia/Shanghai</span><span class="w"></span>
+<span class="w"> </span><span class="c1"># Warning type of the workflow,
default value is ``NONE`` mean do not warn user in any cases of workflow
state,</span><span class="w"></span>
+<span class="w"> </span><span class="c1"># change to ``FAILURE`` if you
want to warn users when workflow failed. All available enum value
are</span><span class="w"></span>
+<span class="w"> </span><span class="c1"># ``NONE``, ``SUCCESS``,
``FAILURE``, ``ALL`` </span><span class="w"></span>
<span class="w"> </span><span class="nt">warning_type</span><span
class="p">:</span><span class="w"> </span><span class="l l-Scalar
l-Scalar-Plain">NONE</span><span class="w"></span>
</pre></div>
</div>
diff --git a/python/genindex.html b/python/genindex.html
index c36e123f1..3d94efd2c 100644
--- a/python/genindex.html
+++ b/python/genindex.html
@@ -1242,10 +1242,6 @@
<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
- <li><a
href="api.html#pydolphinscheduler.constants.ProcessDefinitionReleaseState.OFFLINE">OFFLINE
(pydolphinscheduler.constants.ProcessDefinitionReleaseState attribute)</a>
-</li>
- <li><a
href="api.html#pydolphinscheduler.constants.ProcessDefinitionReleaseState.ONLINE">ONLINE
(pydolphinscheduler.constants.ProcessDefinitionReleaseState attribute)</a>
-</li>
<li><a
href="tasks/condition.html#pydolphinscheduler.tasks.condition.ConditionOperator.operator_name">operator_name()
(pydolphinscheduler.tasks.condition.ConditionOperator class method)</a>
<ul>
@@ -1321,8 +1317,6 @@
</li>
</ul></li>
<li><a
href="api.html#pydolphinscheduler.core.ProcessDefinition">ProcessDefinition
(class in pydolphinscheduler.core)</a>
-</li>
- <li><a
href="api.html#pydolphinscheduler.constants.ProcessDefinitionReleaseState">ProcessDefinitionReleaseState
(class in pydolphinscheduler.constants)</a>
</li>
<li><a href="api.html#pydolphinscheduler.side.Project">Project (class in
pydolphinscheduler.side)</a>
</li>
@@ -1539,10 +1533,12 @@
<li><a
href="tasks/dependent.html#pydolphinscheduler.tasks.dependent.DependentOperator.relation">(pydolphinscheduler.tasks.dependent.DependentOperator
property)</a>
</li>
</ul></li>
- <li><a
href="api.html#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_DATA">RESULT_DATA
(pydolphinscheduler.constants.JavaGatewayDefault attribute)</a>
+ <li><a
href="api.html#pydolphinscheduler.core.ProcessDefinition.release_state">release_state
(pydolphinscheduler.core.ProcessDefinition property)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
+ <li><a
href="api.html#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_DATA">RESULT_DATA
(pydolphinscheduler.constants.JavaGatewayDefault attribute)</a>
+</li>
<li><a
href="api.html#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_MESSAGE_KEYWORD">RESULT_MESSAGE_KEYWORD
(pydolphinscheduler.constants.JavaGatewayDefault attribute)</a>
</li>
<li><a
href="api.html#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_MESSAGE_SUCCESS">RESULT_MESSAGE_SUCCESS
(pydolphinscheduler.constants.JavaGatewayDefault attribute)</a>
diff --git a/python/objects.inv b/python/objects.inv
index 77ed8b718..fd5963cac 100644
Binary files a/python/objects.inv and b/python/objects.inv differ
diff --git a/python/searchindex.js b/python/searchindex.js
index a4e8e8960..258a5b328 100644
--- a/python/searchindex.js
+++ b/python/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["api","cli","concept","config","howto/index","howto/remote-submit","index","start","tasks/condition","tasks/datax","tasks/dependent","tasks/flink","tasks/func_wrap","tasks/http","tasks/index","tasks/map_reduce","tasks/procedure","tasks/python","tasks/shell","tasks/spark","tasks/sql","tasks/sub_process","tasks/switch","tutorial"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index
[...]
\ No newline at end of file
+Search.setIndex({docnames:["api","cli","concept","config","howto/index","howto/remote-submit","index","start","tasks/condition","tasks/datax","tasks/dependent","tasks/flink","tasks/func_wrap","tasks/http","tasks/index","tasks/map_reduce","tasks/procedure","tasks/python","tasks/shell","tasks/spark","tasks/sql","tasks/sub_process","tasks/switch","tutorial"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index
[...]
\ No newline at end of file
diff --git a/zh-cn/development/development-environment-setup.html
b/zh-cn/development/development-environment-setup.html
index b694ec24b..aa345f94e 100644
--- a/zh-cn/development/development-environment-setup.html
+++ b/zh-cn/development/development-environment-setup.html
@@ -26,9 +26,12 @@ cd dolphinscheduler
git clone [email protected]:apache/dolphinscheduler.git
</code></pre>
<h3>编译源码</h3>
+<p>支持的系统:</p>
<ul>
-<li>运行 <code>mvn clean install -Prelease -Dmaven.test.skip=true</code></li>
+<li>MacOS</li>
+<li>Linux</li>
</ul>
+<p>运行 <code>mvn clean install -Prelease -Dmaven.test.skip=true</code></p>
<h2>Docker镜像构建</h2>
<p>DolphinScheduler 每次发版都会同时发布 Docker 镜像,你可以在 <a
href="https://hub.docker.com/search?q=DolphinScheduler">Docker Hub</a>
中找到这些镜像</p>
<ul>
diff --git a/zh-cn/development/development-environment-setup.json
b/zh-cn/development/development-environment-setup.json
index 569e5c08c..787bc6223 100644
--- a/zh-cn/development/development-environment-setup.json
+++ b/zh-cn/development/development-environment-setup.json
@@ -1,6 +1,6 @@
{
"filename": "development-environment-setup.md",
- "__html": "<h1>DolphinScheduler 开发手册</h1>\n<h2>前置条件</h2>\n<p>在搭建
DolphinScheduler 开发环境之前请确保你已经安装一下软件</p>\n<ul>\n<li><a
href=\"https://git-scm.com/downloads\">Git</a>: 版本控制系统</li>\n<li><a
href=\"https://www.oracle.com/technetwork/java/javase/downloads/index.html\">JDK</a>:
后端开发,必须使用JDK1.8及以后的版本</li>\n<li><a
href=\"http://maven.apache.org/download.cgi\">Maven</a>: Java包管理系统</li>\n<li><a
href=\"https://nodejs.org/en/download\">Node</a>:
前端开发,必须使用Node12.20.2及以后的版本</li>\n</ul>\n<h3>克隆代码库</h [...]
+ "__html": "<h1>DolphinScheduler 开发手册</h1>\n<h2>前置条件</h2>\n<p>在搭建
DolphinScheduler 开发环境之前请确保你已经安装一下软件</p>\n<ul>\n<li><a
href=\"https://git-scm.com/downloads\">Git</a>: 版本控制系统</li>\n<li><a
href=\"https://www.oracle.com/technetwork/java/javase/downloads/index.html\">JDK</a>:
后端开发,必须使用JDK1.8及以后的版本</li>\n<li><a
href=\"http://maven.apache.org/download.cgi\">Maven</a>: Java包管理系统</li>\n<li><a
href=\"https://nodejs.org/en/download\">Node</a>:
前端开发,必须使用Node12.20.2及以后的版本</li>\n</ul>\n<h3>克隆代码库</h [...]
"link": "/dist/zh-cn/development/development-environment-setup.html",
"meta": {}
}
\ No newline at end of file
diff --git a/zh-cn/docs/dev/user_doc/guide/project/workflow-definition.html
b/zh-cn/docs/dev/user_doc/guide/project/workflow-definition.html
index 0574c253e..69691b673 100644
--- a/zh-cn/docs/dev/user_doc/guide/project/workflow-definition.html
+++ b/zh-cn/docs/dev/user_doc/guide/project/workflow-definition.html
@@ -60,7 +60,7 @@
<li><strong>运行:</strong> 只有上线的工作流能运行。运行操作步骤见运行工作流</li>
<li><strong>定时:</strong>
只有上线的工作流能设置定时,系统自动定时调度工作流运行。创建定时后的状态为"下线",需在定时管理页面上线定时才生效。定时操作步骤见工作流定时</li>
<li><strong>定时管理:</strong> 定时管理页面可编辑、上线/下线、删除定时。</li>
-<li><strong>删除:</strong> 删除工作流定义。</li>
+<li><strong>删除:</strong>
删除工作流定义。在同一个项目中,只能删除自己创建的工作流定义,其他用户的工作流定义不能进行删除,如果需要删除请联系创建用户或者管理员。</li>
<li><strong>下载:</strong> 下载工作流定义到本地。</li>
<li><strong>树形图:</strong> 以树形结构展示任务节点的类型及任务状态,如下图所示:</li>
</ul>
diff --git a/zh-cn/docs/dev/user_doc/guide/project/workflow-definition.json
b/zh-cn/docs/dev/user_doc/guide/project/workflow-definition.json
index d14e13e09..c66ea1bcf 100644
--- a/zh-cn/docs/dev/user_doc/guide/project/workflow-definition.json
+++ b/zh-cn/docs/dev/user_doc/guide/project/workflow-definition.json
@@ -1,6 +1,6 @@
{
"filename": "workflow-definition.md",
- "__html":
"<h1>工作流定义</h1>\n<h2>创建工作流定义</h2>\n<ul>\n<li>\n<p>点击项目管理->工作流->工作流定义,进入工作流定义页面,点击“创建工作流”按钮,进入<strong>工作流DAG编辑</strong>页面,如下图所示:</p>\n<p><img
src=\"/img/new_ui/dev/project/workflow-dag.png\"
alt=\"workflow-dag\"></p>\n</li>\n<li>\n<p>工具栏中拖拽 <img
src=\"/img/tasks/icons/shell.png\" width=\"15\"/>
到画板中,新增一个Shell任务,如下图所示:</p>\n<p><img src=\"/img/tasks/demo/shell.jpg\"
alt=\"demo-shell-simple\"></p>\n</li>\n<li>\n<p><strong>添加 Shell
任务的参数设置:</strong></p>\n<ol>\n<li>填写“节点名称”,“ [...]
+ "__html":
"<h1>工作流定义</h1>\n<h2>创建工作流定义</h2>\n<ul>\n<li>\n<p>点击项目管理->工作流->工作流定义,进入工作流定义页面,点击“创建工作流”按钮,进入<strong>工作流DAG编辑</strong>页面,如下图所示:</p>\n<p><img
src=\"/img/new_ui/dev/project/workflow-dag.png\"
alt=\"workflow-dag\"></p>\n</li>\n<li>\n<p>工具栏中拖拽 <img
src=\"/img/tasks/icons/shell.png\" width=\"15\"/>
到画板中,新增一个Shell任务,如下图所示:</p>\n<p><img src=\"/img/tasks/demo/shell.jpg\"
alt=\"demo-shell-simple\"></p>\n</li>\n<li>\n<p><strong>添加 Shell
任务的参数设置:</strong></p>\n<ol>\n<li>填写“节点名称”,“ [...]
"link":
"/dist/zh-cn/docs/dev/user_doc/guide/project/workflow-definition.html",
"meta": {}
}
\ No newline at end of file
diff --git a/zh-cn/docs/dev/user_doc/guide/task/mlflow.html
b/zh-cn/docs/dev/user_doc/guide/task/mlflow.html
index a3964dece..fdf3e3ede 100644
--- a/zh-cn/docs/dev/user_doc/guide/task/mlflow.html
+++ b/zh-cn/docs/dev/user_doc/guide/task/mlflow.html
@@ -21,11 +21,11 @@
</ul>
<p>目前 Mlflow 组件支持的和即将支持的内容如下中:</p>
<ul>
-<li>[ ] MLflow Projects
+<li>[x] MLflow Projects
<ul>
-<li>[x] BasicAlgorithm: 基础算法,包含lr, svm, lightgbm, xgboost。</li>
+<li>[x] BasicAlgorithm: 基础算法,包含LogisticRegression, svm, lightgbm, xgboost。</li>
<li>[x] AutoML: AutoML工具,包含autosklean, flaml。</li>
-<li>[ ] Custom projects: 支持运行自己的MLflow Projects项目</li>
+<li>[x] Custom projects: 支持运行自己的MLflow Projects项目</li>
</ul>
</li>
<li>[ ] MLflow Models
@@ -70,8 +70,7 @@
<p><strong>任务参数</strong></p>
<ul>
<li><strong>mlflow server tracking uri</strong> :MLflow server 的连接, 默认 <a
href="http://localhost:5000">http://localhost:5000</a>。</li>
-<li><strong>任务类型</strong> : 运行的任务类型,目前包括基础算法与AutoML, 后续将会支持用户自定义的MLflow
Project。</li>
-<li><strong>实验名称</strong> :任务运行时所在的实验,若无则创建。</li>
+<li><strong>实验名称</strong>
:任务运行时所在的实验,若实验不存在,则创建。若实验名称为空,则设置为<code>Default</code>, 与 MLflow 一样。</li>
<li><strong>注册模型</strong> :是否注册模型,若选择注册,则会展开以下参数。
<ul>
<li><strong>注册的模型名称</strong> : 注册的模型名称,会在原来的基础上加上一个模型版本,并注册为Production。</li>
@@ -80,7 +79,7 @@
<li><strong>数据路径</strong> : 文件/文件夹的绝对路径, 若文件需以.csv结尾(自动切分训练集与测试集),
文件夹需包含train.csv和test.csv(建议方式,用户应自行构建测试集用于模型评估)。
详细的参数列表如下:
<ul>
-<li><a
href="https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html#sklearn.linear_model.LogisticRegression">lr</a></li>
+<li><a
href="https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html#sklearn.linear_model.LogisticRegression">LogisticRegression</a></li>
<li><a
href="https://scikit-learn.org/stable/modules/generated/sklearn.svm.SVC.html?highlight=svc#sklearn.svm.SVC">SVM</a></li>
<li><a
href="https://lightgbm.readthedocs.io/en/latest/pythonapi/lightgbm.LGBMClassifier.html#lightgbm.LGBMClassifier">lightgbm</a></li>
<li><a
href="https://xgboost.readthedocs.io/en/stable/python/python_api.html#xgboost.XGBClassifier">xgboost</a></li>
@@ -94,8 +93,7 @@
<p><strong>任务参数</strong></p>
<ul>
<li><strong>mlflow server tracking uri</strong> :MLflow server 的连接, 默认 <a
href="http://localhost:5000">http://localhost:5000</a>。</li>
-<li><strong>任务类型</strong> : 运行的任务类型,目前包括基础算法与AutoML, 后续将会支持用户自定义的MLflow
Project。</li>
-<li><strong>实验名称</strong> :任务运行时所在的实验,若无则创建。</li>
+<li><strong>实验名称</strong>
:任务运行时所在的实验,若实验不存在,则创建。若实验名称为空,则设置为<code>Default</code>, 与 MLflow 一样。</li>
<li><strong>注册模型</strong> :是否注册模型,若选择注册,则会展开以下参数。
<ul>
<li><strong>注册的模型名称</strong> : 注册的模型名称,会在原来的基础上加上一个模型版本,并注册为Production。</li>
@@ -111,6 +109,19 @@
<li><strong>AutoML工具</strong> : 使用的AutoML工具,目前支持 <a
href="https://github.com/automl/auto-sklearn">autosklearn</a>
, <a href="https://github.com/microsoft/FLAML">flaml</a></li>
</ul>
+<h4>Custom projects</h4>
+<p><img src="/img/tasks/demo/mlflow-custom-project-template.png"
alt="mlflow-custom-project-template.png"></p>
+<p><strong>任务参数</strong></p>
+<ul>
+<li><strong>mlflow server tracking uri</strong> :MLflow server 的连接, 默认 <a
href="http://localhost:5000">http://localhost:5000</a>。</li>
+<li><strong>实验名称</strong>
:任务运行时所在的实验,若实验不存在,则创建。若实验名称为空,则设置为<code>Default</code>, 与 MLflow 一样。</li>
+<li><strong>参数</strong> : <code>mlflow run</code>中的 --param-list 如 <code>-P
learning_rate=0.2 -P colsample_bytree=0.8 -P subsample=0.9</code></li>
+<li><strong>运行仓库</strong> : MLflow Project的仓库地址,可以为github地址,或者worker上的目录,
如Mlflow project位于子目录,可以添加 <code>#</code> 隔开, 如
<code>https://github.com/mlflow/mlflow#examples/xgboost/xgboost_native</code></li>
+<li><strong>项目版本</strong> : 对应项目中git版本管理中的版本,默认 master</li>
+</ul>
+<p>现在你可以使用这个功能来运行github上所有的MLflow Projects (如 <a
href="https://github.com/mlflow/mlflow/tree/master/examples">MLflow
examples</a>
)了。你也可以创建自己的机器学习库,用来复用你的研究成果,以后你就可以使用DolphinScheduler来一键操作使用你的算法库。</p>
+<p>实际运行界面如下</p>
+<p><img src="/img/tasks/demo/mlflow-custom-project.png"
alt="mlflow-custom-project.png"></p>
<h3>MLflow Models</h3>
<h4>MLFLOW</h4>
<p><img src="/img/tasks/demo/mlflow-models-mlflow.png"
alt="mlflow-models-mlflow"></p>
diff --git a/zh-cn/docs/dev/user_doc/guide/task/mlflow.json
b/zh-cn/docs/dev/user_doc/guide/task/mlflow.json
index dfe7374b2..86e4c8c40 100644
--- a/zh-cn/docs/dev/user_doc/guide/task/mlflow.json
+++ b/zh-cn/docs/dev/user_doc/guide/task/mlflow.json
@@ -1,6 +1,6 @@
{
"filename": "mlflow.md",
- "__html": "<h1>MLflow节点</h1>\n<h2>综述</h2>\n<p><a
href=\"https://mlflow.org\">MLflow</a> 是一个MLops领域一个优秀的开源项目,
用于管理机器学习的生命周期,包括实验、可再现性、部署和中心模型注册。</p>\n<p>MLflow 组件用于执行 MLflow 任务,目前包含Mlflow
Projects, 和MLflow Models。(Model Registry将在不就的将来支持)</p>\n<ul>\n<li>Mlflow
Projects: 将代码打包,并可以运行到任务的平台上。</li>\n<li>MLflow Models:
在不同的服务环境中部署机器学习模型。</li>\n<li>Model Registry: 在一个中央存储库中存储、注释、发现和管理模型
(你也可以在你的mlflow project 里面自行注册模型)。</li>\n</ul>\n<p>目前 Mlflow
组件支持的和即将支持的内容如下中:</p>\n<ul>\n<li>[ ] MLflow Pro [...]
+ "__html": "<h1>MLflow节点</h1>\n<h2>综述</h2>\n<p><a
href=\"https://mlflow.org\">MLflow</a> 是一个MLops领域一个优秀的开源项目,
用于管理机器学习的生命周期,包括实验、可再现性、部署和中心模型注册。</p>\n<p>MLflow 组件用于执行 MLflow 任务,目前包含Mlflow
Projects, 和MLflow Models。(Model Registry将在不就的将来支持)</p>\n<ul>\n<li>Mlflow
Projects: 将代码打包,并可以运行到任务的平台上。</li>\n<li>MLflow Models:
在不同的服务环境中部署机器学习模型。</li>\n<li>Model Registry: 在一个中央存储库中存储、注释、发现和管理模型
(你也可以在你的mlflow project 里面自行注册模型)。</li>\n</ul>\n<p>目前 Mlflow
组件支持的和即将支持的内容如下中:</p>\n<ul>\n<li>[x] MLflow Pro [...]
"link": "/dist/zh-cn/docs/dev/user_doc/guide/task/mlflow.html",
"meta": {}
}
\ No newline at end of file