8ee6d91d0e
code guideline ( #1949 )
...
* code rule
* Apply suggestions from code review
Co-authored-by: Jeremy Jordan <13970565+jeremyjordan@users.noreply.github.com >
* chlog
Co-authored-by: Jeremy Jordan <13970565+jeremyjordan@users.noreply.github.com >
Co-authored-by: Nicki Skafte <skaftenicki@gmail.com >
2020-05-28 14:40:49 +00:00
Jirka Borovec
1c10560531
Fix failing docs ( #1821 )
...
* missing pkg
* update CI
* strict RTD
* strict RTD
* make
* missing
* ignore
* ignore
* mock
* typo
2020-05-14 08:25:06 -04:00
Adrian Wälchli
0cb58fbb4c
Mock packages for RTD docs build (follow up to doctests) ( #1739 )
...
* mock all packages on RTD
* update
2020-05-05 16:48:45 -04:00
Adrian Wälchli and Jirka Borovec
a6de1b8d75
doctest for .rst files ( #1511 )
...
* add doctest to circleci
* Revert "add doctest to circleci"
This reverts commit c45b34ea911a81f87989f6c3a832b1e8d8c471c6.
* Revert "Revert "add doctest to circleci""
This reverts commit 41fca97fdcfe1cf4f6bdb3bbba75d25fa3b11f70.
* doctest docs rst files
* Revert "doctest docs rst files"
This reverts commit b4a2e83e3da5ed1909de500ec14b6b614527c07f.
* doctest only rst
* doctest debugging.rst
* doctest apex
* doctest callbacks
* doctest early stopping
* doctest for child modules
* doctest experiment reporting
* indentation
* doctest fast training
* doctest for hyperparams
* doctests for lr_finder
* doctests multi-gpu
* more doctest
* make doctest drone
* fix label build error
* update fast training
* update invalid imports
* fix problem with int device count
* rebase stuff
* wip
* wip
* wip
* intro guide
* add missing code block
* circleci
* logger import for doctest
* test if doctest runs on drone
* fix mnist download
* also run install deps for building docs
* install cmake
* try sudo
* hide output
* try pip stuff
* try to mock horovod
* Tranfer -> Transfer
* add torchvision to extras
* revert pip stuff
* mlflow file location
* do not mock torch
* torchvision
* drone extra req.
* try higher sphinx version
* Revert "try higher sphinx version"
This reverts commit 490ac28e46d6fd52352640dfdf0d765befa56988.
* try coverage command
* try coverage command
* try undoc flag
* newline
* undo drone
* report coverage
* review
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com >
* remove torchvision from extras
* skip tests only if torchvision not available
* fix testoutput torchvision
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com >
2020-05-04 22:16:54 -04:00
48e808c20e
Move generated RST files to subfolder ( #1555 )
...
* move generated files to subfolder
* remove if exists
* reformat argv
Co-Authored-By: Jirka Borovec <Borda@users.noreply.github.com >
* update rebase
* rebase yml
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com >
Co-authored-by: J. Borovec <jirka.borovec@seznam.cz >
2020-05-04 16:53:06 -04:00
Justus Schock and J. Borovec
29c7d2f195
Revert namespace package search to normal package search ( #1545 )
...
* Revert this
* typos
* version++
Co-authored-by: J. Borovec <jirka.borovec@seznam.cz >
2020-04-21 08:26:47 -04:00
Jirka Borovec
bd168819f2
fix changelog ( #1452 )
...
* fix changelog
* formatting
* add ddp_cpu
* docs
* add another
2020-04-20 17:36:26 -04:00
Adrian Wälchli and Jirka Borovec
6e1d72d98a
Improved docs for Loggers ( #1484 )
...
* improve __init__
* improve logger base
* improve comet logger docs
* improved docs for mlflow
* improved nepune logger docs
* fix matplotlib import issue
* improve tensorboard docs
* improve docs for test tube
* improved trains logger docs
* improve wandb logger docs
* improved docs in experiment_logging.rst
* added MLflow to the list of loggers
* fix too long lines
* fix trains doctest
* fix neptune doctest
* fix mlflow doctest
* Apply suggestions from code review
Co-Authored-By: Jirka Borovec <Borda@users.noreply.github.com >
* Apply suggestions from code review
* fix whitespace
* try bypass mode for neptune (fix doctest api key error)
* try "test" as api key
* Revert "try "test" as api key"
This reverts commit fd77db26d551f08b4b4a12bb93cbd8f7a0814f29.
* try test as api key
* update neptune docs
* bump neptune minimal version
* revert unnecessary bypass code
* test if CI runs doctests in .rst files
* Revert "test if CI runs doctests in .rst files"
This reverts commit a45aeb460a8c4b7445a35dd7b49265f48d11c485.
* add doctest directive
* neptune demo links
* added tutorial link for W&B
* fix line too long
* fix merge error
* fix merge error
* add instructions how to install loggers
* add instructions how to install the loggers
* hide _abc_impl property from docs
* review Borda, 4 spaces
* indentation in example sections
* blank
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com >
2020-04-16 12:04:12 -04:00
5f6be4dd53
Pin sphinx version (fix for current docs build errors) ( #1382 )
...
* Update requirements.txt
* Update docs/requirements.txt
Co-Authored-By: Jirka Borovec <Borda@users.noreply.github.com >
* freeze sphinx version
* Update docs/source/conf.py
Co-Authored-By: Adrian Wälchli <aedu.waelchli@gmail.com >
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com >
Co-authored-by: J. Borovec <jirka.borovec@seznam.cz >
2020-04-06 06:42:33 +00:00
Adrian Wälchli
b358714a9a
Adding Intersphinx documentation links ( #1369 )
...
* added intersphinx links for base packages
* remove comment
2020-04-05 11:11:58 -04:00
Jirka Borovec and Adrian Wälchli
38b63f95af
Docs badges / images ( #1202 )
...
* move docs images
* click GH badges
* fixed docs build error
Co-Authored-By: Adrian Wälchli <adrian.waelchli@inf.unibe.ch >
Co-authored-by: Adrian Wälchli <adrian.waelchli@inf.unibe.ch >
2020-03-24 14:50:35 -04:00
792962ecc9
CI: Force docs warnings to be raised as errors (+ fix all) ( #1191 )
...
* add argument to force warn
* fix automodule error
* fix permalink error
* fix indentation warning
* fix warning
* fix import warnings
* fix duplicate label warning
* fix bullet point indentation warning
* fix duplicate label warning
* fix "import not top level" warning
* line too long
* fix indentation
* fix bullet points indentation warning
* fix hooks warnings
* fix reference problem with excluded test_tube
* fix indentation in print
* change imports for trains logger
* remove pandas type annotation
* Update pytorch_lightning/core/lightning.py
* include bullet points inside note
* remove old quick start guide (unused)
* fix unused warning
* fix formatting
* fix duplicate label issue
* fix duplicate label warning (replaced by class ref)
* fix tick
* fix indentation warnings
* docstring ticks
* remove obsolete docstring typing
* Revert "remove old quick start guide (unused)"
This reverts commit d51bb40695442c8fa11bc9df74f6db56264f7509.
* added old quick start guide to navigation
* remove unused tutorials file
* ignore some modules that got deprecated and are not used anymore
* fix duplicate label warning
* move examples doc and exclude pl_examples from autodoc
* fix formatting for configure_optimizer
* fix no blank line warnings
* fix "see also" labels and add paramref extension
* fix more reference problems
* fix multi-gpu reference
* fix weird warning
* fix indentation and unrecognized characters in code block
* fix warning "... not included in toctree"
* fix PIL import error
* fix duplicate target "here" warning
* fix broken link
* revert accidentally moved pl_examples
* changelog
* stdout
* note some things to know
Co-Authored-By: Jirka Borovec <Borda@users.noreply.github.com >
Co-authored-by: J. Borovec <jirka.borovec@seznam.cz >
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com >
2020-03-20 20:49:01 +01:00
c0bedd2587
Add TRAINS experiment manager support ( #1122 )
...
* Add allegro.ai TRAINS experiment manager support
* improve docstring and type hinting, fix the bug in log_metrics, add support torch.Tensor to input into log_image
* complete missing docstring of constructor's arguments
* fix docs
* pep8
* pep8
* remove redundant typing
use logging
fix typing and pep8
* remove deprecated interface
* add TrainsLogger test
* add TrainsLogger PR in CHANGELOG
* add id/name property documentation
* change logging as log
Co-authored-by: bmartinn <>
Co-authored-by: Sou Uchida <s.aiueo32@gmail.com >
2020-03-14 13:02:14 -04:00
Jirka Borovec
25bb33ad45
extend docs notes ( #1004 )
...
* wip
* notes
* WIP
* example
* notes
2020-03-06 07:07:04 -05:00
563e2ba2c6
resolving documentation warnings ( #833 )
...
* add more underline
* fix LightningMudule import error
* remove unneeded blank line
* escape asterisk to fix inline emphasis warning
* add PULL_REQUEST_TEMPLATE.md
* add __init__.py and import imagenet_example
* fix duplicate label
* add noindex option to fix duplicate object warnings
* remove unexpected indent
* refer explicit LightningModule
* fix minor bug
* refer EarlyStopping explicitly
* restore exclude patterns
* change the way how to refer class
* remove unused import
* update badges & drop Travis/Appveyor (#826 )
* drop Travis
* drop Appveyor
* update badges
* fix missing PyPI images & CI badges (#853 )
* docs - anchor links (#848 )
* docs - add links
* add desc.
* add Greeting action (#843 )
* add Greeting action
* Update greetings.yml
Co-authored-by: William Falcon <waf2107@columbia.edu >
* add pep8speaks (#842 )
* advanced profiler describe + cleaned up tests (#837 )
* add py36 compatibility
* add test case to capture previous bug
* clean up tests
* clean up tests
* Update lightning_module_template.py
* Update lightning.py
* respond lint issues
* break long line
* break more lines
* checkout conflicting files from master
* shorten url
* checkout from upstream/master
* remove trailing whitespaces
* remove unused import LightningModule
* fix sphinx bot warnings
* Apply suggestions from code review
just to trigger CI
* Update .github/workflows/greetings.yml
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com >
Co-authored-by: William Falcon <waf2107@columbia.edu >
Co-authored-by: Jeremy Jordan <13970565+jeremyjordan@users.noreply.github.com >
2020-02-27 16:07:51 -05:00
Adrian Wälchli and William Falcon
da2f11a9c4
Type Hints for Trainer ( #912 )
...
* typehints for trainer
fix type links in docs
fix types in docs
type hints for trainer methods
fix fit docs
switch to comments
readability
added sphinx typehints extension
wip
remove typehints from docstring
more type annotations
fix spaces
* Update trainer.py
Co-authored-by: William Falcon <waf2107@columbia.edu >
2020-02-22 21:23:30 -05:00
Luis Capelo
b9b5a93f0f
Updates theme Sphinx configuration ( #893 )
...
I am updating the project's Sphinx documentation to fix (#819 ). The issue is related to a library the Sphinx extension `nbsphinx` (to load Jupyter Notebooks) loads into the docs context (RequireJS). That library conflicts with other theme libraries, causing the latter to be not loaded. This would result in several crashes, the most obvious of them the lack of anchors.
The fix above solves all errors -- and now anchors work.
2020-02-19 04:48:33 -05:00
Jirka Borovec
149e466dbe
docs - anchor links ( #848 )
...
* docs - add links
* add desc.
2020-02-15 20:30:31 -05:00
Ir1dXD
64d1bac7d6
set html_add_permalinks for docs ( #812 )
...
ref: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_add_permalinks
2020-02-11 08:19:21 -05:00
Jirka Borovec
853c4c1e7b
update deprecated messages ( #810 )
...
* update deprecated messages
* formatting
* fix docs tags
2020-02-11 07:41:15 -05:00
Jirka Borovec
ed26c177b2
drop sklearn dependency ( #801 )
2020-02-11 00:21:35 -05:00
Jirka Borovec
5130841bef
update Docs [links & formatting] ( #769 )
...
* wip
* wip
* debug imports
docs formatting
* WIP
* formatting
* fix setup
2020-02-09 17:39:10 -05:00
Jirka Borovec
cc12ff36a9
fix links to Docs ( #744 )
...
* update log
* fix links
* formatting
* fixing docs path
* formatting
2020-01-26 08:38:01 -05:00
Jirka Borovec
ea59a99426
update org paths & convert logos ( #685 )
...
* fix typos
* update org paths
* update links from READMe to docs
* add svg logo
* add svg logo-text
* update logos
* testing temp paths
* prune links from readme
* optimize imports
* update logo
* update paths in README
* missing imports
2020-01-20 14:50:31 -05:00
William Falcon and Jirka Borovec
bc67689068
clean v2 docs ( #691 )
...
* updated gitignore
* Update README.md
* updated gitignore
* updated links in ninja file
* updated docs
* Update README.md
* Update README.md
* finished callbacks
* finished callbacks
* finished callbacks
* fixed left menu
* added callbacks to menu
* added direct links to docs
* added direct links to docs
* added direct links to docs
* added direct links to docs
* added direct links to docs
* fixing TensorBoard (#687 )
* flake8
* fix typo
* fix tensorboardlogger
drop test_tube dependence
* formatting
* fix tensorboard & tests
* upgrade Tensorboard
* test formatting separately
* try to fix JIT issue
* add tests for 1.4
* added direct links to docs
* updated gitignore
* updated links in ninja file
* updated docs
* finished callbacks
* finished callbacks
* finished callbacks
* fixed left menu
* added callbacks to menu
* added direct links to docs
* added direct links to docs
* added direct links to docs
* added direct links to docs
* added direct links to docs
* added direct links to docs
* finished rebase
* making private members
* making private members
* making private members
* working on trainer docs
* working on trainer docs
* working on trainer docs
* working on trainer docs
* working on trainer docs
* working on trainer docs
* set auto dp if no backend
* working on trainer docs
* working on trainer docs
* working on trainer docs
* working on trainer docs
* working on trainer docs
* working on trainer docs
* working on trainer docs
* working on trainer docs
* fixed lightning import
* cleared spaces
* cleared spaces
* cleared spaces
* cleared spaces
* cleared spaces
* cleared spaces
* cleared spaces
* cleared spaces
* cleared spaces
* cleared spaces
* finished lightning module
* finished lightning module
* finished lightning module
* finished lightning module
* added callbacks
* added loggers
* added loggers
* added loggers
* added loggers
* added loggers
* added loggers
* added loggers
* added loggers
* set auto dp if no backend
* added loggers
* added loggers
* added loggers
* added loggers
* added loggers
* added loggers
* flake 8
* flake 8
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com >
2020-01-17 06:03:31 -05:00
ec7fc97857
Feature: wandb logger ( #627 )
...
* Basic wandb support
* refactor(wandb): remove unused variables and document logger
* docs(wandb): explain how to use WandbLogger
* test(wandb): add tests for WandbLogger
* feat(wandb): add save_dir
* fix(wandb): allow pickle of logger
* fix(wandb): save logs in custom directory
* test(wandb): test import
* docs(wandb): simplify docstring and use doctest
* test: increase number of epochs for satisfactory accuracy
* test(test_load_model_from_checkpoint): ensure we load last checkpoint
Co-authored-by: Chris Van Pelt <vanpelt@wandb.com >
Co-authored-by: William Falcon <waf2107@columbia.edu >
2020-01-13 22:25:27 -05:00
Jakub and William Falcon
8dc8a8bfd3
Neptune integration ( #648 )
...
* added neptune integration
* added tests for NeptuneLogger, added neptune to docs
* updated link to neptune support
* fixed docstrings, fixed try/except in tests, changed append_tags input
* fixed docstrings line lenght
* bumped epoch nr in model restore tests
* added tags support for single strings
* fixed passing neptune token to backend
* fixed project name in offline mode
* added save_top_k=-1 to checkpoint callback
* reformated initialization of neptune in online mode
* bumped epoch nr to 4 in test_load_model_from_checkpoint
* bumped epoch nr to 5
Co-authored-by: William Falcon <waf2107@columbia.edu >
2020-01-13 22:20:01 -05:00
Jirka Borovec
c374c4fb80
extend documentation ( #569 )
...
* extend documentation
* update index
* fix list
2019-12-07 00:23:48 -05:00
Jirka Borovec
d71556e7a1
Sphinx generated documentation ( #521 )
...
* upgrade req.
* move MkDocs
* create Sphinx
* init Sphinx
* move md from MkDocs to Sphinx
* CI: build docs
* build Sphinx
formatting
move docs from MD to docstring in particular package/modules
formatting
add Sphinx ext.
rename root_module to core
drop implicit name "_logger"
drop duplicate name "overwrite"
fix imports
use pytorch theme
add sample link mapping
try fix RTD build
use forked template
fix some docs warnings
fix paths
add deprecation warnings
fix flake8
fix paths
revert refactor
revert MLFlowLogger
* revert example import
* update link
* Update lightning_module_template.py
2019-11-28 12:48:55 -05:00
