Skip to content

Conversation

penelopeysm
Copy link
Member

@penelopeysm penelopeysm commented Sep 30, 2025

This should, hopefully, document a bunch of things that were not documented.

Closes #647.

Copy link
Contributor

Preview the changes: https://turinglang.org/docs/pr-previews/654
Please avoid using the search feature and navigation bar in PR previews!

@joelkandiah
Copy link

joelkandiah commented Oct 1, 2025

It may make sense to specify exactly how thinning works in a similar way to the table in Thinning and warmup. This is because the thinning only applies to steps after discard_initial. This partiallye exists already, however doesn't note the interaction with num_warmup.

This is relevant as if I specify sample(..., N = 100, ...; discard_initial = 100, thinning = 10, num_warmup = 500 ) the code should call step_warmup 500 times and then step 591 times, which makes sense but may be unintuitive for first time users (i.e. N only starts counting from after discard initial, and N-1 multiplied by thinning and counts from 1 rather than 0, but num_warmup counts from the first discard iteration).

Copy link

@joelkandiah joelkandiah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy with this page now, it has covered all of the features I believe to be regularly used.

@penelopeysm
Copy link
Member Author

Thanks Joel!

@penelopeysm penelopeysm merged commit 0745672 into main Oct 2, 2025
2 checks passed
@penelopeysm penelopeysm deleted the py/sample branch October 2, 2025 09:53
github-actions bot added a commit that referenced this pull request Oct 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants