Skip to content

Add fields to docstring for AD test utils #914

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 9, 2025
Merged

Add fields to docstring for AD test utils #914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a12aaf
Add fields to docstring for AD test utils
penelopeysm May 9, 2025
85949ef
Bump patch
penelopeysm May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "DynamicPPL"
uuid = "366bfd00-2699-11ea-058f-f148b4cae6d8"
version = "0.36.1"
version = "0.36.2"

[deps]
ADTypes = "47edcb42-4c32-4615-8424-f2b9edc5f35b"
Expand Down
6 changes: 6 additions & 0 deletions src/test_utils/ad.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ const REFERENCE_ADTYPE = AutoForwardDiff()
Exception thrown when an AD backend returns an incorrect value or gradient.

The type parameter `T` is the numeric type of the value and gradient.

# Fields
$(TYPEDFIELDS)
"""
struct ADIncorrectException{T<:AbstractFloat} <: Exception
value_expected::T
Expand All @@ -41,6 +44,9 @@ Data structure to store the results of the AD correctness test.

The type parameter `Tparams` is the numeric type of the parameters passed in;
`Tresult` is the type of the value and the gradient.

# Fields
$(TYPEDFIELDS)
"""
struct ADResult{Tparams<:AbstractFloat,Tresult<:AbstractFloat}
"The DynamicPPL model that was tested"
Expand Down
Loading