Commit Graph

32 Commits

Author SHA1 Message Date
Aliaksei Urbanski c5363af1c2
Fix the "our" word duplication in the docs (#19055)
There were a bit inconsistent sentences with
a word duplication issue in the documentation.

These changes also:
  * unify references to the Compatibility matrix
  * add a reference to the Compatibility matrix
    into PyTorch Lightning's Installation Docs
2023-12-01 11:28:29 -05:00
edenlightning 049f6c576a
docs index update (#17780)
Co-authored-by: Jirka <jirka.borovec@seznam.cz>
2023-06-21 16:04:06 +00:00
edenlightning c2d9ec4e1b
Update docs index (#17246)
* update docs

* update docs index

* Delete version.info

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

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

* update glossary

* typo

* restructure

* rm newline

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

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

---------

Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-04-05 12:06:40 -04:00
Jirka Borovec 5c5ce60e55
fixing master (#17268)
* fixing master

* [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>
2023-04-03 15:23:32 -04:00
Eden Afek 65eb3e7c45 revert docs 2023-03-30 20:14:54 -04:00
Eden Afek d8cae765c4 Update 2 2023-03-30 18:59:41 -04:00
Eden Afek b73fb292e2 Update docs structure 2023-03-30 18:46:25 -04:00
Maurice Deserno 572f99b857
Updated conda install commands in docs. (#17162) 2023-03-24 09:57:10 +01:00
Carlos Mocholí e5eab4e0a3
Reference the compatibility matrix (#17091) 2023-03-17 14:51:39 +01:00
Adrian Wälchli 01834c8529
Exclude some examples from docs navigation (#17081)
Co-authored-by: Jirka <jirka.borovec@seznam.cz>
2023-03-15 12:55:34 +00:00
Jirka Borovec f25dfbe2b5
update links to Discord (#17087)
* update links to Discord

* link

* Apply suggestions from code review

Co-authored-by: Luca Antiga <luca.antiga@gmail.com>

* slack

* Update docs/source-app/levels/expert/index.rst

* Apply suggestions from code review

---------

Co-authored-by: Luca Antiga <luca.antiga@gmail.com>
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2023-03-15 13:33:40 +01:00
Jirka Borovec 2f39bb656e
docs: migration guide to the `latest` [1/n] (#17034)
* docs: migration guide - structure

* update

* try

* ...

* 1.9

* 1.8

* 1.7

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

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

* cleaning 1.9

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

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

* crosslink

* ...

* placeholder

* 1.6

* placeholders

* 1.5

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

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

* 1.4

* Apply suggestions from code review

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

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
2023-03-15 13:32:44 +01:00
Aniket Maurya 5d58736f08
Rename PL installation to `pip install lightning` (#17074)
* rename PL installation

* update

* Apply suggestions from code review

* Update docs/source-pytorch/starter/installation.rst

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

* Update docs/source-pytorch/starter/installation.rst

---------

Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com>
2023-03-14 14:47:56 -04:00
Carlos Mocholí 281efc682f
Update data docs (#16839)
Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>
2023-03-14 18:44:49 +01:00
Jirka Borovec 9b168dcf9b
docs: listing past versions (#17014)
Co-authored-by: Luca Antiga <luca.antiga@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-03-09 17:52:20 +00:00
Jirka Borovec 0e8ac7e1c9
docs: move fabric on its own (#16742)
* docs: move fabric to Lai

* update imports

* links

* drop link to Trainer

* own docs

* ci

* trigger

* prune cross-links

* cleaning

* cleaning

* template

* imports

* template

* path

* links

* tensorboardX

* plugins

* label

* drop fixme

* drop copy nb + examples

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

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

* Apply suggestions from code review

* try again

* rev

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-03-01 12:36:14 +01:00
Carlos Mocholí ef2a6088ff
Drop support for PyTorch 1.10 (#16492)
* Drop support for PyTorch 1.10

* CHANGELOG

* READMEs

* mypy

* ls

* New poplar version

* Fixed tests

* links

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

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

* skip azure badges

* Table

* Matching dockerfiles

* Drop unnecessary channels and packages

* Push nightly

* Undo unrelated changes

* Revert "Push nightly"

This reverts commit 9618f737c4.

---------

Co-authored-by: Jirka <jirka.borovec@seznam.cz>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-02-01 14:09:12 -05:00
Carlos Mocholí 76cb048b29
Remove docs about automatic fault tolerance (#16500)
Remove docs about the experimental automatic fault tolerance
2023-01-26 19:47:40 +01:00
Carlos Mocholí 486b4d5d9d
Remove old platform docs (#16499)
* Remove old platform docs

* More

* More
2023-01-25 16:16:51 +01:00
Carlos Mocholí 8f736372ed Loop flattening: reduce base interface (#16429)
* Loop flattening: remove the default `.run()` implementation

* None return

* mypy

* Loop flattening: reduce base interface

* Fix

* DOcs

* Bad merge

* Fix

* Fix
2023-01-19 18:39:36 +01:00
Carlos Mocholí f031f1e453 Remove the `HivemindStrategy` (#16407)
Remove the collaborative strategy
2023-01-19 18:39:36 +01:00
Adrian Wälchli a8605b4540
Update Lightning Lite docs (5/n) (#16291)
* organize

* organize

* organize

* organize

* Fix

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

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

* accelerator

* distributed launch

* notebooks

* code structure

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

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

* lightning_module

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

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

* x

* update

* conflicts

* fix duplicates

* links.rst

* api folder

* add todo for build errors

* resolve duplicate reference warnings

* address review by eden

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 14:11:03 -05:00
Adrian Wälchli 085ad548ca
Update Lightning Lite docs (1/n) (#16250)
* fabric docs

* fix reference

* fabric
2023-01-04 12:25:36 -05:00
Jirka Borovec c8b4bce3ee
docs: add PT version (#16010)
* docs: add PT version

* stable

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

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2022-12-17 08:27:21 +01:00
Justus Schock 006fde9747
FCCV Docs (#15598)
* add custom data iter docs

* add custom data iter docs

* Update docs/source-pytorch/data/custom_data_iterables.rst

* remove ToDevice

* nit

* Update docs/source-pytorch/data/custom_data_iterables.rst

Co-authored-by: Luca Antiga <luca.antiga@gmail.com>

* clarification for @lantiga

* typo

* Update docs/source-pytorch/data/custom_data_iterables.rst

* Update docs/source-pytorch/data/custom_data_iterables.rst

* Update docs/source-pytorch/data/custom_data_iterables.rst

Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
Co-authored-by: Akihiro Nitta <nitta@akihironitta.com>
Co-authored-by: Luca Antiga <luca.antiga@gmail.com>
2022-11-21 15:30:58 -05:00
Mauricio Villegas acccc4d423
Fix LightningCLI docs after overhaul of the documentation (#14976)
* - Fix diverse issues introduced when the documentation was restructured.
- Change the docs to be focused on configure hyperparameters instead of reduction of bolierplate.

* Update docs/source-pytorch/cli/lightning_cli.rst

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

* - Fix diverse issues introduced when the documentation was restructured.
- Change the docs to be focused on configure hyperparameters instead of reduction of bolierplate.

* Fixes based on review.

* Apply suggestions from code review

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

* Fix wrap width.

* Move save_hyperparameters and load_from_checkpoint to lightning_module page.

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
2022-11-09 10:36:47 -05: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
Akihiro Nitta 3c5e03e035
docs: Clarify versioning and API stability (#14549)
* mv releases to a standalone page

* Include release_policy in index

* Update policy

* mv releases to a standalone page

* Include release_policy in index

* Update policy

* Update title

* remove release_policy.rst

* Update versioning

* syntax

* simplify wording

* Include examples that don't follow X+2 rule

* syntax

* update

* consistency

* rm noninformative statement

* .

* Reduce redundancy in the deprecation process

* grammar?

* consistency

* Update docs/source-pytorch/versioning.rst

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

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2022-09-15 09:16:14 -04:00
thomas chaton 5e26840f94
Introduce ServableModuleValidator Callback (#13614)
* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* Update tests/tests_pytorch/serve/test_servable_module_validator.py

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

* Update tests/tests_pytorch/serve/test_servable_module_validator.py

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

* Update src/pytorch_lightning/serve/servable_module_validator.py

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

* Update src/pytorch_lightning/serve/servable_module_validator.py

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

* Update src/pytorch_lightning/serve/servable_module_validator.py

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

* Typing improvements

* wip

* update doc

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

* Update examples/pl_servable_module/production.py

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

* update

* update

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
2022-07-15 11:07:40 -04:00
Sean Naren 54f2d44fb8
Remove unnecessary endpoint logic, rename `collaborative` to `hivemind` (#13392)
* Remove endpoint after collaborate app/dht CLI

* Fix references, change filename

* Add CHANGELOG.md

* Address review

Co-authored-by: Jirka <jirka.borovec@seznam.cz>
2022-06-28 08:41:08 -04:00
Justus Schock f54abc506f
Merge pull request #13123 from Lightning-AI/mps_accelerator
MPS Accelerator
2022-06-24 08:15:48 -04:00
Jirka Borovec b58577fd4d
Future 3/n: docs adjustment (#13299)
* docs: rename source >> source-PL

* docs: fix typing

* readthedocs

* update paths & codeowners

* source-pytorch

* ci

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
2022-06-15 10:54:53 -04:00