Skip to main content

Python interface to CmdStan

Project description

CmdStanPy

codecov

CmdStanPy is a lightweight interface to Stan for Python users which provides the necessary objects and functions to do Bayesian inference given a probability model written as a Stan program and data. Under the hood, CmdStanPy uses the CmdStan command line interface to compile and run a Stan program.

Goals

  • Clean interface to Stan services so that CmdStanPy can keep up with Stan releases.

  • Provide access to all CmdStan inference methods.

  • Easy to install,

    • minimal Python library dependencies: numpy, pandas
    • Python code doesn't interface directly with c++, only calls compiled executables
  • Modular - CmdStanPy produces a MCMC sample (or point estimate) from the posterior; other packages do analysis and visualization.

Docs

See https://cmdstanpy.readthedocs.io/en/latest/index.html

Source Repository

CmdStan's source-code repository is hosted here on GitHub.

Licensing

The CmdStanPy, CmdStan, and the core Stan C++ code are licensed under new BSD.

Example

::

import os
from cmdstanpy import cmdstan_path, CmdStanModel

# specify locations of Stan program file and data
bernoulli_stan = os.path.join(cmdstan_path(), 'examples', 'bernoulli', 'bernoulli.stan')
bernoulli_data = os.path.join(cmdstan_path(), 'examples', 'bernoulli', 'bernoulli.data.json')

# instantiate a model; compiles the Stan program by default
bernoulli_model = CmdStanModel(stan_file=bernoulli_stan)

# obtain a posterior sample from the model conditioned on the data
bernoulli_fit = bernoulli_model.sample(chains=4, data=bernoulli_data)

# summarize the results (wraps CmdStan `bin/stansummary`):
bernoulli_fit.summary()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cmdstanpy-0.9.65.tar.gz (53.2 kB view details)

Uploaded Source

Built Distribution

cmdstanpy-0.9.65-py3-none-any.whl (42.2 kB view details)

Uploaded Python 3

File details

Details for the file cmdstanpy-0.9.65.tar.gz.

File metadata

  • Download URL: cmdstanpy-0.9.65.tar.gz
  • Upload date:
  • Size: 53.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.0

File hashes

Hashes for cmdstanpy-0.9.65.tar.gz
Algorithm Hash digest
SHA256 77b3d59a4b2ddf132a807ca7b379f88157284cb3fd740f82edbce1b7e7f12675
MD5 e1ce7477a6d8856176a1c9e1b9023eb3
BLAKE2b-256 9d47578086fcb1ea80ca50af48f7a16384e60995f0fe488bddd186bb08572f1c

See more details on using hashes here.

File details

Details for the file cmdstanpy-0.9.65-py3-none-any.whl.

File metadata

  • Download URL: cmdstanpy-0.9.65-py3-none-any.whl
  • Upload date:
  • Size: 42.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.0

File hashes

Hashes for cmdstanpy-0.9.65-py3-none-any.whl
Algorithm Hash digest
SHA256 f15d8195fd6c33fb840d25ac31cb10677c728e936ae287c94678b2b3076cd03e
MD5 97aaa66b1ab77562132988d48b6049f7
BLAKE2b-256 6e424547b75ebde882edad80324b3faa96cd1579b48bb8a5d160b60132760b5d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page