A CmdStanMLE object is the fitted model object returned by the $optimize() method of a CmdStanModel object.

Methods

CmdStanMLE objects have the following associated methods, all of which have their own (linked) documentation pages.

Extract contents of fitted model object

MethodDescription
draws()Return the point estimate as a 1-row draws_matrix.
$mle()Return the point estimate as a numeric vector.
$lp()Return the total log probability density (target).
$init()Return user-specified initial values.
$metadata()Return a list of metadata gathered from the CmdStan CSV files.

Summarize inferences

MethodDescription
$summary()Run posterior::summarise_draws().

Save fitted model object and temporary files

MethodDescription
$save_object()Save fitted model object to a file.
$save_output_files()Save output CSV files to a specified location.
$save_data_file()Save JSON data file to a specified location.

Report run times, console output, return codes

MethodDescription
$time()Report the total run time.
$output()Pretty print the output that was printed to the console.
$return_codes()Return the return codes from the CmdStan runs.

See also

The CmdStanR website (mc-stan.org/cmdstanr) for online documentation and tutorials.

The Stan and CmdStan documentation:

Other fitted model objects: CmdStanGQ, CmdStanMCMC, CmdStanVB