Commit Graph

7 Commits

Author SHA1 Message Date
Raphael Randschau 5ff610cbea
Add basic SSH documentation for CLI (#15316)
* add basic ssh documentation

* rename workflow ssh debugging

* Update docs/source-app/workflows/ssh/index.rst

Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com>

* Update docs/source-app/workflows/ssh/index.rst

Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com>

* Update docs/source-app/workflows/ssh/index.rst

Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com>

* add more details about ssh command

* Update docs/source-app/workflows/ssh/index.rst

Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com>

* add more motivation to the audience section

* fix sphinx errors

* Update docs/source-app/workflows/index.rst

Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com>

* add details how to get app id

* add docs about component name

* add more context to the audience section

* Update docs/source-app/workflows/ssh/index.rst

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>

* Update docs/source-app/workflows/ssh/index.rst

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>

* address adrians comment about order

* add one-time notice

* fix headers

* wording

* update to match ssh params

* Update docs/source-app/workflows/ssh/index.rst

Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com>

* Update docs/source-app/workflows/ssh/index.rst

Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com>

* Update docs/source-app/workflows/ssh/index.rst

Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com>

* drop verification

* fix merge conflict error

* remove symlink

* fix doctree

Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com>
Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2022-11-06 07:07:50 -08:00
William Falcon 877c0bfe2c
Docs 3/n (#15554)
* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* remove source-lit

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2022-11-06 05:55:57 -05:00
Jirka Borovec adb970a50b
CI: resolving Docs (#15508)
* placeholder

* pytorch

* fix CI

* fix package name

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* use os theme for pytorch docs

* switch source-app to lai_sphinx_theme

* pull_request

* doc error fix

* another build error fix

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* removed unused glossary.rst

* lit

* doc fixes

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix last warning

* try

* lit

* flake8

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: Yurij Mikhalevich <yurij@grid.ai>
Co-authored-by: rohitgr7 <rohitgr1998@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2022-11-03 15:33:54 -04:00
William Falcon 9328da439b
docs updates 1/n (#15473)
* docs

* docs updates

* docs updates

* docs updates

* docs updates

* d

* d

* d

* d

* d

* d

* ??

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d1

* d

* d

* d

* d

* d

* d

* d

* d

* d

* d

* new title

* new title

* new title

* new title

* new title

* new title

* new title

* new title

* new title

* new title

* new title

* new title

* new title

* new title

* new title

* new title

* new title

* new title

* new title

* new title

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* only select from parent

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* use OSS template

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* only select from parent

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update docs/README.md

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>

Co-authored-by: William Falcon <williamfalcon@Williams-MacBook-Pro-2.local>
Co-authored-by: William Falcon <williamfalcon@Williams-MBP-2.lan>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Jirka <jirka.borovec@seznam.cz>
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
2022-11-03 10:55:30 -04:00
thomas chaton c7ae985979
Add `lightning_app` docs (#13656)
* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* update

* update

* update

* update

* update

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update latest docs

* remove image

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* ci

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* make

* Update .gitignore

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>

* Update .github/workflows/docs-deploy.yml

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* update

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* update

* update

* update

* update

* update

* Update docs/source-app/_templates/theme_variables.jinja

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/api_reference/api_references.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/api_reference/api_references.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/api_reference/api_references.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/code_samples/convert_pl_to_app/train.py

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/core_api/lightning_app/communication_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/model_server_app/model_server_app_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/get_started/training_with_apps.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/get_started/training_with_apps.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/get_started/training_with_apps.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/hpo/hpo.py

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/core_api/lightning_app/communication_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/core_api/lightning_app/communication_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/core_api/lightning_app/dynamic_work_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/github_repo_runner/github_repo_runner_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/github_repo_runner/github_repo_runner_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/github_repo_runner/github_repo_runner_step_2.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/github_repo_runner/github_repo_runner_step_4.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/model_server_app/model_server.py

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* update

* Update docs/source-app/core_api/lightning_app/dynamic_work_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/github_repo_runner/app.py

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/github_repo_runner/app.py

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* update

* update

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Jirka <jirka.borovec@seznam.cz>
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
2022-07-15 08:45:50 -04:00
Carlos Mocholí eec862ef2f
Revert "Update Lightning App docs (#13537)" (#13655)
This reverts commit cd31ba3f87.
2022-07-14 09:45:46 -04:00
thomas chaton cd31ba3f87
Update Lightning App docs (#13537)
* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* update

* update

* update

* update

* update

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update latest docs

* remove image

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* ci

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* make

* Update .gitignore

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>

* Update .github/workflows/docs-deploy.yml

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* update

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* update

* update

* update

* update

* update

* Update docs/source-app/_templates/theme_variables.jinja

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/api_reference/api_references.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/api_reference/api_references.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/api_reference/api_references.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/code_samples/convert_pl_to_app/train.py

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/core_api/lightning_app/communication_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/model_server_app/model_server_app_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/get_started/training_with_apps.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/get_started/training_with_apps.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/get_started/training_with_apps.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/hpo/hpo.py

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/core_api/lightning_app/communication_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/core_api/lightning_app/communication_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/core_api/lightning_app/dynamic_work_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/github_repo_runner/github_repo_runner_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/github_repo_runner/github_repo_runner_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/github_repo_runner/github_repo_runner_step_2.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/github_repo_runner/github_repo_runner_step_4.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/model_server_app/model_server.py

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* update

* Update docs/source-app/core_api/lightning_app/dynamic_work_content.rst

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/github_repo_runner/app.py

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update docs/source-app/examples/github_repo_runner/app.py

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* update

* update

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Jirka <jirka.borovec@seznam.cz>
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
2022-07-14 09:36:36 -04:00