-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add minimal documentation for v0.2 (#105)
* Add barebones documentation * Don't check exports
- Loading branch information
1 parent
e4c4c21
commit e79e370
Showing
4 changed files
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
[deps] | ||
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
using Documenter | ||
using AdvancedVI | ||
|
||
# Doctest setup | ||
DocMeta.setdocmeta!(AdvancedVI, :DocTestSetup, :(using AdvancedVI); recursive=true) | ||
|
||
makedocs(; | ||
sitename="AdvancedVI", | ||
pages=[ | ||
"Home" => "index.md", | ||
"API" => "api.md", | ||
], | ||
doctest=false, | ||
) | ||
|
||
deploydocs(; repo="github.com/TuringLang/AdvancedVI.jl.git", push_preview=true) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
## API | ||
|
||
```@docs | ||
vi | ||
ADVI | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# AdvancedVI | ||
|
||
[AdvancedVI](https://github.com/TuringLang/AdvancedVI.jl) provides implementations of variational Bayesian inference (VI) algorithms. | ||
VI algorithms perform scalable and computationally efficient Bayesian inference at the cost of asymptotic exactness. | ||
`AdvancedVI` is part of the [Turing](https://turinglang.org/) probabilistic programming ecosystem. |