Operations

GET /v1/health

Check if service is running.

GET /v1/models

List cached models.

DELETE /v1/models/{model_id}

Delete a model and any associated fits.

Delete a model which has been saved in the cache.

DELETE /v1/models/{model_id}/fits/{fit_id}

Delete a fit.

Delete a fit which has been saved in the cache.

GET /v1/models/{model_id}/fits/{fit_id}

Get results returned by a function.

Result (draws, logger messages) from calling a function defined in stan::services.

POST /v1/models/{model_id}/fits

Call function defined in stan::services.

A request to this endpoint starts a long-running operation. Users can retrieve information about the status of the operation by making a GET request to the operations resource endpoint. When the operation is done, the "fit" may be downloaded. (A "fit" collects all logger and writer messages from Stan.) `function` indicates the name of the ``stan::services function`` which should be called given the Stan model associated with the id `model_id`. For example, if sampling using ``stan::services::sample::hmc_nuts_diag_e_adapt`` then `function` is the full function name ``stan::services::sample::hmc_nuts_diag_e_adapt``. Sampler parameters which are not supplied will be given default values taken from CmdStan. For example, if ``stan::services::sample::hmc_nuts_diag_e_adapt`` is the function called and the parameter `num_samples` is not specified, the value 1000 will be used. For a full list of default values consult the CmdStan documentation.

POST /v1/models/{model_id}/log_prob_grad

Return the gradient of the log posterior evaluated at the unconstrained parameters.

Returns the output of Stan C++ `stan::model::log_prob_grad`.

POST /v1/models/{model_id}/log_prob

Return the log probability of the unconstrained parameters.

Returns the output of Stan C++ `log_prob` model class method.

POST /v1/models/{model_id}/params

Get parameter names and dimensions.

Returns the output of Stan C++ model class methods: `constrained_param_names`, `get_param_names` and `get_dims`.

POST /v1/models/{model_id}/transform_inits

Return a sequence of unconstrained parameters.

Returns the output of Stan C++ `transform_inits` model class method.

POST /v1/models/{model_id}/write_array

Return a sequence of constrained parameters.

Returns the output of Stan C++ `write_array` model class method.

POST /v1/models

Compile a Stan model

GET /v1/operations/{operation_id}

Get Operation details.

Return Operation details. Details about an Operation include whether or not the operation is done and information about the progress of sampling.