Commit Graph

98 Commits

Author SHA1 Message Date
Kaushik B 5a89be6873
Update strategy registry docs (#11311) 2022-01-05 10:37:11 +00:00
Rohit Gupta cc42aa9401
Improve checkpoint docs (#10916) 2021-12-16 16:21:59 +00:00
Rohit Gupta 5b153e5072
Update data docs (#11042)
Co-authored-by: Aki Nitta <nitta@akihironitta.com>
Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2021-12-14 15:26:46 +00:00
Rohit Gupta 5576fbc5f9
move optional section (#11011) 2021-12-10 09:47:44 +00:00
Kaushik B 4a341e5b24
Add remote filesystems to docs (#10752)
Co-authored-by: thomas chaton <thomas@grid.ai>
Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2021-11-28 16:46:52 +00:00
Kaushik B 1284ead317
Remove metrics references from docs (#10567) 2021-11-22 14:29:06 +00:00
Adrian Wälchli d33429c1e2
Lightning Lite docs (#10176) 2021-10-30 10:25:52 +00:00
Kaushik B d1985ebf96
Add Plugins Registry to docs (#10181) 2021-10-28 16:44:08 +05:30
Adrian Wälchli 7a9151637c
loop customization docs (#9609)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
Co-authored-by: thomas chaton <thomas@grid.ai>
Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com>
2021-10-18 09:43:11 +00:00
LaserBit 2e17b471f8
Fix missing url (#9602) 2021-09-20 23:20:40 +05:30
Jirka Borovec 982a9560a5
Update notebooks submodule and add tutorial view to docs (#9420)
Co-authored-by: Ethan Harris <ethanwharris@gmail.com>
2021-09-16 15:14:37 +01:00
thomas chaton c86e6cf1c4
[doc] Add Fault Tolerant Documentation Page (#9256)
Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
Co-authored-by: Sean Naren <sean@grid.ai>
Co-authored-by: Ethan Harris <ewah1g13@soton.ac.uk>
2021-09-02 10:18:03 +00:00
Sean Naren 12d076f747
[docs] Add Mixed Precision detailed docs (#9104) 2021-08-25 14:44:29 +00:00
Ethan Harris 6de66eb110
Fix governance references in docs (#8984) 2021-08-19 00:10:27 +02:00
Sean Naren b2973a035e
Introduce CheckpointIO Plugin (#8743) 2021-08-13 17:35:31 +01:00
Sean Naren a1be6217ce
Expand the use cases, move them up for discoverability (#8692) 2021-08-03 11:47:20 +00:00
Kaushik B 39de7fefeb
Lightning Release v1.4 (#8579)
* Update Lightning version to v1.4

* update notebooks

* Update release date in Changelog

* docs

Co-authored-by: Jirka <jirka.borovec@seznam.cz>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2021-07-27 14:00:13 +00:00
edenlightning 20fc8cf063
[Docs revamp 2/N] New doc for managing data (#8034)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: thomas chaton <thomas@grid.ai>
Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>
Co-authored-by: ananthsub <ananth.subramaniam@gmail.com>
Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
Co-authored-by: Ethan Harris <ewah1g13@soton.ac.uk>
Co-authored-by: Ethan Harris <ethanwharris@gmail.com>
2021-07-22 01:42:08 +00:00
Ethan Harris c0caeb3ea9
Update docs for new template (#8232)
* Update docs for new template

* Fixes

* Fixes

* Drop links
2021-07-01 16:19:09 +01:00
edenlightning d4d5418cc4
Fix notebook links (#8089)
* Fix notebook links

* update

* BERT

* docs

* Update README.md

* Apply suggestions from code review

Co-authored-by: Jirka <jirka.borovec@seznam.cz>
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
2021-06-23 21:36:31 +00:00
Jirka Borovec 7978a5376d
Ipynb update (#8004)
* git submodule update --remote

* update notebooks in docs

* prune

* _notebooks

* docs

* path

* path

* ignore

* head
2021-06-17 16:46:05 +02:00
edenlightning 5647087f03
New speed documentation (#7665)
* amp

* amp

* docs

* add guides

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

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

* amp

* amp

* docs

* add guides

* speed guides

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

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

* Delete ds.txt

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

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

* Update conf.py

* Update docs.txt

* remove 16 bit

* remove finetune from speed guide

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

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

* speed

* speed

* speed

* speed

* speed

* speed

* speed

* speed

* speed

* speed

* speed

* speed

* remove early stopping from speed guide

* remove early stopping from speed guide

* remove early stopping from speed guide

* fix label

* fix sync

* reviews

* Update trainer.rst

* Update trainer.rst

* Update speed.rst

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2021-06-16 21:28:51 +00:00
Sean Naren 0974d66c6c
Add docs for IPUs (#7923)
* Added base docs for IPUs

* Fix

* Add details around poptorch profiler and model parallelism

* more description

* Add image

* Clearer messaging

* Cleanup

* Better name

* Add note

* Add some details around device iterations and model parallelism

* Apply suggestions from code review

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

* Add a small install comment

* Add clip gradients not supported

* Update docs/source/advanced/ipu.rst

Co-authored-by: Kaushik B <45285388+kaushikb11@users.noreply.github.com>

* Add note

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
Co-authored-by: Kaushik B <45285388+kaushikb11@users.noreply.github.com>
2021-06-15 10:16:47 +00:00
Jirka Borovec 0fda862274
Refactor notebooks (#7752)
* drop notebooks

* add submodule

* copy notebooks

* docs include ipynb

* fix headers

* CI

* readthedocs

* manifest

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

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

* req

* workdir

* pandoc

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

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

* pandoc

* manifest

* Apply suggestions from code review

* fix versions

* checkout

* `git submodule update --init --recursive --remote`

* notebooks @docs

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2021-06-08 16:30:13 +00:00
Sean Naren 94f6c3e160
Advanced GPU Documentation (#7259)
* Added advanced gpu section

* Small changes

* Better documentation

* Address code review

* Add warning about using trainer.model, clean up some of the examples

* Add section for ddp, remove references and old sequential documentation

* Remove Fully Sharded documentation for now

* Apply suggestions from code review

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>

* Address code review

* Address code review

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>
2021-05-06 13:53:20 +01:00
Adrian Wälchli d902181b50
Update `ClusterEnvironment` docs (#7120)
* update cluster

* update index

* update references

* update grid docs

* update duplicated title

* Update docs/source/clouds/cloud_training.rst

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>

* fix doctest

* Remove self-balancing section

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
2021-04-22 01:38:16 +02:00
Adrian Wälchli 24248d6dd4
Update community example links (#7087)
Co-authored-by: tchaton <thomas@grid.ai>
2021-04-20 06:56:59 +00:00
Mauricio Villegas b7f3a3c421
Simple reproducibility with minimum boilerplate CLI training with `LightningCLI` (#4492)
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
2021-04-06 14:19:11 +01:00
Akihiro Nitta 9876df16a2
[docs] Update Bolts link (#6743)
* Update Bolts link

* Update Bolts link

* formt

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
2021-03-30 22:52:59 +05:30
edenlightning 3449e2d79f
Docs for Pruning, Quantization, and SWA (#6041)
Co-authored-by: chaton <thomas@grid.ai>
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
Co-authored-by: Sean Naren <sean.narenthiran@gmail.com>
2021-02-18 13:51:51 +00:00
Alexander Reshytko 6d7c01b1b4 [docs] Add docs for non-SLURM cluster setup (#5754)
* Add docs for non-slurm cluster setup

* Apply suggestions from code review

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

* Update docs/source/cluster.rst

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

* Update docs/source/cluster.rst

Co-authored-by: Alexander <alexander@reshytko.com>
Co-authored-by: chaton <thomas@grid.ai>
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
2021-02-05 21:43:10 +01:00
Jirka Borovec dee5553b2b
move to Pages dir (#4869)
* folders

* common / advanced / extensions

* paths

* flake8

* isort

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2021-01-26 15:07:07 -05:00
Jirka Borovec 3c5dad7100 Document speed comparison (#2072)
* docs

* script

* dump

* desc

* import

* import

* if

* norm

* t

* finished

* isort

* typing

Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>

* xlabel

* pandas

* time

Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
2021-01-05 09:58:37 +01:00
chaton b7601e9deb
[Example] Add Pytorch Geometric Example (#4568)
* add example for Pytorch Geometric

* remove hydra

* add docstring

* remove description

* rename folder

* update script to not break test

* remove .lock

* add Pytorch Geometric to doc

* add docstring at the begining

* add comments

* Update pl_examples/pytorch_ecosystem/pytorch_geometric/README.md

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

* Update pl_examples/pytorch_ecosystem/pytorch_geometric/README.md

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

* Update pl_examples/pytorch_ecosystem/pytorch_geometric/cora_dna.py

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

* add toml

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: Jirka Borovec <jirka@pytorchlightning.ai>
2020-11-18 20:03:55 +00:00
Jeff Yang baa8558cc0
logger docs and api docs (#3950)
* logger and api docs

* remove gpu_usage_logger, lr_logger

* update docstring

* fix wandb example

* remove step result

* charts

* add some charts info

Co-authored-by: Teddy Koker <teddy.koker@gmail.com>
Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
2020-11-13 20:35:54 +05:30
William Falcon ee35907170
Accelerator docs (#4583)
* accelerator docs

* accelerator docs
2020-11-08 17:24:41 -05:00
Eric Harper 8b3adb9669
Update to NeMo Documentation (#4328)
* updated header and small fixes

Signed-off-by: ericharper <complex451@gmail.com>

* updated header and small fixes

Signed-off-by: ericharper <complex451@gmail.com>

* updated header and small fixes

Signed-off-by: ericharper <complex451@gmail.com>

* updated header and small fixes

Signed-off-by: ericharper <complex451@gmail.com>
2020-10-25 06:57:04 -04:00
William Falcon 753362d0a4
enable ddp as a plugin (#4285)
* enable custom ddp plugin

* enable custom ddp plugin

* enable custom ddp plugin

* enable custom ddp plugin

* enable custom ddp plugin

* enable custom ddp plugin

* enable custom ddp plugin

* enable custom ddp plugin

* enable custom ddp plugin

* enable custom ddp plugin

* enable custom ddp plugin

Co-authored-by: chaton <thomas@grid.ai>
2020-10-22 05:15:51 -04:00
William Falcon f19bad6335
docs (#4106)
* docs

* docs

* docs
2020-10-12 17:57:51 -04:00
William Falcon 42a4fe06b0
docs (#4096) 2020-10-12 12:15:33 -04:00
William Falcon 6950874ae0
docs (#4093)
* enabled manual returns

* style

* docs
2020-10-12 11:13:26 -04:00
William Falcon 9a0918e39b
docs fixes (#4080)
* docs

* docs

* docs

* docs

* docs

* docs

* docs

* docs

* docs
2020-10-11 13:12:19 -04:00
William Falcon 1dbc6ffbc1
added templates (#4077)
* docs

* docs
2020-10-11 09:35:51 -04:00
Paul Baumstark 9e91976323
Removed broken link (#4031)
module index link in documentation is broken.

Co-authored-by: pbmstrk <pbmstrk@users.noreply.github.com>
2020-10-09 19:10:48 -04:00
Eric Harper 0a3aa8b6ce
[ci skip] NeMo Documentation for PyTorch Lightning (#3707)
* initial commit

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* updated

Signed-off-by: ericharper <complex451@gmail.com>

* doc clean up

Co-authored-by: William Falcon <waf2107@columbia.edu>
2020-10-07 15:26:21 -04:00
Jirka Borovec fef9b7777f
missing logs [to be merged before release][skip ci] (#3131)
* missing logs

* chlog

* add chlo to docs

* Apply suggestions from code review

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

* chlog

* docs

* log

* metrics

* logs

* log

* format

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2020-10-07 14:51:35 -04:00
edenlightning 335bb75356
update docs on logging (#3916)
* Update loggers.rst

* Update loggers.rst

* Update index.rst

* Create logging.rst

* Delete experiment_reporting.rst

* Delete experiment_logging.rst

* Update __init__.py
2020-10-06 18:53:39 -04:00
Jeff Yang fe5b943965
Callback docs with autosummary (#3908)
* callback docs with autosummary

* do not show private methods

* callback base docstring
2020-10-06 17:28:45 -04:00
William Falcon 093535d433
ref: adding compute environments (1/n) (#3837)
* ref: adding compute environments (1/n)

* ref: adding compute environments (1/n)

* ref: adding compute environments (1/n)
2020-10-04 07:31:19 -04:00
William Falcon a38d108a68
add dist lib to enable syncing anything across devices (#3762)
* add dist lib to enable syncing anything across devices
2020-10-01 01:21:38 -04:00