Stan V10

Project Status	Documentation	Build Status

Purpose

A collection of example Stan Language programs demonstrating all methods available in Stan's cmdstan executable (as an external program) from Julia.

For most applications one of the "single method" packages, e.g. StanSample.jl, StanDiagnose.jl, etc., is a better choice for day to day use.

To execute the most important method in Stan ("sample"), use StanSample.jl.

Some Pluto notebook examples can be found here.

Background info

Stan.jl has always taken the approach as the recently released CmdStanR and CmdStanPy options to use Stan's cmdstan executable.

In Stan.jl v7 all of cmdstan's methods were moved to separate packages, i.e. StanSample.jl, StanOptimize.jl, StanVariational.jl and StanDiagnose.jl, including an option to run generate_quantities as part of StanSample.jl.

Stan.jl v10 uses StanSample.jl v7, StanOptimize.jl v4, StanQuap.jl v4, StanDiagnose.jl v4 and StanVariational v4 and supports multithreading on C++ level. Stan.jl v10 also uses JSON.jl to generate data and init input files for cmdstan.

Stan.jl v10 supports InferenceObjects.jl and PosteriorDB.jl. See the notebook examples here.

To use the :dimarray or :dimarrays option in read_samples()), see the example notebook dimarray.jl.

The StanJulia ecosystem includes 2 additional packages, StanQuap.jl (to compute MAP estimates) and DiffEqBayesStan.jl.

Requirements

Stan's cmdstan executable needs to be installed separatedly. Please see cmdstan installation. If you plan to use C++ level threads, please read the make/local-example instructions and below section and this file.

Options for multi-threading and multi-chaining

Stan.jl v10 is intended to use Stan's cmdstan v2.28.2+ and StanSample.jl v6.

StanSample.jl v6+ enables the use of c++ multithreading in the cmdstan binary. To activate multithreading in cmdstan this needs to be specified during the build process of cmdstan. I typically create a path_to_cmdstan_directory/make/local file (before running make -j9 build) containing STAN_THREADS=true. For an example, see the .github/CI.yml script

This means StanSample supports 2 mechanisms for in parallel drawing samples for chains, i.e. on C++ level (using C++ threads) and on Julia level (by spawing a Julia process for each chain).

The use_cpp_chains keyword argument for stan_sample() determines if chains are executed on C++ level or on Julia level. By default, use_cpp_chains=false.

By default in ether case num_chains=4. See ??stan_sample. Internally, num_chains will be copied to either num_cpp_chains or num_julia_chains'.

Note: Currently I do not suggest to use both C++ level chains and Julia level chains. Based on use_cpp_chains the stan_sample() method will set either num_cpp_chains=num_chains; num_julia_chains=1 or num_julia_chains=num_chains;num_cpp_chain=1 (the default of use_cpp_chains is false).

Set the check_num_chains keyword argument in the call to stan_sample() to false to prevent above default behavior. See the example in the Examples/RedCardsStudy directory for more details and an example.

Threads on C++ level can be used in multiple ways, e.g. to run separate chains and to speed up certain Stan Language operations.

StanSample.jl's SampleModel sets the C++ num_threads to 4 but for compatibility with previous versions of StanJulia this is by default (use_cpp_chains=false) not included in the generated command line, e.g. see sm.cmds where sm is your SampleModel.

An example of the possible performance trade-offs between use_cpp_threads, num_cpp_chains and num_julia_chains can be found in the this directory.

Conda based installation walkthrough for running Stan from Julia on Windows

Note 1: The conda way of installing also works on other platforms. See also.

Note 2: I believe if you have used CmdstanR (or CmdstanPy) to install cmdstan you can use that cmdstan version in Julia.

Make sure you have conda installed on your system and available from the command line (you can use the conda version that comes with Conda.jl or install your own).

Activate the conda environment into which you want to install cmdstan (e.g. run conda activate stan-env from the command line) or create a new environment (conda create --name stan-env) and then activate it.

Install cmdstan into the active conda environment by running conda install -c conda-forge cmdstan.

You can check that cmdstan, g++, and mingw32-make are installed properly by running conda list cmdstan, g++ --version and mingw32-make --version, respectively, from the activated conda environment.

Start a Julia session from the conda environment in which cmdstan has been installed (this is necessary for the cmdstan installation and the tools to be found).

