You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@submarine.apache.org by GitBox <gi...@apache.org> on 2020/09/13 11:25:25 UTC
[GitHub] [submarine] JohnTing opened a new pull request #399: SUBMARINE-622. Experiment Template API docs
JohnTing opened a new pull request #399:
URL: https://github.com/apache/submarine/pull/399
### What is this PR for?
Write a Experiment Template API docs to docs/userdocs/k8s/api/experiment-template.md
and docs/userdocs/k8s/run-experiment-template.md
### What type of PR is it?
Improvement
### Todos
* [ ] - experiment-template.md
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-622
### How should this be tested?
### Screenshots (if appropriate)
### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] jiwq commented on a change in pull request #399: SUBMARINE-622. Experiment Template API docs
Posted by GitBox <gi...@apache.org>.
jiwq commented on a change in pull request #399:
URL: https://github.com/apache/submarine/pull/399#discussion_r488001356
##########
File path: docs/userdocs/k8s/api/experiment-template.md
##########
@@ -114,29 +165,36 @@ curl -X POST -H "Content-Type: application/json" -d '
}
}
}
-' http://127.0.0.1:8080/api/v1/template
+' http://127.0.0.1:8080/api/v1/template/my-tf-mnist-template
```
-JSON Format example:
-```json
-{
- "name": "tf-mnist-test",
- "params": {
- "training.learning_rate":"0.01",
- "training.batch_size":"150"
- }
-}
+> "description", "parameters", "experimentSpec", "author" etc can be updated using this API.
+"name" of experiment template is not supported.
+
+
+
+### Delete environment
+`GET /api/v1/environment/{name}`
Review comment:
```suggestion
`GET /api/v1/template/{name}`
```
##########
File path: docs/userdocs/k8s/api/experiment-template.md
##########
@@ -114,29 +165,36 @@ curl -X POST -H "Content-Type: application/json" -d '
}
}
}
-' http://127.0.0.1:8080/api/v1/template
+' http://127.0.0.1:8080/api/v1/template/my-tf-mnist-template
```
-JSON Format example:
-```json
-{
- "name": "tf-mnist-test",
- "params": {
- "training.learning_rate":"0.01",
- "training.batch_size":"150"
- }
-}
+> "description", "parameters", "experimentSpec", "author" etc can be updated using this API.
+"name" of experiment template is not supported.
+
+
+
+### Delete environment
Review comment:
```suggestion
### Delete template
```
##########
File path: docs/userdocs/k8s/api/experiment-template.md
##########
@@ -114,29 +165,36 @@ curl -X POST -H "Content-Type: application/json" -d '
}
}
}
-' http://127.0.0.1:8080/api/v1/template
+' http://127.0.0.1:8080/api/v1/template/my-tf-mnist-template
```
-JSON Format example:
-```json
-{
- "name": "tf-mnist-test",
- "params": {
- "training.learning_rate":"0.01",
- "training.batch_size":"150"
- }
-}
+> "description", "parameters", "experimentSpec", "author" etc can be updated using this API.
+"name" of experiment template is not supported.
+
+
+
+### Delete environment
+`GET /api/v1/environment/{name}`
+
+**Example Request:**
+```sh
+curl -X DELETE http://127.0.0.1:8080/api/v1/template/my-tf-mnist-template
```
-### Submit experiment template
+
+### Use experiment template to create a experiment
+`POST /api/v1/environment/{name}`
Review comment:
```suggestion
`POST /api/v1/experiment/{template_name}`
```
##########
File path: docs/userdocs/k8s/api/experiment-template.md
##########
@@ -114,29 +165,36 @@ curl -X POST -H "Content-Type: application/json" -d '
}
}
}
-' http://127.0.0.1:8080/api/v1/template
+' http://127.0.0.1:8080/api/v1/template/my-tf-mnist-template
```
-JSON Format example:
-```json
-{
- "name": "tf-mnist-test",
- "params": {
- "training.learning_rate":"0.01",
- "training.batch_size":"150"
- }
-}
+> "description", "parameters", "experimentSpec", "author" etc can be updated using this API.
+"name" of experiment template is not supported.
+
+
+
+### Delete environment
+`GET /api/v1/environment/{name}`
+
+**Example Request:**
+```sh
+curl -X DELETE http://127.0.0.1:8080/api/v1/template/my-tf-mnist-template
```
-### Submit experiment template
+
+### Use experiment template to create a experiment
Review comment:
```suggestion
### Use template to create a experiment
```
##########
File path: docs/userdocs/k8s/api/experiment-template.md
##########
@@ -66,33 +92,58 @@ JSON Format example:
}
}
}
+' http://127.0.0.1:8080/api/v1/template
+```
+
+
+### List experiment template
+`GET /api/v1/template`
+
+**Example Request:**
+```sh
+curl -X GET http://127.0.0.1:8080/api/v1/template
```
-### Register experiment template
+### Get experiment template
+`GET /api/v1/template/{name}`
+
+**Example Request:**
```sh
-curl -X POST -H "Content-Type: application/json" -d '
+curl -X GET http://127.0.0.1:8080/api/v1/template/my-tf-mnist-template
+```
+
+
+### Patch environment
Review comment:
```suggestion
### Patch template
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] asfgit closed pull request #399: SUBMARINE-622. Experiment Template API docs
Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #399:
URL: https://github.com/apache/submarine/pull/399
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org