[
https://issues.apache.org/jira/browse/SUBMARINE-921?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
ASF GitHub Bot updated SUBMARINE-921:
-------------------------------------
Labels: pull-request-available (was: )
> [User] Refactor User docs
> -------------------------
>
> Key: SUBMARINE-921
> URL: https://issues.apache.org/jira/browse/SUBMARINE-921
> Project: Apache Submarine
> Issue Type: Sub-task
> Reporter: Byron Hsu
> Assignee: Byron Hsu
> Priority: Major
> Labels: pull-request-available
>
> h3. Changes
> Old:
> {code:java}
> .
> └── Users Docs/
> ├── Submarine on Kubernetes/
> │ └── ...
> ├── Submarine on Yarn/
> │ └── ...
> ├── Submarine SDK/
> │ └── ...
> └── Submarine Security/
> └── ...
> {code}
> New:
> {code:java}
> .
> └── 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{code}
> h3. 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.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
