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/06/25 00:54:52 UTC

[GitHub] [submarine] wangdatan opened a new pull request #328: SUBMARINE-545. Changes of top level K8s README to make it easier to read

wangdatan opened a new pull request #328:
URL: https://github.com/apache/submarine/pull/328


   Changes to documentation.


----------------------------------------------------------------
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 #328: SUBMARINE-545. Changes of top level K8s README to make it easier to read

Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #328:
URL: https://github.com/apache/submarine/pull/328


   


----------------------------------------------------------------
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] pingsutw commented on a change in pull request #328: SUBMARINE-545. Changes of top level K8s README to make it easier to read

Posted by GitBox <gi...@apache.org>.
pingsutw commented on a change in pull request #328:
URL: https://github.com/apache/submarine/pull/328#discussion_r450137812



##########
File path: docs/userdocs/k8s/README.md
##########
@@ -46,33 +67,37 @@ 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.
 
 ```bash
 pip install submarine-sdk==0.4.0

Review comment:
       I've upload `apache-submarine` to PyPi
   https://pypi.org/project/apache-submarine/




----------------------------------------------------------------
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] wangdatan commented on a change in pull request #328: SUBMARINE-545. Changes of top level K8s README to make it easier to read

Posted by GitBox <gi...@apache.org>.
wangdatan commented on a change in pull request #328:
URL: https://github.com/apache/submarine/pull/328#discussion_r445251929



##########
File path: 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?

Review comment:
       @tangzhankun , @jiwq , @pingsutw : What we should put for supported versions?




----------------------------------------------------------------
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] pingsutw commented on a change in pull request #328: SUBMARINE-545. Changes of top level K8s README to make it easier to read

Posted by GitBox <gi...@apache.org>.
pingsutw commented on a change in pull request #328:
URL: https://github.com/apache/submarine/pull/328#discussion_r450137812



##########
File path: docs/userdocs/k8s/README.md
##########
@@ -46,33 +67,37 @@ 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.
 
 ```bash
 pip install submarine-sdk==0.4.0

Review comment:
       I've uploaded `apache-submarine` to PyPi
   https://pypi.org/project/apache-submarine/




----------------------------------------------------------------
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 #328: SUBMARINE-545. Changes of top level K8s README to make it easier to read

Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #328:
URL: https://github.com/apache/submarine/pull/328






----------------------------------------------------------------
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 #328: SUBMARINE-545. Changes of top level K8s README to make it easier to read

Posted by GitBox <gi...@apache.org>.
jiwq commented on a change in pull request #328:
URL: https://github.com/apache/submarine/pull/328#discussion_r445381022



##########
File path: 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?

Review comment:
       LGTM, I had verified 14/15/16 version.

##########
File path: 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 |

Review comment:
       ```suggestion
   | 1.18.x | To be verified |
   ```




----------------------------------------------------------------
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] wangdatan commented on pull request #328: SUBMARINE-545. Changes of top level K8s README to make it easier to read

Posted by GitBox <gi...@apache.org>.
wangdatan commented on pull request #328:
URL: https://github.com/apache/submarine/pull/328#issuecomment-649150562


   @jiwq, @tangzhankun can you help to review it? Mostly it is cosmetic changes. And it changed text about how to set up local K8s cluster a bit.


----------------------------------------------------------------
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] pingsutw commented on a change in pull request #328: SUBMARINE-545. Changes of top level K8s README to make it easier to read

Posted by GitBox <gi...@apache.org>.
pingsutw commented on a change in pull request #328:
URL: https://github.com/apache/submarine/pull/328#discussion_r446835645



##########
File path: docs/userdocs/k8s/README.md
##########
@@ -46,33 +67,37 @@ 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.
 
 ```bash
 pip install submarine-sdk==0.4.0

Review comment:
       I'm ok with these two names. I prefer "pysubmarine".
   just like arrow SDK named "pyarrow"




----------------------------------------------------------------
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] tangzhankun commented on a change in pull request #328: SUBMARINE-545. Changes of top level K8s README to make it easier to read

Posted by GitBox <gi...@apache.org>.
tangzhankun commented on a change in pull request #328:
URL: https://github.com/apache/submarine/pull/328#discussion_r446765721



##########
File path: docs/userdocs/k8s/README.md
##########
@@ -46,33 +67,37 @@ 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.
 
 ```bash
 pip install submarine-sdk==0.4.0

Review comment:
       @pingsutw @wangdatan which name should we use? "pysubmarine" or "submarine-sdk"?




----------------------------------------------------------------
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 #328: SUBMARINE-545. Changes of top level K8s README to make it easier to read

Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #328:
URL: https://github.com/apache/submarine/pull/328






----------------------------------------------------------------
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 #328: SUBMARINE-545. Changes of top level K8s README to make it easier to read

Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #328:
URL: https://github.com/apache/submarine/pull/328


   


----------------------------------------------------------------
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] pingsutw commented on a change in pull request #328: SUBMARINE-545. Changes of top level K8s README to make it easier to read

Posted by GitBox <gi...@apache.org>.
pingsutw commented on a change in pull request #328:
URL: https://github.com/apache/submarine/pull/328#discussion_r445937758



##########
File path: 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+.

Review comment:
       ```suggestion
   Submarine SDK requires Python3.5+.
   ```
   We support Python 3.5, 3.6, 3.7.
   Tensorflow is not compatible with python3.8, so if they use deepfm or other predefined ctr models, they will get the error. 




----------------------------------------------------------------
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] lowc1012 commented on a change in pull request #328: SUBMARINE-545. Changes of top level K8s README to make it easier to read

Posted by GitBox <gi...@apache.org>.
lowc1012 commented on a change in pull request #328:
URL: https://github.com/apache/submarine/pull/328#discussion_r445975438



##########
File path: docs/userdocs/k8s/README.md
##########
@@ -46,33 +67,37 @@ 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.
 
 ```bash
 pip install submarine-sdk==0.4.0

Review comment:
       pip install pysubmarine==0.4.0




----------------------------------------------------------------
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