tasks docs

This commit is contained in:
William Falcon 2020-08-15 22:36:53 -04:00
parent d702d4d393
commit 44802f7697
11 changed files with 23 additions and 9 deletions

View File

@ -50,6 +50,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Added `strict=False` and `hparams_file` accepts dict for `load_from_checkpoint` ([#2819](https://github.com/PyTorchLightning/pytorch-lightning/pull/2819))
- Added saving test predictions on multiple GPUs ([#2926](https://github.com/PyTorchLightning/pytorch-lightning/pull/2926))
### Changed
- Truncated long version numbers in progress bar ([#2594](https://github.com/PyTorchLightning/pytorch-lightning/pull/2594))
@ -140,6 +142,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Fixed checkpointing to remote file paths ([#2925](https://github.com/PyTorchLightning/pytorch-lightning/pull/2925))
- Fixed adding val step argument to metrics ([#2986](https://github.com/PyTorchLightning/pytorch-lightning/pull/2986))
## [0.8.5] - 2020-07-09
### Added

View File

@ -19,7 +19,7 @@ Here's the flow of how the callback hooks are executed:
.. raw:: html
<video width="800" controls autoplay src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pt_callbacks_mov.m4v"></video>
<video width="100%" controls autoplay src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pt_callbacks_mov.m4v"></video>
An overall Lightning system should have:

View File

@ -6,7 +6,7 @@ A datamodule is a shareable, reusable class that encapsulates all the steps need
.. raw:: html
<video width="800" controls src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pt_dm_vid.m4v"></video>
<video width="100%" controls src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pt_dm_vid.m4v"></video>
|

View File

@ -27,6 +27,7 @@ PyTorch Lightning Documentation
metrics
results
trainer
tasks
.. toctree::
:maxdepth: 1
@ -134,4 +135,5 @@ Indices and tables
api/pytorch_lightning.overrides
api/pytorch_lightning.profiler
api/pytorch_lightning.trainer
api/pytorch_lightning.tasks
api/pytorch_lightning.utilities

View File

@ -15,7 +15,7 @@ code to work with Lightning.
.. raw:: html
<video width="800" controls autoplay src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pl_module_vid.m4v"></video>
<video width="100%" controls autoplay src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pl_module_vid.m4v"></video>
|

View File

@ -16,7 +16,7 @@ A :class:`~LightningModule` organizes your PyTorch code into 5 sections
.. raw:: html
<video width="800" controls autoplay src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pl_mod_vid.m4v"></video>
<video width="100%" controls autoplay src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pl_mod_vid.m4v"></video>
|

View File

@ -20,7 +20,7 @@ To illustrate, here's the typical PyTorch project structure organized in a Light
.. raw:: html
<video width="800" controls autoplay src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pl_module_vid.m4v"></video>
<video width="100%" controls autoplay src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pl_module_vid.m4v"></video>
----------
@ -68,7 +68,7 @@ well across any accelerator.
.. raw:: html
<video width="800" controls autoplay src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pt_trainer_mov.m4v"></video>
<video width="100%" controls autoplay src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pt_trainer_mov.m4v"></video>
|
@ -125,7 +125,7 @@ via hooks that are called on your LightningModule.
.. raw:: html
<video width="800" controls autoplay src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pt_callbacks_mov.m4v"></video>
<video width="100%" controls autoplay src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pt_callbacks_mov.m4v"></video>
----------------
@ -342,7 +342,7 @@ Here's an illustration that explains how to refactor your code into reusable Dat
.. raw:: html
<video width="800" controls autoplay src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pt_dm_vid.m4v"></video>
<video width="100%" controls autoplay src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pt_dm_vid.m4v"></video>
|

3
docs/source/tasks.rst Normal file
View File

@ -0,0 +1,3 @@
Tasks
=====
To write

View File

View File

@ -0,0 +1,5 @@
class FastTask(object):
def __init__(self):
pass

View File

@ -12,7 +12,7 @@ the Trainer automates everything else.
.. raw:: html
<video width="800" controls autoplay
<video width="100%" controls autoplay
src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/pt_trainer_mov.m4v"></video>
|