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.

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

Conversation

penelopeysm
Copy link
Member

@penelopeysm penelopeysm commented May 9, 2025

The docstrings don't list the fields of the return types. This fixes it.

Needs a patch bump so that the 'stable' version of the docs has this info.

Copy link
Contributor

github-actions bot commented May 9, 2025

Benchmark Report for Commit 85949ef

Computer Information

Julia Version 1.11.5
Commit 760b2e5b739 (2025-04-14 06:53 UTC)
Build Info:
  Official https://julialang.org/ release
Platform Info:
  OS: Linux (x86_64-linux-gnu)
  CPU: 4 × AMD EPYC 7763 64-Core Processor
  WORD_SIZE: 64
  LLVM: libLLVM-16.0.6 (ORCJIT, znver3)
Threads: 1 default, 0 interactive, 1 GC (on 4 virtual cores)

Benchmark Results

|                 Model | Dimension |  AD Backend |      VarInfo Type | Linked | Eval Time / Ref Time | AD Time / Eval Time |
|-----------------------|-----------|-------------|-------------------|--------|----------------------|---------------------|
| Simple assume observe |         1 | forwarddiff |             typed |  false |                  9.5 |                 1.6 |
|           Smorgasbord |       201 | forwarddiff |             typed |  false |                723.6 |                33.8 |
|           Smorgasbord |       201 | forwarddiff | simple_namedtuple |   true |                420.9 |                44.7 |
|           Smorgasbord |       201 | forwarddiff |           untyped |   true |               1217.5 |                27.3 |
|           Smorgasbord |       201 | forwarddiff |       simple_dict |   true |               3734.9 |                22.0 |
|           Smorgasbord |       201 | reversediff |             typed |   true |               1435.6 |                30.4 |
|           Smorgasbord |       201 |    mooncake |             typed |   true |                941.7 |                 5.3 |
|    Loop univariate 1k |      1000 |    mooncake |             typed |   true |               5444.6 |                 4.1 |
|       Multivariate 1k |      1000 |    mooncake |             typed |   true |               1048.5 |                 8.5 |
|   Loop univariate 10k |     10000 |    mooncake |             typed |   true |              61198.0 |                 3.9 |
|      Multivariate 10k |     10000 |    mooncake |             typed |   true |               8858.4 |                 9.8 |
|               Dynamic |        10 |    mooncake |             typed |   true |                129.3 |                13.6 |
|              Submodel |         1 |    mooncake |             typed |   true |                 13.7 |                 6.6 |
|                   LDA |        12 | reversediff |             typed |   true |                466.5 |                 6.1 |

@penelopeysm
Copy link
Member Author

Boring patch so just going to merge

@penelopeysm penelopeysm merged commit 43a9558 into main May 9, 2025
4 of 16 checks passed
@penelopeysm penelopeysm deleted the py/docstrings branch May 9, 2025 18:11
Copy link

codecov bot commented May 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.01%. Comparing base (a134ecc) to head (85949ef).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #914   +/-   ##
=======================================
  Coverage   85.01%   85.01%           
=======================================
  Files          35       35           
  Lines        3924     3924           
=======================================
  Hits         3336     3336           
  Misses        588      588           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 14934892786

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-4.3%) to 80.843%

Totals Coverage Status
Change from base Build 14888352833: -4.3%
Covered Lines: 3165
Relevant Lines: 3915

💛 - Coveralls

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants