docs icon indicating copy to clipboard operation
docs copied to clipboard

fix usage of samples vs. draws

Open bob-carpenter opened this issue 1 year ago • 2 comments
trafficstars

Summary:

We should be using "sample" to mean a multi-set of draws and "draw" to indicate a single draw from a sampler. We should not be saying "take N samples" but rather "take N draws" or "sample of size N".

cf. @avehtari's comment here:

I (and Andrew) don't like num_samples. It should be either num_draws, num_total_draws, or sample_size.

Description:

I think we can use this Google search to find all potentially problematic cases:

"samples" site:mc-stan.org/docs

Warning: there are quite a few.

Current Version:

v2.18.0 [this boilerplate needs to be updated regularly---it's really 2.35]

bob-carpenter avatar Oct 18 '24 19:10 bob-carpenter

this boilerplate needs to be updated regularly---it's really 2.35

Slightly off topic, but I would be in favor of removing this entirely from the docs repo. I think it’s pretty clear that issues here mean “against the currently live site”

WardBrian avatar Oct 18 '24 19:10 WardBrian

this boilerplate needs to be updated regularly---it's really 2.35

Slightly off topic, but I would be in favor of removing this entirely from the docs repo. I think it’s pretty clear that issues here mean “against the currently live site”

Agree!

jgabry avatar Oct 18 '24 20:10 jgabry