Add the StanSample.jl package by running ] add StanSample from the REPL.

Set the CMDSTAN environment variable so that Julia can find the cmdstan installation, e.g. from the Julia REPL do: ENV["CMDSTAN"] = "C:/Users/Jakob/.julia/conda/3/envs/stan-env/Library/bin/cmdstan" This needs to be set before you load the StanSample package by e.g. using it. You can add this line to your startup.jl file so that you don't have to run it again in every fresh Julia session.

Versions

Version 10.4.2

1. Mainly package updates.
2. Added an example (function) to duplicate a tmpdir on Windows. See Examples/Bernoulli/bernoulli2.jl.

Version 10.4.0

1. Switch to cmdstan.2.32.0 based testing.

Version 10.3.3

1. Removed direct testing of BridgeStan (as it was removed from StanSample.jl).
2. Two examples of how to use Bridgestan can be found in PlutoExampleNotebooks.jl (test_bridgestan.jland bridgestan_stansample_example.jl) in above mentioned Github repo.

Version 10.3.2

1. Moved Pluto notebook examples to PlutoExampleNotebooks.jl

Version 10.3.1

1. Move the example notebooks to it's own project.
2. Added a CausalInference.jl based example notebook.
3. Upgraded to InferenceObjects v0.3.4

Version 10.0.0

1. Uses StanSample.jl v7.
2. Updated example notebooks.
3. Added some pdf versions of the notebooks.
4. Added a short README to the Example_Notebooks directory.

Version 9.10.6 (experimental release)

1. Switch to InferenceObjects v0.3
2. BridgeStan support has been removed fron StanSample.jl v6.13.8
3. New example notebook to demonstrate use of BridgeStan

Version 9.10.5 (experimental release)

1. Enforce the latest compatible version of StanSample.jl (6.13.7)
2. inferencedata() now uses the Dict based inferencedata3() in StanSample.jl

Versions 9.10-9.10.4

1. Many more (minor and a bit more) updates to inferencedata()
2. Updates to BridgeStan (more to be expected soon)
3. Fix for chain numbering when using CPP threads (thanks to @apinter)
4. Switched to use cmdstan-2.32.0 for testing
5. Updates to Examples_Notebooks (in particular now using both inferencedata() and inferencedata2())

Version 9.10.0

1. Preliminary PosteriorDB example notebook added
2. InferenceData example notebook added
3. BridgeStan example notebook added
4. Package updates

Versions 9.6 - 9.9.4

1. Primarily following StanSample.jl updates
2. Initial InferenceObjects.jl notebook example

Version 9.5.0

1. Fix for matrix input files using JSON.

Version 9.4.0

1. Updated redcardsstudy results for cmdstan-2.29.0.
2. Added a README to the Examples/RedCardsStudy directory

Version 9.2.3

1. Switch to cmdstan-2.29.0

Version 9.2.0 - 9.2.2

1. Switched from JSON3.jl to JSON.jl (JSON.jl supports 2D arrays)
2. Switched back to by default using Julia level chains.

Version 9.1.1

1. Documentation improvement.

version 9.1.0

1. Modified (simplified?) use of num_chains to define either number of chains on C++ or Julia level based on use_cpp_chains keyword argument to stan_sample().

Version 9.0.0

1. Use C++ multithreading features by default (4 num_threads, 4 num_cpp_chains).
2. By default use JSON3.jl to create data.json and init.json input files.

Version 8.1.0

1. Support StanSample.jl v5.3 multithreading in cmdstan

Version 8.0.0

1. Supports both CMDSTAN and JULIA_CMDSTAN_HOME environment variables to point to the cmdstan installation.
2. Thanks to @jfb-h completed testing with using conda to install cmdstan
3. Refactored code between StanBase.jl and the other StanJulia packages.

Version 7.1.1

1. Doc fixes by Jeremiah P S Lewis.
2. Switch default output_format for read_samples() to :table.
3. Add block extract for DataFrames, e.g. DataFrame(m1_1s, :log_lik)

Version 7.1.0

1. Doc fixes. Prepare for switching default output_format for read_samples() to :table.

Version 7.0

This is a breaking update!

1. Use KeyedArray chains as default output format returned by read_samples.
2. Drop the output_format keyword argument in favor of a regulare argument.
3. Removed mostly outdated cluster and thread based examples.
4. Added a new package DiffEqBayesStan.jl.