This is an automated email from the ASF dual-hosted git repository.
byronhsu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/submarine.git
The following commit(s) were added to refs/heads/master by this push:
new b561511 SUBMARINE-921. [User] Refactor User docs
b561511 is described below
commit b56151187685b0ef13b5a1a4d90c4d06a3602537
Author: ByronHsu <[email protected]>
AuthorDate: Mon Jul 12 12:05:20 2021 +0800
SUBMARINE-921. [User] Refactor User docs
### What is this PR for?
Refactor the "user" page of website.
**For visualized structural changes:**
Old:
```
.
└── Users Docs/
├── Submarine on Kubernetes/
│ └── ...
├── Submarine on Yarn/
│ └── ...
├── Submarine SDK/
│ └── ...
└── Submarine Security/
└── ...
```
New:
```
.
└── Users Docs/
├── API documentation/
│ ├── Experiment REST API
│ ├── Experiment Template REST API
│ ├── Environment REST API
│ └── Notebook REST API
└── Submarine SDK/
├── Experiment Client
├── Model Client
└── Tracking (deprecated)
├── Submarine Security/
│ └── ...
└── Other utilities/
└── MLflow UI
└── Tensorboard
```
**Details**
1. Remove "Submarine on Yarn" because Yarn is deprecated.
2. Rename "Submarine on Kubernetes" to "API "documentation", categorized
into four classes: "Experiment REST API", "Experiment Template REST API",
"Environment REST API", and "Notebook REST API". For each API endpoint, provide
spec and examples. (refer to https://docs.github.com/en/rest/reference/actions)
3. Refactor "Submarine-SDK", categorized into three classes: "Experiment
Client", "Model Client" and "Tracking". For each class, provide the spec and
examples. (refer to https://mlflow.org/docs/latest/python_api/mlflow.html)
4. Add "Other utilities" to provide the details of how to use tensorboard
and mlflow UI.
5. Keep "Submarine Security" intact.
### What type of PR is it?
[Documentation]
### Todos
* [ ] - Task
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-921
### How should this be tested?
### Screenshots (if appropriate)
### Questions:
* Do the license files need updating? No
* Are there breaking changes for older versions? No
* Does this need new documentation? No
Author: ByronHsu <[email protected]>
Signed-off-by: byronhsu <[email protected]>
Closes #662 from ByronHsu/refactor-user-page and squashes the following
commits:
72e25380 [ByronHsu] revise gitignore to include mlflow md
5520d00a [ByronHsu] add empty pages
---
.gitignore | 6 +---
website/docs/userDocs/api/environment.md | 22 ++++++++++++
website/docs/userDocs/api/experiment-template.md | 22 ++++++++++++
website/docs/userDocs/api/experiment.md | 22 ++++++++++++
website/docs/userDocs/api/notebook.md | 22 ++++++++++++
website/docs/userDocs/others/mlflow.md | 22 ++++++++++++
website/docs/userDocs/others/tensorboard.md | 22 ++++++++++++
.../userDocs/submarine-sdk/experiment-client.md | 22 ++++++++++++
.../docs/userDocs/submarine-sdk/model-client.md | 22 ++++++++++++
website/docs/userDocs/submarine-sdk/tracking.md | 22 ++++++++++++
website/sidebars.js | 39 ++++++++++------------
11 files changed, 217 insertions(+), 26 deletions(-)
diff --git a/.gitignore b/.gitignore
index 04fb86b..1bd36f5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -102,8 +102,4 @@ submarine-cloud-v2/charts/*
.ipynb_checkpoints
# redundant logging files
-*.log
-
-# mlflow
-mlruns/
-mlflow*
+*.log
\ No newline at end of file
diff --git a/website/docs/userDocs/api/environment.md
b/website/docs/userDocs/api/environment.md
new file mode 100644
index 0000000..3b4c666
--- /dev/null
+++ b/website/docs/userDocs/api/environment.md
@@ -0,0 +1,22 @@
+---
+title: Environment REST API
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
diff --git a/website/docs/userDocs/api/experiment-template.md
b/website/docs/userDocs/api/experiment-template.md
new file mode 100644
index 0000000..883e109
--- /dev/null
+++ b/website/docs/userDocs/api/experiment-template.md
@@ -0,0 +1,22 @@
+---
+title: Experiment Template REST API
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
diff --git a/website/docs/userDocs/api/experiment.md
b/website/docs/userDocs/api/experiment.md
new file mode 100644
index 0000000..3befe01
--- /dev/null
+++ b/website/docs/userDocs/api/experiment.md
@@ -0,0 +1,22 @@
+---
+title: Experiment REST API
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
diff --git a/website/docs/userDocs/api/notebook.md
b/website/docs/userDocs/api/notebook.md
new file mode 100644
index 0000000..96f6c87
--- /dev/null
+++ b/website/docs/userDocs/api/notebook.md
@@ -0,0 +1,22 @@
+---
+title: Notebook REST API
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
diff --git a/website/docs/userDocs/others/mlflow.md
b/website/docs/userDocs/others/mlflow.md
new file mode 100644
index 0000000..801a1b2
--- /dev/null
+++ b/website/docs/userDocs/others/mlflow.md
@@ -0,0 +1,22 @@
+---
+title: Mlflow UI
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
diff --git a/website/docs/userDocs/others/tensorboard.md
b/website/docs/userDocs/others/tensorboard.md
new file mode 100644
index 0000000..101f5cf
--- /dev/null
+++ b/website/docs/userDocs/others/tensorboard.md
@@ -0,0 +1,22 @@
+---
+title: Tensorboard
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
diff --git a/website/docs/userDocs/submarine-sdk/experiment-client.md
b/website/docs/userDocs/submarine-sdk/experiment-client.md
new file mode 100644
index 0000000..4448dbb
--- /dev/null
+++ b/website/docs/userDocs/submarine-sdk/experiment-client.md
@@ -0,0 +1,22 @@
+---
+title: Experiment Client
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
diff --git a/website/docs/userDocs/submarine-sdk/model-client.md
b/website/docs/userDocs/submarine-sdk/model-client.md
new file mode 100644
index 0000000..73d69cc
--- /dev/null
+++ b/website/docs/userDocs/submarine-sdk/model-client.md
@@ -0,0 +1,22 @@
+---
+title: Model Client
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
diff --git a/website/docs/userDocs/submarine-sdk/tracking.md
b/website/docs/userDocs/submarine-sdk/tracking.md
new file mode 100644
index 0000000..072ab5b
--- /dev/null
+++ b/website/docs/userDocs/submarine-sdk/tracking.md
@@ -0,0 +1,22 @@
+---
+title: Tracking
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
diff --git a/website/sidebars.js b/website/sidebars.js
index 9364a9e..95af05d 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -20,7 +20,7 @@
module.exports = {
docs: [
{
- Introduction: [],
+ "Introduction": [],
"Getting Started": [
"gettingStarted/localDeployment",
"gettingStarted/notebook",
@@ -28,27 +28,18 @@ module.exports = {
],
"User Docs": [
{
- "Submarine on Kubernetes": [
- "userDocs/k8s/run-experiment-template-rest",
- "userDocs/k8s/run-pytorch-experiment-rest",
- "userDocs/k8s/run-tensorflow-experiment-rest",
- "userDocs/k8s/how-to-use-tensorboard",
- ],
- },
- {
- "Submarine on Yarn": [
- "userDocs/yarn/YARNRuntimeGuide",
- "userDocs/yarn/TestAndTroubleshooting",
- "userDocs/yarn/Dockerfiles",
- "userDocs/yarn/WriteDockerfileMX",
- "userDocs/yarn/WriteDockerfilePT",
- "userDocs/yarn/WriteDockerfileTF",
+ "API documentation": [
+ "userDocs/api/experiment",
+ "userDocs/api/environment",
+ "userDocs/api/experiment-template",
+ "userDocs/api/notebook",
],
},
{
"Submarine SDK": [
- "userDocs/submarine-sdk/pysubmarine/development",
- "userDocs/submarine-sdk/pysubmarine/tracking",
+ "userDocs/submarine-sdk/experiment-client",
+ "userDocs/submarine-sdk/model-client",
+ "userDocs/submarine-sdk/tracking",
],
},
{
@@ -57,6 +48,12 @@ module.exports = {
"userDocs/submarine-security/spark-security/build-submarine-spark-security-plugin",
],
},
+ {
+ "Others": [
+ "userDocs/others/mlflow",
+ "userDocs/others/tensorboard",
+ ],
+ },
],
"Administrator Docs": [
{
@@ -69,7 +66,7 @@ module.exports = {
"devDocs/Development",
"devDocs/IntegrationTest",
],
- Community: [
+ "Community": [
"community/README",
"community/HowToCommit",
"community/contributing",
@@ -95,13 +92,13 @@ module.exports = {
],
},
],
- Releases: [
+ "Releases": [
"releases/submarine-release-0.2.0",
"releases/submarine-release-0.3.0",
"releases/submarine-release-0.4.0",
"releases/submarine-release-0.5.0",
],
- RoadMap: [],
+ "RoadMap": [],
},
],
api: [
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
