search

pymc-devs / pymc

Bayesian Modeling and Probabilistic Programming in Python
https://docs.pymc.io/
Other
8.53k stars 1.98k forks source link

Rename sample_prior_predictive argument from samples to draws #7173

Closed ricardoV94 closed 1 month ago

ricardoV94 commented 5 months ago

Description

sample calls it draws, and the default dim is also draw. Whenever I want to use a kwarg to specify the number of draws I am always surprised it's called samples. Does everyone agree?

If so we could rename and add a futurewarning for the old arg name.

Or make everything samples... just use the same arg name please :)

wd60622 commented 1 month ago

I agree with this and am for switching samples in sample_prior_predictive to draws. draws matches up with the xarray objects so I'm fine with that name

Willing to take this

ricardoV94 commented 1 month ago

I agree with this and am for switching samples in sample_prior_predictive to draws. draws matches up with the xarray objects so I'm fine with that name

Willing to take this

thanks 🙏