prepare space for fused docs (#14160)
* copy app conf * ci + req. * script symlink * wip * keep only App * add also PL * lightning * artifact
This commit is contained in:
Jirka Borovec
GitHub
parent
7987a1b453
commit
208bf6faa8
|
|
@ -17,7 +17,7 @@ jobs:
|
|||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
pkg: ["app", "pytorch"]
|
||||
pkg: ["app", "pytorch"] # TODO: , "lit"
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
|
|
@ -68,7 +68,7 @@ jobs:
|
|||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
pkg: ["app", "pytorch"]
|
||||
pkg: ["app", "pytorch", "lit"]
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
|
|
@ -112,7 +112,7 @@ jobs:
|
|||
- name: Upload built docs
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: docs-results-${{ github.sha }}
|
||||
name: docs-${{ matrix.pkg }}-${{ github.sha }}
|
||||
path: docs/build/html/
|
||||
# Use always() to always run this step to publish test results when there are test failures
|
||||
if: success()
|
||||
|
|
|
|||
|
|
@ -9,6 +9,9 @@ lightning_logs/
|
|||
# Documentations
|
||||
docs/source-app/generated
|
||||
docs/source-app/*/generated
|
||||
docs/source-lit/generated
|
||||
docs/source-lit/*/generated
|
||||
docs/source-lit/api
|
||||
docs/source-pytorch/api
|
||||
docs/source-pytorch/*.md
|
||||
docs/source-pytorch/generated
|
||||
|
|
|
|||
3
Makefile
3
Makefile
|
|
@ -22,6 +22,9 @@ clean:
|
|||
rm -rf ./docs/source-pytorch/api
|
||||
rm -rf ./docs/source-app/generated
|
||||
rm -rf ./docs/source-app/*/generated
|
||||
rm -rf ./docs/source-lit/api
|
||||
rm -rf ./docs/source-lit/generated
|
||||
rm -rf ./docs/source-lit/*/generated
|
||||
rm -rf build
|
||||
rm -rf dist
|
||||
rm -rf *.egg-info
|
||||
|
|
|
|||
|
|
@ -0,0 +1,27 @@
|
|||
import glob
|
||||
import os
|
||||
|
||||
|
||||
def symlink_folder(source_dir, target_dir: str = "source-lit") -> None:
|
||||
assert os.path.isdir(source_dir)
|
||||
assert os.path.isdir(target_dir)
|
||||
ls = glob.glob(os.path.join(source_dir, "**"), recursive=True)
|
||||
for path_ in ls:
|
||||
path_target = path_.replace(source_dir, target_dir)
|
||||
if os.path.isdir(path_) or os.path.exists(path_target):
|
||||
continue
|
||||
if os.path.islink(path_target):
|
||||
print(path_target)
|
||||
continue
|
||||
path_dir = os.path.dirname(path_target)
|
||||
os.makedirs(path_dir, exist_ok=True)
|
||||
depth = path_.count(os.path.sep)
|
||||
path_root = os.path.sep.join([".."] * depth)
|
||||
path_source = os.path.join(path_root, path_)
|
||||
# print(path_source, path_target, os.path.exists(path_target))
|
||||
os.symlink(path_source, path_target)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
for name in ("app", "pytorch"):
|
||||
symlink_folder(f"source-{name}")
|
||||
|
|
@ -1,6 +1,5 @@
|
|||
from docs.quickstart.app_02 import HourLongWork
|
||||
|
||||
import lightning as L
|
||||
from docs.quickstart.app_02 import HourLongWork
|
||||
|
||||
|
||||
class RootFlow(L.LightningFlow):
|
||||
|
|
|
|||
|
|
@ -0,0 +1,19 @@
|
|||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS = -T -W
|
||||
SPHINXBUILD = sphinx-build
|
||||
SOURCEDIR = .
|
||||
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)
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-app/_static/copybutton.js
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../../source-pytorch/_static/images/accelerator/ipus/profiler.png
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/benchmarks/figure-parity-times.png
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/general/PTL101_youtube_thumbnail.jpg
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/general/fast_2.gif
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/general/pl_overview.gif
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/general/pl_overview_flat.jpg
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/general/pl_quick_start_full_compressed.gif
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/general/tf_loss.jpg
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/general/tf_tags.jpg
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/general/tutorial_cover.jpg
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../source-app/_static/images/icon.svg
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/lightning_lite/lite.gif
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/lightning_module/pt_to_pl.png
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/lightning_module/pt_trainer.png
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../source-app/_static/images/logo-large.svg
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../source-app/_static/images/logo-small.svg
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../source-app/_static/images/logo.png
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../source-app/_static/images/logo.svg
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../source-pytorch/_static/images/logo_light.svg
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/mnist_imgs/mnist_cpu_bar.png
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/mnist_imgs/mnist_gpu.png
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/mnist_imgs/mnist_tb.png
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/mnist_imgs/pt_to_pl.jpg
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/mnist_imgs/restart_runtime.png
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/mnist_imgs/runtime_tpu.png
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/mnist_imgs/tpu_fast.png
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/mnist_imgs/tpu_start.png
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../source-pytorch/_static/images/trainer/lr_finder.png
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-app/_static/main.css
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../source-pytorch/_templates/autosummary/module.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-app/_templates/classtemplate.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-app/_templates/classtemplate_no_index.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-app/_templates/layout.html
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-app/_templates/theme_variables.jinja
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/accelerator_prepare.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/gpu.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/gpu_advanced.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/gpu_basic.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/gpu_expert.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/gpu_faq.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/gpu_intermediate.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/hpu.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/hpu_basic.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/hpu_intermediate.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/ipu.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/ipu_advanced.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/ipu_basic.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/ipu_intermediate.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/mps.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/mps_basic.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/tpu.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/tpu_advanced.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/tpu_basic.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/tpu_faq.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/accelerators/tpu_intermediate.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/advanced/finetuning.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/advanced/model_parallel.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/advanced/pretrained.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/advanced/pruning_quantization.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/advanced/strategy_registry.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/advanced/training_tricks.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/advanced/transfer_learning.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-app/api_reference/components.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-app/api_reference/core.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-app/api_reference/frontend.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-app/api_reference/runners.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-app/api_reference/storage.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../source-app/api_references.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../source-app/basics.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/benchmarking/benchmarks.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/cli/lightning_cli.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/cli/lightning_cli_advanced.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/cli/lightning_cli_advanced_2.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/cli/lightning_cli_advanced_3.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/cli/lightning_cli_expert.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/cli/lightning_cli_faq.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/cli/lightning_cli_intermediate.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/cli/lightning_cli_intermediate_2.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/cloud_training.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/cloud_training_intermediate.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/cluster.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/cluster_advanced.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/cluster_expert.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/cluster_intermediate_1.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/cluster_intermediate_2.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/fault_tolerant_training.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/fault_tolerant_training_basic.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/fault_tolerant_training_expert.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/fault_tolerant_training_faq.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/grid_costs.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/run_advanced.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/run_basic.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../source-pytorch/clouds/run_expert.rst
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue