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.63.tar.gz (51.8 kB view details)

Uploaded Source

Built Distribution

cmdstanpy-0.9.63-py3-none-any.whl (41.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cmdstanpy-0.9.63.tar.gz
  • Upload date:
  • Size: 51.8 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.63.tar.gz
Algorithm Hash digest
SHA256 edbfe05a06619d9652d275551504967ce926613de039ed277914d4df465a0261
MD5 87dbd447f2856c31e8e4719bf85ae42b
BLAKE2b-256 04d08d960fa3a37c31907a8b7084cc67c8d59b57a43ba4a41938f278e6ee4e2b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cmdstanpy-0.9.63-py3-none-any.whl
  • Upload date:
  • Size: 41.4 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.63-py3-none-any.whl
Algorithm Hash digest
SHA256 852a67d5937548efcff5dd57ae9de3647718b14924e03a6a7f20bf5cfc851360
MD5 1b651d524055bdb683fc130ce6cc2cf8
BLAKE2b-256 8e056e055c71d2ddcc48bc5496364e193dd023a75a4aebe6c373f28dd2add6d8

See more details on using hashes here.

Supported by

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