sample

program sample(config:String?, seed:Integer?, model:String?, sampler:String?, filter:String?, kernel:String?, nsamples:Integer?, nsteps:Integer?, input:String?, output:String?, quiet:Boolean <- false)

Sample a model.

birch sample [options...]

  • --config: Name of the configuration file, if any.

  • --seed: Random number seed. If used, overrides seed in the config file, which in turns overrides random entropy.

  • --model: Name of the model class. If used, overrides model.class in the config file.

  • --sampler: Name of the sampler class. If used, overrides sampler.class in the config file, which in turn overrides the default of ParticleSampler.

  • --filter: Name of the filter class. If used, overrides filter.class in the config file, which in turn overrides the default of ParticleFilter.

  • --kernel: Name of the kernel class. If used, overrides kernel.class in the config file, which in turn overrides the default of LangevinKernel.

  • --nsamples: Number of samples to draw. If used, this overrides nsamples in the config file, which in turn overrides sampler.nsamples (deprecated) in the config file, which in turn overrides the default of 1.

  • --nsteps: Number of steps to take. If used, this overrides nsteps in the config file, which in turn overrides filter.nsteps (deprecated) in the config file, which in turn overrides the number of steps derived from the input file, which in turn overrides the default of 0.

  • --input: Name of the input file, if any. If used, overrides input in the config file.

  • --output: Name of the output file, if any. If used, overrides output in the config file.

  • --quiet true: Don't display a progress bar.