From 1142fb43ffecdf0f87faa32f487a675216af015a Mon Sep 17 00:00:00 2001 From: Vincent Berenz Date: Tue, 6 Jun 2023 14:39:58 +0200 Subject: [PATCH] added jupyter notebooks to the html documentation --- docs/notebooks/augmented_flow.ipynb | 1 + docs/notebooks/change_base_distribution.ipynb | 1 + docs/notebooks/circular_nsf.ipynb | 1 + docs/notebooks/comparison_plan_rad_aff.ipynb | 1 + docs/notebooks/glow.ipynb | 1 + docs/notebooks/glow_colab.ipynb | 1 + docs/notebooks/image.ipynb | 1 + docs/notebooks/neural_spline_flow.ipynb | 1 + docs/notebooks/paper_example_nsf.ipynb | 1 + docs/notebooks/paper_example_nsf_colab.ipynb | 1 + docs/notebooks/planar.ipynb | 1 + docs/notebooks/real_nvp.ipynb | 1 + docs/notebooks/real_nvp_ipynb | 1 + docs/notebooks/residual.ipynb | 1 + docs/notebooks/vae.ipynb | 1 + mkdocs.yml | 16 +++++++++++++++- 16 files changed, 30 insertions(+), 1 deletion(-) create mode 120000 docs/notebooks/augmented_flow.ipynb create mode 120000 docs/notebooks/change_base_distribution.ipynb create mode 120000 docs/notebooks/circular_nsf.ipynb create mode 120000 docs/notebooks/comparison_plan_rad_aff.ipynb create mode 120000 docs/notebooks/glow.ipynb create mode 120000 docs/notebooks/glow_colab.ipynb create mode 120000 docs/notebooks/image.ipynb create mode 120000 docs/notebooks/neural_spline_flow.ipynb create mode 120000 docs/notebooks/paper_example_nsf.ipynb create mode 120000 docs/notebooks/paper_example_nsf_colab.ipynb create mode 120000 docs/notebooks/planar.ipynb create mode 120000 docs/notebooks/real_nvp.ipynb create mode 120000 docs/notebooks/real_nvp_ipynb create mode 120000 docs/notebooks/residual.ipynb create mode 120000 docs/notebooks/vae.ipynb diff --git a/docs/notebooks/augmented_flow.ipynb b/docs/notebooks/augmented_flow.ipynb new file mode 120000 index 0000000..4221e9d --- /dev/null +++ b/docs/notebooks/augmented_flow.ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/augmented_flow.ipynb \ No newline at end of file diff --git a/docs/notebooks/change_base_distribution.ipynb b/docs/notebooks/change_base_distribution.ipynb new file mode 120000 index 0000000..7e68607 --- /dev/null +++ b/docs/notebooks/change_base_distribution.ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/change_base_distribution.ipynb \ No newline at end of file diff --git a/docs/notebooks/circular_nsf.ipynb b/docs/notebooks/circular_nsf.ipynb new file mode 120000 index 0000000..6d5bb57 --- /dev/null +++ b/docs/notebooks/circular_nsf.ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/circular_nsf.ipynb \ No newline at end of file diff --git a/docs/notebooks/comparison_plan_rad_aff.ipynb b/docs/notebooks/comparison_plan_rad_aff.ipynb new file mode 120000 index 0000000..94f5f85 --- /dev/null +++ b/docs/notebooks/comparison_plan_rad_aff.ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/comparison_plan_rad_aff.ipynb \ No newline at end of file diff --git a/docs/notebooks/glow.ipynb b/docs/notebooks/glow.ipynb new file mode 120000 index 0000000..0d3dd3a --- /dev/null +++ b/docs/notebooks/glow.ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/glow.ipynb \ No newline at end of file diff --git a/docs/notebooks/glow_colab.ipynb b/docs/notebooks/glow_colab.ipynb new file mode 120000 index 0000000..3671586 --- /dev/null +++ b/docs/notebooks/glow_colab.ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/glow_colab.ipynb \ No newline at end of file diff --git a/docs/notebooks/image.ipynb b/docs/notebooks/image.ipynb new file mode 120000 index 0000000..2017fe5 --- /dev/null +++ b/docs/notebooks/image.ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/image.ipynb \ No newline at end of file diff --git a/docs/notebooks/neural_spline_flow.ipynb b/docs/notebooks/neural_spline_flow.ipynb new file mode 120000 index 0000000..7c205b1 --- /dev/null +++ b/docs/notebooks/neural_spline_flow.ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/neural_spline_flow.ipynb \ No newline at end of file diff --git a/docs/notebooks/paper_example_nsf.ipynb b/docs/notebooks/paper_example_nsf.ipynb new file mode 120000 index 0000000..0817d56 --- /dev/null +++ b/docs/notebooks/paper_example_nsf.ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/paper_example_nsf.ipynb \ No newline at end of file diff --git a/docs/notebooks/paper_example_nsf_colab.ipynb b/docs/notebooks/paper_example_nsf_colab.ipynb new file mode 120000 index 0000000..e0e3a23 --- /dev/null +++ b/docs/notebooks/paper_example_nsf_colab.ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/paper_example_nsf_colab.ipynb \ No newline at end of file diff --git a/docs/notebooks/planar.ipynb b/docs/notebooks/planar.ipynb new file mode 120000 index 0000000..f103ee8 --- /dev/null +++ b/docs/notebooks/planar.ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/planar.ipynb \ No newline at end of file diff --git a/docs/notebooks/real_nvp.ipynb b/docs/notebooks/real_nvp.ipynb new file mode 120000 index 0000000..d6be140 --- /dev/null +++ b/docs/notebooks/real_nvp.ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/real_nvp.ipynb \ No newline at end of file diff --git a/docs/notebooks/real_nvp_ipynb b/docs/notebooks/real_nvp_ipynb new file mode 120000 index 0000000..7b30fa2 --- /dev/null +++ b/docs/notebooks/real_nvp_ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/real_nvp_colab.ipynb \ No newline at end of file diff --git a/docs/notebooks/residual.ipynb b/docs/notebooks/residual.ipynb new file mode 120000 index 0000000..3ee98c7 --- /dev/null +++ b/docs/notebooks/residual.ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/residual.ipynb \ No newline at end of file diff --git a/docs/notebooks/vae.ipynb b/docs/notebooks/vae.ipynb new file mode 120000 index 0000000..a4cf5b9 --- /dev/null +++ b/docs/notebooks/vae.ipynb @@ -0,0 +1 @@ +/home/vberenz/Workspaces/normalizing-flows/examples/vae.ipynb \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 0327745..66ec6a9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,6 +5,7 @@ site_url: https://github.com/VincentStimper/normalizing-flows plugins: - search - autorefs + - mkdocs-jupyter - mkdocstrings: handlers: python: @@ -12,5 +13,18 @@ plugins: show_submodules: true nav: - - about: index.md + - About: index.md - API: references.md + - Examples: + - augmented_flow: notebooks/augmented_flow.ipynb + - change_base_distribution: notebooks/change_base_distribution.ipynb + - circular_nsf: notebooks/circular_nsf.ipynb + - comparison_plan_rad_aff: notebooks/comparison_plan_rad_aff.ipynb + - glow: notebooks/glow.ipynb + - image: notebooks/image.ipynb + - neural_spline_flow: notebooks/neural_spline_flow.ipynb + - paper_example_nsf: notebooks/paper_example_nsf.ipynb + - planar: notebooks/planar.ipynb + - real_nvp: notebooks/real_nvp.ipynb + - residual: notebooks/residual.ipynb + - vae: notebooks/vae.ipynb