101 tutorial document #1124

QiJune · 2019-09-05T07:59:00Z

terrytangyuan · 2019-09-09T14:40:06Z

elasticdl/doc/tutorials/101.md

+
+## ElasticDL on cluster
+
+TBD


This PR doesn't seem ready for review yet?

I will add it later

terrytangyuan · 2019-09-09T14:43:20Z

elasticdl/doc/tutorials/elasticdl_local.md

+```bash
+brew install kubectl
+brew cask install minikube
+brew install docker-machine-driver-hyperkit


Should we just link to minikube installation documentation? (users may not want to use brew) Also users should just select their own driver (users may not want to use this driver). We can point to a reference to hyperkit if needed.

Yes, I will remove it.

terrytangyuan · 2019-09-09T14:45:10Z

elasticdl/doc/tutorials/elasticdl_local.md

+
+## Environment prepare
+
+Here, we use macbook as our expriment environment.


We don't need to mention this if we just put a reference to minikube installation guide.

terrytangyuan · 2019-09-09T14:45:33Z

elasticdl/doc/tutorials/elasticdl_local.md

+
+## Write model file
+
+We use Tensorflow Keras API to build our models. For details, please refer to [ModelBuilding](https://github.com/sql-machine-learning/elasticdl/blob/develop/elasticdl/doc/model_building.md) part.


Remove "part".

"Please refer to this tutorial on model building for details."

terrytangyuan · 2019-09-09T14:48:32Z

elasticdl/doc/tutorials/elasticdl_local.md

+### Summit a training job
+
+
+You have to set right docker environment. Please run `minikube docker-env` to get docker host url and docker cert path.


"You have to set right docker environment" -> "There are other docker settings that you might also want to configure prior to submitting the training job"

terrytangyuan · 2019-09-09T14:48:49Z

elasticdl/doc/tutorials/elasticdl_local.md

+  --output=model_output
+```
+
+After summit the job to minikubes, you can run following command to check the status of each pod:


minikubes -> minikube
summit -> submitting

terrytangyuan · 2019-09-09T14:49:53Z

elasticdl/doc/tutorials/elasticdl_local.md

+kubectl get pods
+```
+
+You will get messages like this:


"You should see information on each pod like the following"

terrytangyuan · 2019-09-09T14:50:37Z

elasticdl/doc/tutorials/101.md

@@ -0,0 +1,35 @@
+# 101 Tutorial
+
+101 tutorial contains a series of documents which covers ElasticDL usage under different scenarios: local computer/private cluster/public cloud. It aims to help users get hands on quickly and have a preliminary understanding of ElasticDL.


101 tutorial -> this tutorial

terrytangyuan · 2019-09-09T14:51:10Z

elasticdl/doc/tutorials/101.md

@@ -0,0 +1,35 @@
+# 101 Tutorial
+
+101 tutorial contains a series of documents which covers ElasticDL usage under different scenarios: local computer/private cluster/public cloud. It aims to help users get hands on quickly and have a preliminary understanding of ElasticDL.


use markdown bullets for these scenarios

terrytangyuan · 2019-09-09T14:52:00Z

elasticdl/doc/tutorials/101.md

+
+## ElasticDL on local
+
+Minikube is a tool that makes it easy to run Kubernetes locally. Minikube runs a single-node Kubernetes cluster inside a Virtual Machine (VM) on your laptop for users looking to try out Kubernetes or develop with it day-to-day. Here we use Minikube to run ElasticDL in local laptop.


Inconsistent uses of "you" and "users". Better to be consistent across the doc

terrytangyuan · 2019-09-09T14:55:40Z

elasticdl/doc/tutorials/101.md

@@ -0,0 +1,35 @@
+# 101 Tutorial


I feel like it's better to be called "Getting Started with ElasticDL" similar to https://www.tensorflow.org/tutorials. "101" seems a bit informal and people from other countries may not understand what this means.

terrytangyuan · 2019-09-11T13:29:01Z

elasticdl/doc/tutorials/elasticdl_cluster.md

+ --image_base=elasticdl:ci \
+ --cluster_spec=$CLUSTER_SPEC \
+ --model_zoo=./model_zoo \
+ --docker_image_prefix=$DOCKER_HUB_REPO \


Readers might be confused about what DOCKER_HUB_REPO and CLUSTER_SPEC refers to. Perhaps add some descriptions on those

terrytangyuan · 2019-09-11T13:29:20Z

elasticdl/doc/tutorials/elasticdl_cluster.md

+
+You should install ElasticDL first. Please refer to the installation part in [elastic_local](./elasticdl_local.md) doc.
+
+Then, please build needed images.


remove "please"

terrytangyuan · 2019-09-11T13:29:56Z

elasticdl/doc/tutorials/elasticdl_cluster.md

+ --namespace=kubemaker
+```
+
+It will build a image locally and push to the remote docker hub. And then the job will be launched on the cluster.


a image -> an image
". And then" -> " and then"

terrytangyuan · 2019-09-11T13:30:30Z

elasticdl/doc/tutorials/get_started.md

+
+- https://kubernetes.io/docs/setup/learning-environment/minikube/
+
+


Remove trailing empty lines

QiJune added 2 commits September 5, 2019 14:33

init

5f42b8a

add tutorials doc

5859310

QiJune changed the title ~~101 tutorial document~~ [WIP]101 tutorial document Sep 5, 2019

QiJune added 4 commits September 5, 2019 16:14

mv elastic_scheduling to elasticdl_cloud

ae667a2

Merge remote-tracking branch 'edl/develop' into 101_doc

e0416ac

update doc

aa493c3

update

17816d9

QiJune changed the title ~~[WIP]101 tutorial document~~ 101 tutorial document Sep 9, 2019

QiJune assigned wangkuiyi, ywskycn, chunyang-wen, terrytangyuan, mhaoli and skydoorkai Sep 9, 2019

update doc

556a082

terrytangyuan reviewed Sep 9, 2019

View reviewed changes

QiJune added 3 commits September 11, 2019 15:32

Merge branch 'develop' into 101_doc

230ef5a

follow comments

295dbda

add cluster user doc

a33a188

terrytangyuan reviewed Sep 11, 2019

View reviewed changes

QiJune added 3 commits September 12, 2019 12:57

Merge remote-tracking branch 'edl/develop' into 101_doc

8500cb5

follow comments

9db8afb

update

a02dac1

terrytangyuan approved these changes Sep 12, 2019

View reviewed changes

QiJune merged commit 128d3b7 into sql-machine-learning:develop Sep 12, 2019

QiJune deleted the 101_doc branch September 12, 2019 08:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

101 tutorial document #1124

101 tutorial document #1124

QiJune commented Sep 5, 2019

terrytangyuan Sep 9, 2019

QiJune Sep 11, 2019

terrytangyuan Sep 9, 2019

QiJune Sep 11, 2019

QiJune Sep 11, 2019

terrytangyuan Sep 9, 2019

QiJune Sep 11, 2019

terrytangyuan Sep 9, 2019

terrytangyuan Sep 9, 2019

QiJune Sep 11, 2019

terrytangyuan Sep 9, 2019

QiJune Sep 11, 2019

terrytangyuan Sep 9, 2019

QiJune Sep 11, 2019

terrytangyuan Sep 9, 2019

QiJune Sep 11, 2019

terrytangyuan Sep 9, 2019

terrytangyuan Sep 9, 2019

terrytangyuan Sep 9, 2019

QiJune Sep 11, 2019

terrytangyuan Sep 9, 2019

QiJune Sep 11, 2019

terrytangyuan Sep 11, 2019

terrytangyuan Sep 11, 2019

QiJune Sep 12, 2019

terrytangyuan Sep 11, 2019

QiJune Sep 12, 2019

terrytangyuan Sep 11, 2019


		## Environment prepare

		Here, we use macbook as our expriment environment.


		## Write model file

		We use Tensorflow Keras API to build our models. For details, please refer to [ModelBuilding](https://github.com/sql-machine-learning/elasticdl/blob/develop/elasticdl/doc/model_building.md) part.

		### Summit a training job


		You have to set right docker environment. Please run `minikube docker-env` to get docker host url and docker cert path.

		@@ -0,0 +1,35 @@
		# 101 Tutorial

		101 tutorial contains a series of documents which covers ElasticDL usage under different scenarios: local computer/private cluster/public cloud. It aims to help users get hands on quickly and have a preliminary understanding of ElasticDL.


		## ElasticDL on local

		Minikube is a tool that makes it easy to run Kubernetes locally. Minikube runs a single-node Kubernetes cluster inside a Virtual Machine (VM) on your laptop for users looking to try out Kubernetes or develop with it day-to-day. Here we use Minikube to run ElasticDL in local laptop.


		You should install ElasticDL first. Please refer to the installation part in [elastic_local](./elasticdl_local.md) doc.

		Then, please build needed images.


		- https://kubernetes.io/docs/setup/learning-environment/minikube/

101 tutorial document #1124

101 tutorial document #1124

Conversation

QiJune commented Sep 5, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment