This is an automated email from the ASF dual-hosted git repository.
liuxun 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 78f60e3 SUBMARINE-545. Changes of top level K8s README to make it
easier to read
78f60e3 is described below
commit 78f60e3d9d628c79b863bb07f711975ad5fe0075
Author: Wangda Tan <[email protected]>
AuthorDate: Wed Jun 24 17:53:25 2020 -0700
SUBMARINE-545. Changes of top level K8s README to make it easier to read
### What is this PR for?
* Changes of top level K8s README.
### What type of PR is it?
[Document]
### Todos
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-545
### 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? Yes
Author: Wangda Tan <[email protected]>
Closes #328 from wangdatan/SUBMARINE-545 and squashes the following commits:
ef00bb9 [Wangda Tan] Changes of top level K8s README to make it easier to
read
---
docs/userdocs/k8s/README.md | 45 +++++++++++++++++++++++++++++++++++----------
1 file changed, 35 insertions(+), 10 deletions(-)
diff --git a/docs/userdocs/k8s/README.md b/docs/userdocs/k8s/README.md
index 4733a91..b5d4ab9 100644
--- a/docs/userdocs/k8s/README.md
+++ b/docs/userdocs/k8s/README.md
@@ -22,19 +22,40 @@ Submarine for K8s supports distributed TensorFlow and
PyTorch.
Submarine can run on K8s >= 1.14, supports features like GPU isolation.
+We have validated Submarine on the following versions:
+
+[FIXME]: is it accurate?
+
+| K8s Version | Support? |
+| ------------- |:-------------:|
+| 1.13.x (or earlier) | X |
+| 1.14.x | √ |
+| 1.15.x | √ |
+| 1.16.x | √ |
+| 1.17.x | To be verified |
+| 1.17.x | To be verified |
+
## Install Submarine
-Submarine can be deployed on any K8s environment if version matches. If you
don't have a running K8s, you can follow the steps to set up a K8s using [kind,
Kubernetes-in-Docker](https://kind.sigs.k8s.io/) for testing purpose, we
provides simple [tutorial](kind.md).
-### Use Helm Charts
+### Setup Kubernetes
+Submarine can be deployed on any K8s environment if version matches. If you
don't have a running K8s, you can set up a K8s using [Docker
Desktop](https://www.docker.com/products/docker-desktop),
[MiniKube](https://kubernetes.io/docs/tasks/tools/install-minikube/), or [kind,
Kubernetes-in-Docker](https://kind.sigs.k8s.io/).
+
+From our experiences, Docker Desktop is an easier choice.
+
+### Install Submarine Use Helm Charts
After you have an up-and-running K8s, you can follow [Submarine Helm Charts
Guide](helm.md) to deploy Submarine services on K8s cluster in minutes.
-## Use Submarine
+## Model Training (Experiment) on K8s
-### Model training (experiment) on K8s
+### Model Training With Submarine Python SDK
+
+Submarine Python SDK can runs on any machine and it will talk to Submarine
Server via REST API. So you can install Submarine Python SDK on your laptop, a
gateway machine, your favorite IDE (like PyCharm/Jupyter, etc.).
#### Prepare Python Environment to run Submarine SDK
-Submarine SDK assumes Python3.7+ is ready.
+First of all
+
+Submarine SDK requires Python3.7+.
It's better to use a new Python environment created by `Anoconda` or Python
`virtualenv` to try this to avoid trouble to existing Python environment.
A sample Python virtual env can be setup like this:
```bash
@@ -46,9 +67,9 @@ python3 virtualenv-16.0.0/virtualenv.py venv
. venv/bin/activate
```
-#### With Submarine SDK (Recommended)
+#### Install Submarine SDK
-- Install SDK from pypi.org
+**Install SDK from pypi.org (recommended)**
Starting from 0.4.0, Submarine provides Python SDK. Please change it to a
proper version needed.
@@ -56,9 +77,10 @@ Starting from 0.4.0, Submarine provides Python SDK. Please
change it to a proper
pip install submarine-sdk==0.4.0
```
-- Install SDK from source code
+**Install SDK from source code**
Please first clone code from github or go to
`http://submarine.apache.org/download.html` to download released source code.
+
```bash
git clone https://github.com/apache/submarine.git
git checkout <correct release tag/branch>
@@ -66,13 +88,16 @@ cd submarine/submarine-sdk/pysubmarine
pip install .
```
-- Run with Submarine Python SDK
+#### Run with Submarine Python SDK
Assuming you've installed submarine on K8s and forward the service to
localhost, now you can open a Python shell, Jupyter notebook or any tools with
Submarine SDK installed.
Follow [SDK experiment
example](../../../submarine-sdk/pysubmarine/example/submarine_experiment_sdk.ipynb)
to try the SDK.
-#### With REST API
+### Model Training With Submarine REST API
+
+Alternatively, we support use REST API to submit, list, delete experiments
(model training)
+
- [Run model training using Tensorflow](run-tensorflow-experiment.md)
- [Run model training using PyTorch](run-pytorch-experiment.md)
- [Experiment API Reference](api/experiment.md)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
