ByronHsu opened a new pull request #662:
URL: https://github.com/apache/submarine/pull/662
### What is this PR for?
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
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
