Skip to content

Commit 5ea59e7

Browse files
authored
Reformat docs/tutorials/get_started.md (#2055)
1 parent 65ea1b6 commit 5ea59e7

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

docs/tutorials/get_started.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,44 @@
11
# Getting Started with ElasticDL
22

3-
The tutorials in this document aims to help users get hands on quickly and have a preliminary understanding of ElasticDL.
3+
The tutorials in this document aims to help users get hands on quickly and have
4+
a preliminary understanding of ElasticDL.
45

56
## Run ElasticDL on Various Environments
67

7-
The following tutorials demonstrates how to run ElasticDL on different environments:
8+
The following tutorials demonstrates how to run ElasticDL on different
9+
environments:
810

911
1. Local Environment
1012
2. On-prem cluster
1113
3. Public cloud
1214

1315
### ElasticDL on Local Environment
1416

15-
[Minikube](https://kubernetes.io/docs/setup/learning-environment/minikube/) is a tool that makes it easy to run Kubernetes locally.
16-
It runs a single-node Kubernetes cluster inside a Virtual Machine (VM) on the laptop so developers can try out Kubernetes or develop with it day-to-day.
17-
18-
[This tutorial](elasticdl_local.md) uses Minikube to run ElasticDL on a local laptop.
17+
[Minikube](https://kubernetes.io/docs/setup/learning-environment/minikube/) is a
18+
tool that makes it easy to run Kubernetes locally. It runs a single-node
19+
Kubernetes cluster inside a Virtual Machine (VM) on the laptop so developers can
20+
try out Kubernetes or develop with it day-to-day.
1921

22+
[This tutorial](elasticdl_local.md) uses Minikube to run ElasticDL on a local
23+
laptop.
2024

2125
### ElasticDL on On-prem Cluster
2226

23-
[This tutorial](elasticdl_on_prem_cluster.md) demonstrates how to run ElasticDL on an on-prem cluster.
24-
27+
[This tutorial](elasticdl_on_prem_cluster.md) demonstrates how to run ElasticDL
28+
on an on-prem cluster.
2529

2630
### ElasticDL on Public Cloud
2731

28-
[This tutorial](elasticdl_cloud.md) shows how to run ElasticDL on a public cloud, namely, Google Kubernetes Engine (GKE).
32+
[This tutorial](elasticdl_cloud.md) shows how to run ElasticDL on a public
33+
cloud, namely, Google Kubernetes Engine (GKE).
2934

3035
## Model Building
3136

32-
We have also provided [this tutorial](model_building.md) to illustrate how to define necessary components that will be
33-
used for ElasticDL model training, evaluation, and prediction.
37+
We have also provided [this tutorial](model_building.md) to illustrate how to
38+
define necessary components that will be used for ElasticDL model training,
39+
evaluation, and prediction.
3440

3541
## Data Preparation
3642

37-
[This tutorial](data_preparation.md) demonstrates how to prepare datasets into the right format that can be
38-
used by ElasticDL.
43+
[This tutorial](data_preparation.md) demonstrates how to prepare datasets into
44+
the right format that can be used by ElasticDL.

0 commit comments

Comments
 (0)