diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml index 16942f92c..1d01f8a88 100644 --- a/.github/workflows/preview.yml +++ b/.github/workflows/preview.yml @@ -10,6 +10,7 @@ concurrency: group: docs permissions: + actions: write contents: write pull-requests: write diff --git a/_quarto.yml b/_quarto.yml index 8d5a175c4..586af0f35 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -100,30 +100,23 @@ website: - section: "Developers" contents: - - section: "Contributing" - collapse-level: 1 - contents: - - text: "How to Contribute" - href: tutorials/docs-01-contributing-guide/index.qmd + - developers/contributing/index.qmd - - section: "DynamicPPL in Depth" + - section: "DynamicPPL's Compiler" collapse-level: 1 contents: - - tutorials/dev-model-manual/index.qmd - - tutorials/docs-05-for-developers-compiler/index.qmd - - text: "A Mini Turing Implementation I: Compiler" - href: tutorials/14-minituring/index.qmd - - text: "A Mini Turing Implementation II: Contexts" - href: tutorials/16-contexts/index.qmd + - developers/compiler/model-manual/index.qmd + - developers/compiler/minituring-compiler/index.qmd + - developers/compiler/minituring-contexts/index.qmd + - developers/compiler/design-overview/index.qmd - section: "Inference (note: outdated)" collapse-level: 1 contents: - - tutorials/docs-06-for-developers-interface/index.qmd - - tutorials/docs-04-for-developers-abstractmcmc-turing/index.qmd - - tutorials/docs-07-for-developers-variational-inference/index.qmd - - text: "Implementing Samplers" - href: tutorials/docs-17-implementing-samplers/index.qmd + - developers/inference/abstractmcmc-interface/index.qmd + - developers/inference/abstractmcmc-turing/index.qmd + - developers/inference/variational-inference/index.qmd + - developers/inference/implementing-samplers/index.qmd page-footer: background: "#073c44" @@ -180,13 +173,6 @@ bayesian-differential-equations: tutorials/10-bayesian-differential-equations probabilistic-pca: tutorials/11-probabilistic-pca gplvm: tutorials/12-gplvm seasonal-time-series: tutorials/13-seasonal-time-series -contexts: tutorials/16-contexts -minituring: tutorials/14-minituring -contributing-guide: tutorials/docs-01-contributing-guide -using-turing-abstractmcmc: tutorials/docs-04-for-developers-abstractmc-turing -using-turing-compiler: tutorials/docs-05-for-developers-compiler -using-turing-interface: tutorials/docs-06-for-developers-interface -using-turing-variational-inference: tutorials/docs-07-for-developers-variational-inference using-turing-advanced: tutorials/docs-09-using-turing-advanced using-turing-autodiff: tutorials/docs-10-using-turing-autodiff using-turing-dynamichmc: tutorials/docs-11-using-turing-dynamichmc @@ -194,10 +180,18 @@ using-turing: tutorials/docs-12-using-turing-guide using-turing-performance-tips: tutorials/docs-13-using-turing-performance-tips using-turing-sampler-viz: tutorials/docs-15-using-turing-sampler-viz using-turing-external-samplers: tutorials/docs-16-using-turing-external-samplers -using-turing-implementing-samplers: tutorials/docs-17-implementing-samplers using-turing-mode-estimation: tutorials/docs-17-mode-estimation usage-probability-interface: tutorials/usage-probability-interface usage-custom-distribution: tutorials/usage-custom-distribution usage-generated-quantities: tutorials/usage-generated-quantities usage-modifying-logprob: tutorials/usage-modifying-logprob -dev-model-manual: tutorials/dev-model-manual + +contributing-guide: developers/contributing +dev-model-manual: developers/compiler/model-manual +contexts: developers/compiler/minituring-contexts +minituring: developers/compiler/minituring-compiler +using-turing-compiler: developers/compiler/design-overview +using-turing-abstractmcmc: developers/inference/abstractmcmc-turing +using-turing-interface: developers/inference/abstractmcmc-interface +using-turing-variational-inference: developers/inference/variational-inference +using-turing-implementing-samplers: developers/inference/implementing-samplers diff --git a/tutorials/docs-05-for-developers-compiler/index.qmd b/developers/compiler/design-overview/index.qmd similarity index 97% rename from tutorials/docs-05-for-developers-compiler/index.qmd rename to developers/compiler/design-overview/index.qmd index 20013d92c..3645422e7 100755 --- a/tutorials/docs-05-for-developers-compiler/index.qmd +++ b/developers/compiler/design-overview/index.qmd @@ -1,6 +1,8 @@ --- -title: Turing Compiler Design +title: Turing Compiler Design (Outdated) engine: julia +aliases: + - ../../../tutorials/docs-05-for-developers-compiler/index.html --- ```{julia} diff --git a/tutorials/14-minituring/index.qmd b/developers/compiler/minituring-compiler/index.qmd similarity index 96% rename from tutorials/14-minituring/index.qmd rename to developers/compiler/minituring-compiler/index.qmd index 49ab6bcad..605698694 100755 --- a/tutorials/14-minituring/index.qmd +++ b/developers/compiler/minituring-compiler/index.qmd @@ -1,6 +1,8 @@ --- title: "A Mini Turing Implementation I: Compiler" engine: julia +aliases: + - ../../../tutorials/14-minituring/index.html --- ```{julia} diff --git a/tutorials/16-contexts/index.qmd b/developers/compiler/minituring-contexts/index.qmd similarity index 97% rename from tutorials/16-contexts/index.qmd rename to developers/compiler/minituring-contexts/index.qmd index 01430f241..cbad94380 100755 --- a/tutorials/16-contexts/index.qmd +++ b/developers/compiler/minituring-contexts/index.qmd @@ -1,6 +1,8 @@ --- title: "A Mini Turing Implementation II: Contexts" engine: julia +aliases: + - ../../../tutorials/16-contexts/index.html --- ```{julia} diff --git a/tutorials/dev-model-manual/index.qmd b/developers/compiler/model-manual/index.qmd similarity index 96% rename from tutorials/dev-model-manual/index.qmd rename to developers/compiler/model-manual/index.qmd index bc4205695..24cb77365 100755 --- a/tutorials/dev-model-manual/index.qmd +++ b/developers/compiler/model-manual/index.qmd @@ -1,6 +1,8 @@ --- title: Manually Defining a Model engine: julia +aliases: + - ../../../tutorials/dev-model-manual/index.html --- Traditionally, models in Turing are defined using the `@model` macro: diff --git a/tutorials/docs-01-contributing-guide/index.qmd b/developers/contributing/index.qmd similarity index 97% rename from tutorials/docs-01-contributing-guide/index.qmd rename to developers/contributing/index.qmd index 78d240708..e2e5b12aa 100755 --- a/tutorials/docs-01-contributing-guide/index.qmd +++ b/developers/contributing/index.qmd @@ -1,5 +1,7 @@ --- title: Contributing +aliases: + - ../../tutorials/docs-01-contributing-guide/index.html --- Turing is an open-source project and is [hosted on GitHub](https://github.com/TuringLang). diff --git a/tutorials/docs-06-for-developers-interface/index.qmd b/developers/inference/abstractmcmc-interface/index.qmd similarity index 97% rename from tutorials/docs-06-for-developers-interface/index.qmd rename to developers/inference/abstractmcmc-interface/index.qmd index 1aba48670..aa8cfc210 100755 --- a/tutorials/docs-06-for-developers-interface/index.qmd +++ b/developers/inference/abstractmcmc-interface/index.qmd @@ -1,6 +1,8 @@ --- title: Interface Guide engine: julia +aliases: + - ../../tutorials/docs-06-for-developers-interface/index.html --- ```{julia} @@ -318,4 +320,4 @@ It looks like we're extremely close to our true parameters of `Normal(5,3)`, tho ## Conclusion -We've seen how to implement the sampling interface for general projects. Turing's interface methods are ever-evolving, so please open an issue at [AbstractMCMC](https://github.com/TuringLang/AbstractMCMC.jl) with feature requests or problems. \ No newline at end of file +We've seen how to implement the sampling interface for general projects. Turing's interface methods are ever-evolving, so please open an issue at [AbstractMCMC](https://github.com/TuringLang/AbstractMCMC.jl) with feature requests or problems. diff --git a/tutorials/docs-04-for-developers-abstractmcmc-turing/index.qmd b/developers/inference/abstractmcmc-turing/index.qmd similarity index 97% rename from tutorials/docs-04-for-developers-abstractmcmc-turing/index.qmd rename to developers/inference/abstractmcmc-turing/index.qmd index b0723c5f2..bf1bd1489 100755 --- a/tutorials/docs-04-for-developers-abstractmcmc-turing/index.qmd +++ b/developers/inference/abstractmcmc-turing/index.qmd @@ -1,6 +1,8 @@ --- -title: How Turing implements AbstractMCMC +title: How Turing Implements AbstractMCMC engine: julia +aliases: + - ../../tutorials/docs-04-for-developers-abstractmcmc-turing/index.html --- ```{julia} diff --git a/tutorials/docs-17-implementing-samplers/index.qmd b/developers/inference/implementing-samplers/index.qmd similarity index 99% rename from tutorials/docs-17-implementing-samplers/index.qmd rename to developers/inference/implementing-samplers/index.qmd index 5c3aee618..9d69fbb80 100644 --- a/tutorials/docs-17-implementing-samplers/index.qmd +++ b/developers/inference/implementing-samplers/index.qmd @@ -1,8 +1,10 @@ --- -title: Implementing samplers +title: Implementing Samplers engine: julia julia: exeflags: ["--project=@.", "-t 4"] +aliases: + - ../../tutorials/docs-17-implementing-samplers/index.html --- ```{julia} diff --git a/tutorials/docs-07-for-developers-variational-inference/index.qmd b/developers/inference/variational-inference/index.qmd similarity index 97% rename from tutorials/docs-07-for-developers-variational-inference/index.qmd rename to developers/inference/variational-inference/index.qmd index 332e7c6ed..d424b5ecc 100755 --- a/tutorials/docs-07-for-developers-variational-inference/index.qmd +++ b/developers/inference/variational-inference/index.qmd @@ -1,6 +1,8 @@ --- title: Variational Inference engine: julia +aliases: + - ../../tutorials/docs-07-for-developers-variational-inference/index.html --- # Overview