# CmdStanPy 1.0.0rc1

**URL:** https://discourse.mc-stan.org/t/cmdstanpy-1-0-0rc1/24973
**Category:** Interfaces
**Created:** [October 24, 2021, 7:03pm UTC](https://discourse.mc-stan.org/t/cmdstanpy-1-0-0rc1/24973 "2021-10-24T19:03:38Z")
**Posts on this page:** 2
**Page:** 1

<div class="post-metadata">

### Author: ![mitzimorris](https://yyz2.discourse-cdn.com/flex030/user_avatar/discourse.mc-stan.org/mitzimorris/32/29_2.png) [@mitzimorris](https://discourse.mc-stan.org/u/mitzimorris)
#### Post date: [October 24, 2021, 7:03pm UTC](https://discourse.mc-stan.org/t/cmdstanpy-1-0-0rc1/24973/1 "2021-10-24T19:03:38Z")

</div>

The release candidate for CmdStanPy v1.0 is now available on conda-forge: [https://anaconda.org/conda-forge/cmdstanpy/1.0.0rc1/download/noarch/cmdstanpy-1.0.0rc1-pyhd036fef\_0.tar.bz2](https://anaconda.org/conda-forge/cmdstanpy/1.0.0rc1/download/noarch/cmdstanpy-1.0.0rc1-pyhd036fef_0.tar.bz2)

Please give it a try.

Notable recent changes are the addition of progress bars for both the sampler and the CmdStan install scripts.

yellow bars indicate warmup:

 ![warmup](https://canada1.discourse-cdn.com/flex030/uploads/mc_stan/original/2X/2/25dc4baa6a284e473acd1729c965f6a2c1ebe071.jpeg)

blue bars indicate sampling:

 ![sampling](https://canada1.discourse-cdn.com/flex030/uploads/mc_stan/original/2X/8/8b2d58be13bd5ed7d0cb86637bb7626963254f36.jpeg)

This should work in both terminal windows and in Jupyter notebooks. For Jupyter notebooks, the [tqdm](https://github.com/tqdm/tqdm) package uses the [ipywidgets](https://ipywidgets.readthedocs.io/en/latest/index.html) package in order to update the browser display. Therefore you must have [ipywidgets installed](https://ipywidgets.readthedocs.io/en/latest/user_install.html#). If you have problems, see [this tqdm GitHub issue](https://github.com/tqdm/tqdm/issues/394#issuecomment-384743637).

All methods which can display progress bars have arguments `show_progress` and `show_console`.

For the `sample` method, `show_progress=True` and `show_console=False`. To suppress both, you must explicitly specify `show_progress=False`. For debugging purposes, `show_console=True` will turn off the progress bars and instead stream all CmdStan messages written to `stdout` and `stderr` to the console.

---

<div class="post-metadata">

### Author: ![mitzimorris](https://yyz2.discourse-cdn.com/flex030/user_avatar/discourse.mc-stan.org/mitzimorris/32/29_2.png) [@mitzimorris](https://discourse.mc-stan.org/u/mitzimorris)
#### Post date: [October 25, 2021, 5:59pm UTC](https://discourse.mc-stan.org/t/cmdstanpy-1-0-0rc1/24973/2 "2021-10-25T17:59:05Z")

</div>

oops, I [buried the lede](https://en.wiktionary.org/wiki/bury_the_lede) - **Deprecations Removed in Version 1.0.0**

If you’ve got scripts, notebooks, or packages which use CmdStanPy, version 1.0 has removed the following deprecated properties, methods, method arguments, and package behaviors.

- The default CmdStan install directory is `$HOME/.cmdstan`; CmdStanPy will no longer look for installations in directory `$HOME/.cmdstanpy`.

- The argument `logger` deprecated for all CmdStanPy constructor methods.

Changes to classes CmdStanMCMC, CmdStanMLE, CmdStanVB, and CmdStanGQ.

- method `stan_variable`, argument `name` changed to `var`.

Class CmdStanMCMC changes:

- property `sampler_vars_cols` replaced by property `metdata.method_vars_cols`

- property `stan_vars_cols` replaced by property `metadata.stan_vars_cols`

- property `stan_vars_cols` replaced by property `metadata.stan_vars_dims`

- property `sample` replaced by method `draws()`

- property `warmup` replaced by method `draws(inc_warmup=True)`, which returns draws for both warmup and sampling iterations.

- method `draws_pd` argument `params` changed to `vars`

- methods `sampler_diagnostics` and `sampler_variables` (same method, successive name) have been replaced by the more general name `method_variables` (see below). This method retrieves the sampler variables `lp__`, et al. The set of these variables varies by inference method.

Class CmdStanGQ changes:

- properties `generated_quantities` and `generated_quantities_pd` replaced by methods `draws()` and `draws_pd()`, respectively.

- properties `sample_plus_quantities` and `sample_plus_quantities_pd` replaced by methods `draws(inc_sample=True)` and `draws_pd(inc_sample=True)`, respectively.

The goal of these changes is to make the API as uniform as possible for all inference result objects as follows:

- The CmdStan configuration and Stan CSV file header comments and column headers information is assembled as a `InferenceMetadata` object with properties:

- All inference result objects have accessor methods `method_variables`, `stan_variable`, and `stan_variables` to retrieve method and Stan program variables. Stan program variables are returned as structured objects. If the inference method returns a sample, then `stan_variable` will return an array of structured objects. If the inference method returns a single estimate, then the `stan_variable` method returns a single structured object.

- All methods which return a sample have method `draws`, `draws_pd` which returns data rows from the Stan CSV file as a numpy.ndarray and pandas.DataFrame, respectively.

- All methods which return a sample have method `draws_xr` which which returns one or more named variables as an xarray Dataset.
