Skip to content

Commit b55d607

Browse files
AoifeHughesAoifeHughespenelopeysmCopilotmhauru
authored
Add FAQ section to improve user guidance (#608)
* Add FAQ section to improve user guidance * Update faq/index.qmd Co-authored-by: Penelope Yong <[email protected]> * Update faq/index.qmd Co-authored-by: Copilot <[email protected]> * Update faq/index.qmd Co-authored-by: Penelope Yong <[email protected]> * Enhance FAQ section with detailed explanations on conditioning in Turing.jl models and parallelism usage * formatter wanted to fix this * Update faq/index.qmd Co-authored-by: Penelope Yong <[email protected]> * Update faq/index.qmd Co-authored-by: Penelope Yong <[email protected]> * Update faq/index.qmd Co-authored-by: Penelope Yong <[email protected]> * Update faq/index.qmd Co-authored-by: Penelope Yong <[email protected]> * Update faq/index.qmd Co-authored-by: Penelope Yong <[email protected]> * tweaked to Penny's suggestion * updated the manifest thingy * Update Manifest.toml * Update faq/index.qmd Co-authored-by: Penelope Yong <[email protected]> * mfest * Update FAQ to include BUGS in syntax comparison with Turing and Stan * Update faq/index.qmd --------- Co-authored-by: AoifeHughes <[email protected]> Co-authored-by: Penelope Yong <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: Markus Hauru <[email protected]>
1 parent 69e5005 commit b55d607

File tree

4 files changed

+247
-22
lines changed

4 files changed

+247
-22
lines changed

‎.github/workflows/version_check.jl

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Set up a temporary environment just to run this script
22
using Pkg
3-
Pkg.activate(temp=true)
3+
Pkg.activate(temp = true)
44
Pkg.add(["YAML", "TOML", "JSON", "HTTP"])
55
import YAML
66
import TOML
@@ -18,7 +18,10 @@ end
1818

1919
function major_minor_patch_match(vs...)
2020
first = vs[1]
21-
all(v.:major == first.:major && v.:minor == first.:minor && v.:patch == first.:patch for v in vs)
21+
all(
22+
v.:major == first.:major && v.:minor == first.:minor && v.:patch == first.:patch for
23+
v in vs
24+
)
2225
end
2326

2427
"""
@@ -34,7 +37,10 @@ function update_project_toml(filename, target_version::VersionNumber)
3437
open(filename, "w") do io
3538
for line in lines
3639
if occursin(r"^Turing\s*=\s*\"\d+\.\d+\"\s*$", line)
37-
println(io, "Turing = \"$(target_version.:major).$(target_version.:minor)\"")
40+
println(
41+
io,
42+
"Turing = \"$(target_version.:major).$(target_version.:minor)\"",
43+
)
3844
else
3945
println(io, line)
4046
end
@@ -54,7 +60,10 @@ function update_quarto_yml(filename, target_version::VersionNumber)
5460
for line in lines
5561
m = match(r"^(\s+)- text:\s*\"v\d+\.\d+\"\s*$", line)
5662
if m !== nothing
57-
println(io, "$(m[1])- text: \"v$(target_version.:major).$(target_version.:minor)\"")
63+
println(
64+
io,
65+
"$(m[1])- text: \"v$(target_version.:major).$(target_version.:minor)\"",
66+
)
5867
else
5968
println(io, line)
6069
end
@@ -108,7 +117,7 @@ if ENV["TARGET_IS_MAIN"] == "true"
108117
old_env = Pkg.project().path
109118
Pkg.activate(".")
110119
try
111-
Pkg.add(name="Turing", version=latest_version)
120+
Pkg.add(name = "Turing", version = latest_version)
112121
catch e
113122
# If the Manifest couldn't be updated, the error will be shown later
114123
println(e)
@@ -118,14 +127,20 @@ if ENV["TARGET_IS_MAIN"] == "true"
118127
manifest_toml = TOML.parsefile(MANIFEST_TOML_PATH)
119128
manifest_version = VersionNumber(manifest_toml["deps"]["Turing"][1]["version"])
120129
if !major_minor_patch_match(latest_version, manifest_version)
121-
push!(errors, "Failed to update $(MANIFEST_TOML_PATH) to match latest Turing.jl version")
130+
push!(
131+
errors,
132+
"Failed to update $(MANIFEST_TOML_PATH) to match latest Turing.jl version",
133+
)
122134
end
123135
end
124136

125137
if isempty(errors)
126138
println("All good")
127139
else
128-
error("The following errors occurred during version checking: \n", join(errors, "\n"))
140+
error(
141+
"The following errors occurred during version checking: \n",
142+
join(errors, "\n"),
143+
)
129144
end
130145

131146
else
@@ -135,10 +150,12 @@ else
135150
# work as it would involve paging through the list of releases). Instead,
136151
# we just check that the minor versions match.
137152
if !major_minor_match(quarto_version, project_version, manifest_version)
138-
error("The minor versions of Turing.jl in _quarto.yml, Project.toml, and Manifest.toml are inconsistent:
139-
- _quarto.yml: $quarto_version_str
140-
- Project.toml: $project_version_str
141-
- Manifest.toml: $manifest_version
142-
")
153+
error(
154+
"The minor versions of Turing.jl in _quarto.yml, Project.toml, and Manifest.toml are inconsistent:
155+
- _quarto.yml: $quarto_version_str
156+
- Project.toml: $project_version_str
157+
- Manifest.toml: $manifest_version
158+
",
159+
)
143160
end
144161
end

‎Manifest.toml

Lines changed: 76 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
julia_version = "1.11.6"
44
manifest_format = "2.0"
5-
project_hash = "2db94c909342da49eb3ff313436b75e25977ace6"
5+
project_hash = "296b7e06e398e8898b40f44ed92b4d60c484484c"
66

77
[[deps.ADTypes]]
88
git-tree-sha1 = "60665b326b75db6517939d0e1875850bc4a54368"
@@ -685,9 +685,9 @@ version = "0.1.2"
685685

686686
[[deps.DelayDiffEq]]
687687
deps = ["ArrayInterface", "DataStructures", "DiffEqBase", "FastBroadcast", "ForwardDiff", "LinearAlgebra", "Logging", "OrdinaryDiffEq", "OrdinaryDiffEqCore", "OrdinaryDiffEqDefault", "OrdinaryDiffEqDifferentiation", "OrdinaryDiffEqFunctionMap", "OrdinaryDiffEqNonlinearSolve", "OrdinaryDiffEqRosenbrock", "Printf", "RecursiveArrayTools", "Reexport", "SciMLBase", "SimpleNonlinearSolve", "SimpleUnPack", "SymbolicIndexingInterface"]
688-
git-tree-sha1 = "c50981fb5b6441a1213debb1423385a462e88032"
688+
git-tree-sha1 = "d9b1e66070ce15bc2b9c3d5af6b94f693fc03ba4"
689689
uuid = "bcd4f6db-9728-5f36-b5f7-82caef46ccdb"
690-
version = "5.56.0"
690+
version = "5.58.0"
691691

692692
[[deps.DelimitedFiles]]
693693
deps = ["Mmap"]
@@ -1180,9 +1180,9 @@ version = "1.3.7"
11801180

11811181
[[deps.ForwardDiff]]
11821182
deps = ["CommonSubexpressions", "DiffResults", "DiffRules", "LinearAlgebra", "LogExpFunctions", "NaNMath", "Preferences", "Printf", "Random", "SpecialFunctions"]
1183-
git-tree-sha1 = "910febccb28d493032495b7009dce7d7f7aee554"
1183+
git-tree-sha1 = "a2df1b776752e3f344e5116c06d75a10436ab853"
11841184
uuid = "f6369f11-7733-5829-9624-2563aa707210"
1185-
version = "1.0.1"
1185+
version = "0.10.38"
11861186
weakdeps = ["StaticArrays"]
11871187

11881188
[deps.ForwardDiff.extensions]
@@ -1299,6 +1299,24 @@ git-tree-sha1 = "53bb909d1151e57e2484c3d1b53e19552b887fb2"
12991299
uuid = "42e2da0e-8278-4e71-bc24-59509adca0fe"
13001300
version = "1.0.2"
13011301

1302+
[[deps.HDF5]]
1303+
deps = ["Compat", "HDF5_jll", "Libdl", "MPIPreferences", "Mmap", "Preferences", "Printf", "Random", "Requires", "UUIDs"]
1304+
git-tree-sha1 = "e856eef26cf5bf2b0f95f8f4fc37553c72c8641c"
1305+
uuid = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f"
1306+
version = "0.17.2"
1307+
1308+
[deps.HDF5.extensions]
1309+
MPIExt = "MPI"
1310+
1311+
[deps.HDF5.weakdeps]
1312+
MPI = "da04e1cc-30fd-572f-bb4f-1f8673147195"
1313+
1314+
[[deps.HDF5_jll]]
1315+
deps = ["Artifacts", "CompilerSupportLibraries_jll", "JLLWrappers", "LazyArtifacts", "LibCURL_jll", "Libdl", "MPICH_jll", "MPIPreferences", "MPItrampoline_jll", "MicrosoftMPI_jll", "OpenMPI_jll", "OpenSSL_jll", "TOML", "Zlib_jll", "libaec_jll"]
1316+
git-tree-sha1 = "e94f84da9af7ce9c6be049e9067e511e17ff89ec"
1317+
uuid = "0234f1f7-429e-5d53-9886-15a909be8d59"
1318+
version = "1.14.6+0"
1319+
13021320
[[deps.HTTP]]
13031321
deps = ["Base64", "CodecZlib", "ConcurrentUtilities", "Dates", "ExceptionUnwrapping", "Logging", "LoggingExtras", "MbedTLS", "NetworkOptions", "OpenSSL", "PrecompileTools", "Random", "SimpleBufferStream", "Sockets", "URIs", "UUIDs"]
13041322
git-tree-sha1 = "ed5e9c58612c4e081aecdb6e1a479e18462e041e"
@@ -1326,6 +1344,12 @@ weakdeps = ["Distributions"]
13261344
[deps.HiddenMarkovModels.extensions]
13271345
HiddenMarkovModelsDistributionsExt = "Distributions"
13281346

1347+
[[deps.Hwloc_jll]]
1348+
deps = ["Artifacts", "JLLWrappers", "Libdl"]
1349+
git-tree-sha1 = "92f65c4d78ce8cdbb6b68daf88889950b0a99d11"
1350+
uuid = "e33a78d0-f292-5ffc-b300-72abe9b543c8"
1351+
version = "2.12.1+0"
1352+
13291353
[[deps.HypergeometricFunctions]]
13301354
deps = ["LinearAlgebra", "OpenLibm_jll", "SpecialFunctions"]
13311355
git-tree-sha1 = "68c173f4f449de5b438ee67ed0c9c748dc31a2ec"
@@ -1454,9 +1478,9 @@ version = "0.2.1"
14541478

14551479
[[deps.JpegTurbo_jll]]
14561480
deps = ["Artifacts", "JLLWrappers", "Libdl"]
1457-
git-tree-sha1 = "e95866623950267c1e4878846f848d94810de475"
1481+
git-tree-sha1 = "eac1206917768cb54957c65a615460d87b455fc1"
14581482
uuid = "aacddb02-875f-59d6-b918-886e6ef4fbf8"
1459-
version = "3.1.2+0"
1483+
version = "3.1.1+0"
14601484

14611485
[[deps.JuliaVariables]]
14621486
deps = ["MLStyle", "NameResolution"]
@@ -1945,10 +1969,10 @@ version = "1.10.2"
19451969
cuDNN = "02a925ec-e4fe-4b08-9a7e-0d78e3d38ccd"
19461970

19471971
[[deps.MCMCChains]]
1948-
deps = ["AbstractMCMC", "AxisArrays", "DataAPI", "Dates", "Distributions", "IteratorInterfaceExtensions", "KernelDensity", "LinearAlgebra", "MCMCDiagnosticTools", "MLJModelInterface", "NaturalSort", "OrderedCollections", "PrettyTables", "Random", "RecipesBase", "Statistics", "StatsBase", "StatsFuns", "TableTraits", "Tables"]
1949-
git-tree-sha1 = "f3993c723865f670102011ef22811e2bbb0ef1a8"
1972+
deps = ["AbstractMCMC", "AxisArrays", "Dates", "Distributions", "IteratorInterfaceExtensions", "KernelDensity", "LinearAlgebra", "MCMCDiagnosticTools", "MLJModelInterface", "NaturalSort", "OrderedCollections", "PrettyTables", "Random", "RecipesBase", "Statistics", "StatsBase", "StatsFuns", "TableTraits", "Tables"]
1973+
git-tree-sha1 = "cd7aee22384792c726e19f2a22dc060b886edded"
19501974
uuid = "c7f686f2-ff18-58e9-bc7b-31028e88f75d"
1951-
version = "7.2.0"
1975+
version = "6.0.7"
19521976

19531977
[[deps.MCMCDiagnosticTools]]
19541978
deps = ["AbstractFFTs", "DataAPI", "DataStructures", "Distributions", "LinearAlgebra", "MLJModelInterface", "Random", "SpecialFunctions", "Statistics", "StatsBase", "StatsFuns", "Tables"]
@@ -2049,6 +2073,24 @@ git-tree-sha1 = "a772d8d1987433538a5c226f79393324b55f7846"
20492073
uuid = "f1d291b0-491e-4a28-83b9-f70985020b54"
20502074
version = "0.4.8"
20512075

2076+
[[deps.MPICH_jll]]
2077+
deps = ["Artifacts", "CompilerSupportLibraries_jll", "Hwloc_jll", "JLLWrappers", "LazyArtifacts", "Libdl", "MPIPreferences", "TOML"]
2078+
git-tree-sha1 = "d72d0ecc3f76998aac04e446547259b9ae4c265f"
2079+
uuid = "7cb0a576-ebde-5e09-9194-50597f1243b4"
2080+
version = "4.3.1+0"
2081+
2082+
[[deps.MPIPreferences]]
2083+
deps = ["Libdl", "Preferences"]
2084+
git-tree-sha1 = "c105fe467859e7f6e9a852cb15cb4301126fac07"
2085+
uuid = "3da0fdf6-3ccc-4f1b-acd9-58baa6c99267"
2086+
version = "0.1.11"
2087+
2088+
[[deps.MPItrampoline_jll]]
2089+
deps = ["Artifacts", "CompilerSupportLibraries_jll", "JLLWrappers", "LazyArtifacts", "Libdl", "MPIPreferences", "TOML"]
2090+
git-tree-sha1 = "e214f2a20bdd64c04cd3e4ff62d3c9be7e969a59"
2091+
uuid = "f1f71cc9-e9ae-5b93-9b94-4fe0e1ad3748"
2092+
version = "5.5.4+0"
2093+
20522094
[[deps.MacroTools]]
20532095
git-tree-sha1 = "1e0228a030642014fe5cfe68c2c0a818f9e3f522"
20542096
uuid = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
@@ -2111,12 +2153,24 @@ git-tree-sha1 = "7dbf904fa6c4447bd1f1d316886bfbe29feacf45"
21112153
uuid = "6fafb56a-5788-4b4e-91ca-c0cea6611c73"
21122154
version = "0.2.2"
21132155

2156+
[[deps.MicroCanonicalHMC]]
2157+
deps = ["AbstractMCMC", "Adapt", "Distributions", "ForwardDiff", "HDF5", "LinearAlgebra", "LogDensityProblems", "LogDensityProblemsAD", "MCMCChains", "MCMCDiagnosticTools", "Markdown", "ProgressMeter", "Random", "Statistics"]
2158+
git-tree-sha1 = "99fd367f8b8fc9d479420d33e8f16f3dab3162f4"
2159+
uuid = "234d2aa0-2291-45f7-9047-6fa6f316b0a8"
2160+
version = "0.1.6"
2161+
21142162
[[deps.MicroCollections]]
21152163
deps = ["Accessors", "BangBang", "InitialValues"]
21162164
git-tree-sha1 = "44d32db644e84c75dab479f1bc15ee76a1a3618f"
21172165
uuid = "128add7d-3638-4c79-886c-908ea0c25c34"
21182166
version = "0.2.0"
21192167

2168+
[[deps.MicrosoftMPI_jll]]
2169+
deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"]
2170+
git-tree-sha1 = "bc95bf4149bf535c09602e3acdf950d9b4376227"
2171+
uuid = "9237b28f-5490-5468-be7b-bb81f5f5e6cf"
2172+
version = "10.1.4+3"
2173+
21202174
[[deps.Missings]]
21212175
deps = ["DataAPI"]
21222176
git-tree-sha1 = "ec4f7fbeab05d7747bdf98eb74d130a2a2ed298d"
@@ -2392,6 +2446,12 @@ deps = ["Artifacts", "Libdl"]
23922446
uuid = "05823500-19ac-5b8b-9628-191a04bc5112"
23932447
version = "0.8.5+0"
23942448

2449+
[[deps.OpenMPI_jll]]
2450+
deps = ["Artifacts", "CompilerSupportLibraries_jll", "Hwloc_jll", "JLLWrappers", "LazyArtifacts", "Libdl", "MPIPreferences", "TOML", "Zlib_jll"]
2451+
git-tree-sha1 = "ec764453819f802fc1e144bfe750c454181bd66d"
2452+
uuid = "fe0851c0-eecd-5654-98d4-656369965a5c"
2453+
version = "5.0.8+0"
2454+
23952455
[[deps.OpenSSL]]
23962456
deps = ["BitFlags", "Dates", "MozillaCACerts_jll", "OpenSSL_jll", "Sockets"]
23972457
git-tree-sha1 = "f1a7e086c677df53e064e0fdd2c9d0b0833e3f6e"
@@ -3937,6 +3997,12 @@ git-tree-sha1 = "b6a34e0e0960190ac2a4363a1bd003504772d631"
39373997
uuid = "214eeab7-80f7-51ab-84ad-2988db7cef09"
39383998
version = "0.61.1+0"
39393999

4000+
[[deps.libaec_jll]]
4001+
deps = ["Artifacts", "JLLWrappers", "Libdl"]
4002+
git-tree-sha1 = "f5733a5a9047722470b95a81e1b172383971105c"
4003+
uuid = "477f73a3-ac25-53e9-8cc3-50b2fa2566f0"
4004+
version = "1.1.3+0"
4005+
39404006
[[deps.libaom_jll]]
39414007
deps = ["Artifacts", "JLLWrappers", "Libdl"]
39424008
git-tree-sha1 = "4bba74fa59ab0755167ad24f98800fe5d727175b"

‎_quarto.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ website:
3333
href: getting-started/
3434
- text: Tutorials
3535
href: tutorials/
36+
- text: FAQ
37+
href: faq/
3638
- text: Libraries
3739
href: https://turinglang.org/library/
3840
- text: News

0 commit comments

Comments
 (0)