Skip to content

Commit 9b8776c

Browse files
Felonious-Spellfirelexierule
authored andcommitted
Doc Terminology updates (#13972)
* Doc Terminology updates * API updates (cherry picked from commit 52f3775)
1 parent 5c50aa9 commit 9b8776c

File tree

17 files changed

+108
-106
lines changed

17 files changed

+108
-106
lines changed

docs/source-app/core_api/lightning_app/index.rst

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,12 @@ Peek under the hood
2424
:tag: Basic
2525

2626
.. displayitem::
27-
:header: The App state (basic)
28-
:description: Learn more about the state and its manipulation.
29-
:col_css: col-md-4
30-
:button_link: ../../workflows/access_app_state.html
31-
:height: 180
32-
:tag: basic
33-
34-
.. displayitem::
35-
:header: The event loop (basic)
27+
:header: The event loop (Basic)
3628
:description: Learn more about the event loop.
3729
:col_css: col-md-4
3830
:button_link: ../../glossary/event_loop.html
3931
:height: 180
40-
:tag: basic
32+
:tag: Basic
4133

4234
.. displayitem::
4335
:header: Communication between Flow and Works

docs/source-app/examples/dag/dag.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
####################################
2-
Build a Directed Acyclic Graph (DAG)
3-
####################################
1+
######################################
2+
Develop a Directed Acyclic Graph (DAG)
3+
######################################
44

55
.. _dag_example:
66

docs/source-app/examples/hpo/hpo.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
.. _hpo_example:
33

44

5-
#######################################################
6-
Build a Lightning Hyperparameter Optimization (HPO) App
7-
#######################################################
5+
#########################################################
6+
Develop a Lightning Hyperparameter Optimization (HPO) App
7+
#########################################################
88

99
*******************
1010
A bit of background

docs/source-app/examples/model_server_app/model_server.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
:orphan:
22

3-
***********************************
4-
2. Build the Model Server Component
5-
***********************************
3+
*************************************
4+
2. Develop the Model Server Component
5+
*************************************
66

77
In the code below, we use `MLServer <https://github.com/SeldonIO/MLServer>`_ which aims to provide an easy way to start serving your machine learning models through a REST and gRPC interface,
88
fully compliant with KFServing's V2 Dataplane spec.
@@ -19,15 +19,15 @@ fully compliant with KFServing's V2 Dataplane spec.
1919
.. Add callout items below this line
2020
2121
.. displayitem::
22-
:header: 1. Build a Train Component
22+
:header: 1. Develop a Train Component
2323
:description: Train a model and store its checkpoints with SKlearn
2424
:col_css: col-md-4
2525
:button_link: train.html
2626
:height: 150
2727
:tag: Intermediate
2828

2929
.. displayitem::
30-
:header: 3. Build a Load Testing Component
30+
:header: 3. Develop a Load Testing Component
3131
:description: Use Locust to test your model servers
3232
:col_css: col-md-4
3333
:button_link: load_testing.html
@@ -36,7 +36,7 @@ fully compliant with KFServing's V2 Dataplane spec.
3636

3737
.. displayitem::
3838
:header: 4. Putting everything together.
39-
:description: Ensemble the components together and run the app
39+
:description: Ensemble the Components together and run the App
4040
:col_css: col-md-4
4141
:button_link: putting_everything_together.html
4242
:height: 150

docs/source-app/examples/model_server_app/model_server_app.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
.. _model_server_example:
44

5-
####################
6-
Build a Model Server
7-
####################
5+
######################
6+
Develop a Model Server
7+
######################
88

99
**Audience:** Users who want to serve their trained models.
1010

docs/source-app/examples/model_server_app/putting_everything_together.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,31 +43,31 @@ Find more examples
4343
.. Add callout items below this line
4444
4545
.. displayitem::
46-
:header: Build a DAG
47-
:description: Create a dag pipeline
46+
:header: Develop a DAG
47+
:description: Develop a DAG pipeline
4848
:col_css: col-md-4
4949
:button_link: ../dag/dag.html
5050
:height: 150
5151
:tag: Intermediate
5252

5353
.. displayitem::
54-
:header: Build a File Server
54+
:header: Develop a File Server
5555
:description: Train multiple models with different parameters
5656
:col_css: col-md-4
5757
:button_link: ../file_server/file_server.html
5858
:height: 150
5959
:tag: Intermediate
6060

6161
.. displayitem::
62-
:header: Build a Github Repo Script Runner
62+
:header: Develop a Github Repo Script Runner
6363
:description: Run code from the internet in the cloud
6464
:col_css: col-md-4
6565
:button_link: ../github_repo_runner/github_repo_runner.html
6666
:height: 150
6767
:tag: Intermediate
6868

6969
.. displayitem::
70-
:header: Build a HPO Sweeper
70+
:header: Develop a HPO Sweeper
7171
:description: Train multiple models with different parameters
7272
:col_css: col-md-4
7373
:button_link: ../hpo/hpo.html

docs/source-app/index.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -221,13 +221,13 @@ Keep Learning
221221

222222
.. toctree::
223223
:maxdepth: 1
224-
:caption: Practical Examples
224+
:caption: Examples
225225

226-
Build a DAG <examples/dag/dag>
227-
Build a File Server <examples/file_server/file_server>
228-
Build a Github Repo Script Runner <examples/github_repo_runner/github_repo_runner>
229-
Build a HPO Sweeper <examples/hpo/hpo>
230-
Build a Model Server <examples/model_server_app/model_server_app>
226+
Develop a DAG <examples/dag/dag>
227+
Develop a File Server <examples/file_server/file_server>
228+
Develop a Github Repo Script Runner <examples/github_repo_runner/github_repo_runner>
229+
Develop a HPO Sweeper <examples/hpo/hpo>
230+
Develop a Model Server <examples/model_server_app/model_server_app>
231231

232232
..
233233
[Docs under construction] Build a data exploring app <examples/data_explore_app>
@@ -237,19 +237,19 @@ Keep Learning
237237
238238
.. toctree::
239239
:maxdepth: 1
240-
:caption: Common Workflows
240+
:caption: How to...
241241

242242
Add a web user interface (UI) <workflows/add_web_ui/index>
243243
Add a web link <workflows/add_web_link>
244244
Arrange app tabs <workflows/arrange_tabs/index>
245-
Build a Lightning app <workflows/build_lightning_app/index>
246-
Build a Lightning component <workflows/build_lightning_component/index>
245+
Develop a Lightning App <workflows/build_lightning_app/index>
246+
Develop a Lightning Component <workflows/build_lightning_component/index>
247247
Cache Work run calls <workflows/run_work_once>
248248
Customize your cloud compute <core_api/lightning_work/compute>
249249
Extend an existing app <workflows/extend_app>
250250
Publish a Lightning component <workflows/build_lightning_component/publish_a_component>
251251
Run a server within a Lightning App <workflows/add_server/index>
252-
Run an app on the cloud <workflows/run_app_on_cloud/index>
252+
Run an App on the cloud <workflows/run_app_on_cloud/index>
253253
Run work in parallel <workflows/run_work_in_parallel>
254254
Share an app <workflows/share_app>
255255
Share files between components <workflows/share_files_between_components>

docs/source-app/workflows/build_lightning_app/from_pytorch_lightning_script.rst

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,28 @@
1-
#######################################
2-
Build app from PyTorch Lightning script
3-
#######################################
1+
#######################################################
2+
Develop a Lightning App from a PyTorch Lightning script
3+
#######################################################
44

5-
**Audience:** Users who want to build an app from their PyTorch Lightning scripts.
5+
**Audience:** Users who want to develop a Lightning App (App) from their PyTorch Lightning (PL) scripts.
66

77
----
88

9-
***********************************************
10-
Why do I want to build an app from a PL script?
11-
***********************************************
12-
Generating an app from a PL script allows you to immediately run on the cloud and share the progress with friends.
9+
*************************************************************
10+
What developing a Lightning App from a PL script does for you
11+
*************************************************************
12+
13+
Developing an App from a PL script allows you to immediately run on the cloud and share the progress with friends.
1314
Once you're happy with your model, you can immediately expand beyond just model development to things like
14-
making your own inference APIs, research demos or even speeding up your data pipeline.
15+
making your own inference APIs, research demos, or even speeding up your data pipeline.
1516

16-
The PyTorch Lightning app is your entry point to the full end-to-end ML licefycle.
17+
The PyTorch Lightning App is your entry point to the full end-to-end ML licefycle.
1718

1819
----
1920

20-
*******************
21-
Generate a template
22-
*******************
21+
******************
22+
Develop a template
23+
******************
2324

24-
To generate a template from a PyTorch Lightning script, use this command:
25+
To develop a template from a PyTorch Lightning script, use this command:
2526

2627
.. code:: bash
2728
@@ -35,22 +36,23 @@ If your script is not at the root of the project folder, and you'd like to inclu
3536
lightning init pl-app path/to/project/root path/to/the/pl_script.py
3637
3738
38-
The default trainer app lets you train a model with a beautiful UI locally and on the cloud with zero effort!
39+
The default trainer App lets you train a model with a beautiful UI locally and on the cloud with zero effort!
3940

4041
----
4142

4243
***********
43-
Run the app
44+
Run the App
4445
***********
45-
.. note:: this page is under construction
4646

47-
Run the app locally:
47+
.. note:: This section is under construction.
48+
49+
Run the App locally:
4850

4951
.. code:: bash
5052
5153
lightning run app pl-app/app.py
5254
53-
Or run it on the cloud so you can share with collaborators and even use all the cloud GPUs you want
55+
Or run the App on the cloud so you can share with collaborators and even use all the cloud GPUs you want.
5456

5557
.. code:: bash
5658
@@ -67,7 +69,7 @@ Or run it on the cloud so you can share with collaborators and even use all the
6769
Modify the template
6870
*******************
6971

70-
The command above generates an app file like this:
72+
The command above generates an App file like this:
7173

7274
.. note:: TODO: list the file and show how to extend it
7375

@@ -99,7 +101,7 @@ Now you can add your own components as you wish!
99101
Known issues
100102
************
101103

102-
- The UI takes a couple seconds to load when opening the app, be patient.
104+
- The UI takes a couple seconds to load when opening the App, so please be patient.
103105
- The timer resets when refreshing the page.
104106
- The UI for adding new environment variables does not provide an option to delete an entry.
105107
- A bug exists that leaves the script hanging at the start of training when using the DDP strategy.

docs/source-app/workflows/build_lightning_app/from_scratch.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
##################################
2-
Build a Lightning App from Scratch
3-
##################################
4-
**Audience:** Users who want to build a Lightning App from scratch.
1+
####################################
2+
Develop a Lightning App from Scratch
3+
####################################
4+
5+
**Audience:** Users who want to develop a Lightning App from scratch.
56

67
**Prereqs:** You must have finished the `Basic levels <https://lightning.ai/lightning-docs/levels/basic/>`_.
78

docs/source-app/workflows/build_lightning_app/index.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
#####################
2-
Build a Lightning app
3-
#####################
4-
A Lightning app is a collection of components interacting together. Learn how to generate a basic app template.
1+
#######################
2+
Develop a Lightning App
3+
#######################
4+
5+
A Lightning App (App) is a collection of components interacting together. Learn how to develop a basic App template.
56

67
----
78

0 commit comments

Comments
 (0)