apply Lightning-AI/pytorch-lightning@f931e27

Author: 9bow

.gitignore

@@ -0,0 +1,165 @@
+# project
+.DS_Store
+run_configs/
+model_weights/
+app/models/
+pip-wheel-metadata/
+lightning_logs/
+.vscode/
+
+# Test-tube
+test_tube_*/
+
+# Documentations
+docs/source/api
+docs/source/*.md
+docs/source/generated
+docs/source/*/generated
+docs/source/notebooks
+docs/source/_static/images/course_UvA-DL
+docs/source/_static/images/lightning_examples
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+timit_data/
+grid_generated*
+grid_ori*
+
+
+
+# C extensions
+*.so
+
+# PyCharm
+.idea/
+
+# Distribution / packaging
+.Python
+ide_layouts/
+build/
+_build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+tests/tests_tt_dir/
+tests/save_dir
+tests/tests/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+env/
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+# pytest
+.pytest_cache/
+
+# data
+.data/
+Datasets/
+mnist/
+MNIST/
+legacy/checkpoints/
+*.gz
+*ubyte
+
+# pl tests
+ml-runs/
+mlruns/
+*.zip
+*.ckpt
+pytorch\ lightning
+test-reports/
+wandb
+.forked/
+*.prof
+*.tar.gz
+.neptune/
+
+# dataset generated from bolts in examples.
+cifar-10-batches-py
+*.pt
+# ctags
+tags
+.tags

Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

@@ -0,0 +1,79 @@
+# PyTorch-Lightning Docs
+
+We are using Sphinx with Napoleon extension.
+Moreover, we set Google style to follow with type convention.
+
+- [Napoleon formatting with Google style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
+- [ReStructured Text (reST)](https://docs.pylonsproject.org/projects/docs-style-guide/)
+- [Paragraph-level markup](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#paragraphs)
+
+See following short example of a sample function taking one position string and optional
+
+```python
+from typing import Optional
+
+
+def my_func(param_a: int, param_b: Optional[float] = None) -> str:
+    """Sample function.
+
+    Args:
+        param_a: first parameter
+        param_b: second parameter
+
+    Return:
+        sum of both numbers
+
+    Example::
+
+        >>> my_func(1, 2)
+        3
+
+    Note:
+        If you want to add something.
+    """
+    p = param_b if param_b else 0
+    return str(param_a + p)
+```
+
+## Building Docs
+
+When updating the docs, make sure to build them first locally and visually inspect the html files in your browser for
+formatting errors. In certain cases, a missing blank line or a wrong indent can lead to a broken layout.
+Run these commands
+
+```bash
+git submodule update --init --recursive
+pip install -r requirements/docs.txt
+make clean
+cd docs
+make html
+```
+
+and open `docs/build/html/index.html` in your browser.
+
+When you send a PR the continuous integration will run tests and build the docs. You can access a preview of the html pages in the
+_Artifacts_ tab in CircleCI when you click on the task named _build-Docs_ of _ci-tests_ at the bottom of the PR page.
+
+Notes (Optional):
+
+- You need to have LaTeX installed for rendering math equations. You can for example install TeXLive by doing one of the following:
+  - on Ubuntu (Linux) run `apt-get install texlive` or otherwise follow the instructions on the TeXLive website
+  - use the [RTD docker image](https://hub.docker.com/r/readthedocs/build)
+
+## Developing docs
+
+When developing the docs, building docs can be VERY slow locally because of the notebook tutorials.
+To speed this up, enable this flag in before building docs:
+
+```bash
+# builds notebooks which is slow
+export PL_FAST_DOCS_DEV=0
+
+# fast notebook build which is fast
+export PL_FAST_DOCS_DEV=1
+```
+
+## docs CSS/theme
+
+To change the CSS theme of the docs, go [here](https://github.com/PyTorchLightning/lightning_sphinx_theme).
+Apologies in advance... this is a bit complex to build and requires basic understanding of javascript/npm.

__about__.py

@@ -0,0 +1,38 @@
+import time
+
+_this_year = time.strftime("%Y")
+__version__ = "1.7.0dev"
+__author__ = "William Falcon et al."
+__author_email__ = "waf2107@columbia.edu"
+__license__ = "Apache-2.0"
+__copyright__ = f"Copyright (c) 2018-{_this_year}, {__author__}."
+__homepage__ = "https://github.com/PyTorchLightning/pytorch-lightning"
+__docs_url__ = "https://pytorch-lightning.readthedocs.io/en/stable/"
+# this has to be simple string, see: https://github.com/pypa/twine/issues/522
+__docs__ = (
+    "PyTorch Lightning is the lightweight PyTorch wrapper for ML researchers."
+    " Scale your models. Write less boilerplate."
+)
+__long_docs__ = """
+Lightning is a way to organize your PyTorch code to decouple the science code from the engineering.
+ It's more of a style-guide than a framework.
+
+In Lightning, you organize your code into 3 distinct categories:
+
+1. Research code (goes in the LightningModule).
+2. Engineering code (you delete, and is handled by the Trainer).
+3. Non-essential research code (logging, etc. this goes in Callbacks).
+
+Although your research/production project might start simple, once you add things like GPU AND TPU training,
+ 16-bit precision, etc, you end up spending more time engineering than researching.
+ Lightning automates AND rigorously tests those parts for you.
+
+Overall, Lightning guarantees rigorously tested, correct, modern best practices for the automated parts.
+
+Documentation
+-------------
+- https://pytorch-lightning.readthedocs.io/en/latest
+- https://pytorch-lightning.readthedocs.io/en/stable
+"""
+
+__all__ = ["__author__", "__author_email__", "__copyright__", "__docs__", "__homepage__", "__license__", "__version__"]

make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd