Skip to content

Commit 1d036a1

Browse files
penelopeysmpenelopeysm
committed
Fix things like predict on docs API page
1 parent 433c36d commit 1d036a1

File tree

3 files changed

+20
-16
lines changed

3 files changed

+20
-16
lines changed

‎docs/Project.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
[deps]
2+
AbstractPPL = "7a57a42e-76ec-4ea3-a279-07e840d6d9cf"
23
Bijectors = "76274a88-744f-5084-9051-94815aaf08c4"
34
Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
45
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
56
DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
67
DynamicPPL = "366bfd00-2699-11ea-058f-f148b4cae6d8"
8+
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
79
Turing = "fce5fe82-541a-59a6-adf8-730c64b5f9a0"

‎docs/make.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@ using Turing
55
using Distributions
66
using Bijectors
77
using DynamicPPL
8+
using LinearAlgebra
89

910
using DocumenterInterLinks
1011

1112
links = InterLinks(
1213
"DynamicPPL" => "https://turinglang.org/DynamicPPL.jl/stable/objects.inv",
14+
"AbstractPPL" => "https://turinglang.org/AbstractPPL.jl/stable/objects.inv",
15+
"LinearAlgebra" => "https://docs.julialang.org/en/v1/objects.inv",
1316
"AbstractMCMC" => "https://turinglang.org/AbstractMCMC.jl/stable/objects.inv",
14-
"AbstractPPL" => "https://turinglang.org/AbstractPPL.jl/dev/objects.inv",
1517
"ADTypes" => "https://sciml.github.io/ADTypes.jl/stable/objects.inv",
1618
"AdvancedVI" => "https://turinglang.org/AdvancedVI.jl/v0.2.8/objects.inv",
1719
"DistributionsAD" => "https://turinglang.org/DistributionsAD.jl/stable/objects.inv",

‎docs/src/api.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -123,26 +123,26 @@ LogPoisson
123123

124124
### Predictions
125125

126-
```@docs
127-
DynamicPPL.predict
128-
```
126+
| Exported symbol | Documentation | Description |
127+
|:---------------- |:----------------------------- |:---------------------------------------- |
128+
| `predict` | [`StatsAPI.predict`](https://turinglang.org/DynamicPPL.jl/stable/api/#Predicting) | Generate samples from posterior predictive distribution |
129129

130130
### Querying model probabilities and quantities
131131

132132
Please see the [generated quantities](https://turinglang.org/docs/tutorials/usage-generated-quantities/) and [probability interface](https://turinglang.org/docs/tutorials/usage-probability-interface/) guides for more information.
133133

134-
| Exported symbol | Documentation | Description |
135-
|:-------------------------- |:--------------------------------------------------------------------------------------------------------------------------------- |:-------------------------------------------------- |
136-
| `returned` | [`DynamicPPL.returned`](@extref) | Calculate additional quantities defined in a model |
137-
| `pointwise_loglikelihoods` | [`DynamicPPL.pointwise_loglikelihoods`](@extref) | Compute log likelihoods for each sample in a chain |
138-
| `logprior` | [`DynamicPPL.logprior`](@extref) | Compute log prior probability |
139-
| `logjoint` | [`DynamicPPL.logjoint`](@extref) | Compute log joint probability |
140-
| `condition` | [`AbstractPPL.condition`](@extref) | Condition a model on data |
141-
| `decondition` | [`AbstractPPL.decondition`](@extref) | Remove conditioning on data |
142-
| `conditioned` | [`DynamicPPL.conditioned`](@extref) | Return the conditioned values of a model |
143-
| `fix` | [`DynamicPPL.fix`](@extref) | Fix the value of a variable |
144-
| `unfix` | [`DynamicPPL.unfix`](@extref) | Unfix the value of a variable |
145-
| `OrderedDict` | [`OrderedCollections.OrderedDict`](https://juliacollections.github.io/OrderedCollections.jl/dev/ordered_containers/#OrderedDicts) | An ordered dictionary |
134+
| Exported symbol | Documentation | Description |
135+
|:--------------------------- |:---------------------------------------------------------------------------------------------------------------------------------- |:--------------------------------------------------- |
136+
| `returned` | [`DynamicPPL.returned`](https://turinglang.org/DynamicPPL.jl/stable/api/#DynamicPPL.returned-Tuple{Model,%20NamedTuple}) | Calculate additional quantities defined in a model |
137+
| `pointwise_loglikelihoods` | [`DynamicPPL.pointwise_loglikelihoods`](@extref) | Compute log likelihoods for each sample in a chain |
138+
| `logprior` | [`DynamicPPL.logprior`](@extref) | Compute log prior probability |
139+
| `logjoint` | [`DynamicPPL.logjoint`](@extref) | Compute log joint probability |
140+
| `condition` | [`AbstractPPL.condition`](@extref) | Condition a model on data |
141+
| `decondition` | [`AbstractPPL.decondition`](@extref) | Remove conditioning on data |
142+
| `conditioned` | [`DynamicPPL.conditioned`](@extref) | Return the conditioned values of a model |
143+
| `fix` | [`DynamicPPL.fix`](@extref) | Fix the value of a variable |
144+
| `unfix` | [`DynamicPPL.unfix`](@extref) | Unfix the value of a variable |
145+
| `OrderedDict` | [`OrderedCollections.OrderedDict`](https://juliacollections.github.io/OrderedCollections.jl/dev/ordered_containers/#OrderedDicts) | An ordered dictionary |
146146

147147
### Point estimates
148148

0 commit comments

Comments
 (0)