From 445101e27be3165ae35d3f6bb79f9bbc4d8c6652 Mon Sep 17 00:00:00 2001 From: Adrian Seyboldt Date: Thu, 17 Oct 2024 11:44:00 +0200 Subject: [PATCH] docs: Add documentation template --- docs/SUMMARY.md | 8 ++++++++ docs/benchmarks.md | 1 + docs/nf-adapt.md | 3 +++ docs/pymc-usage.md | 1 + docs/stan-usage.md | 3 +++ 5 files changed, 16 insertions(+) create mode 100644 docs/SUMMARY.md create mode 100644 docs/benchmarks.md create mode 100644 docs/nf-adapt.md create mode 100644 docs/pymc-usage.md create mode 100644 docs/stan-usage.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..279cdd3 --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,8 @@ +# Summary + +[Introduction](../README.md) + +- [Usage with PyMC](./pymc-usage.md) +- [Usage with Stan](./stan-usage.md) +- [Adaptation with normalizing flows](./nf-adapt.md) +- [Benchmarks](./benchmarks.md) diff --git a/docs/benchmarks.md b/docs/benchmarks.md new file mode 100644 index 0000000..680d565 --- /dev/null +++ b/docs/benchmarks.md @@ -0,0 +1 @@ +# Benchmarks diff --git a/docs/nf-adapt.md b/docs/nf-adapt.md new file mode 100644 index 0000000..d9d0325 --- /dev/null +++ b/docs/nf-adapt.md @@ -0,0 +1,3 @@ +# Adaptation with normalizing flows + +**Experimental** diff --git a/docs/pymc-usage.md b/docs/pymc-usage.md new file mode 100644 index 0000000..e66c098 --- /dev/null +++ b/docs/pymc-usage.md @@ -0,0 +1 @@ +# Usage with PyMC models diff --git a/docs/stan-usage.md b/docs/stan-usage.md new file mode 100644 index 0000000..78259ef --- /dev/null +++ b/docs/stan-usage.md @@ -0,0 +1,3 @@ +# Usage with Stan models + +foobar