Httpstan.API

Client and Server

data Config

Server or client configuration, specifying the host and port to query or serve on.

Constructors

Config

Fields

• configUrl :: String

  scheme:/hostname:portpath, e.g. "http://localhost:8080/"

Instances

Read Config

Defined in Httpstan.API

Methods

readsPrec :: Int -> ReadS Config

readList :: ReadS [Config]

readPrec :: ReadPrec Config

readListPrec :: ReadPrec [Config]

Show Config

Defined in Httpstan.API

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

Eq Config

Defined in Httpstan.API

Methods

(==) :: Config -> Config -> Bool

(/=) :: Config -> Config -> Bool

Ord Config

Defined in Httpstan.API

Methods

compare :: Config -> Config -> Ordering

(<) :: Config -> Config -> Bool

(<=) :: Config -> Config -> Bool

(>) :: Config -> Config -> Bool

(>=) :: Config -> Config -> Bool

max :: Config -> Config -> Config

min :: Config -> Config -> Config

data HttpstanBackend m

Configuration, specifying the full url of the service.

Backend for Httpstan. The backend can be used both for the client and the server. The client generated from the Httpstan OpenAPI spec is a backend that executes actions by sending HTTP requests (see createHttpstanClient). Alternatively, provided a backend, the API can be served using runHttpstanMiddlewareServer.

Constructors

HttpstanBackend

Fields

• v1HealthGet :: m NoContent

  Check if service is running.

• v1ModelsGet :: m V1ModelsGet200Response

  List cached models.

• v1ModelsModelIdDelete :: Text -> m NoContent

  Delete a model which has been saved in the cache.

• v1ModelsModelIdFitsFitIdDelete :: Text -> Text -> m NoContent

  Delete a fit which has been saved in the cache.

• v1ModelsModelIdFitsFitIdGet :: Text -> Text -> m NoContent

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

• v1ModelsModelIdFitsPost :: Text -> CreateFitRequest -> m Fit

  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.

• v1ModelsModelIdLogProbGradPost :: Text -> Bool -> m V1ModelsModelIdLogProbGradPost200Response

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

• v1ModelsModelIdLogProbPost :: Text -> Bool -> m V1ModelsModelIdLogProbPost200Response

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

• v1ModelsModelIdParamsPost :: Text -> Value -> m V1ModelsModelIdParamsPost200Response

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

• v1ModelsModelIdTransformInitsPost :: Text -> Value -> m V1ModelsModelIdTransformInitsPost200Response

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

• v1ModelsModelIdWriteArrayPost :: Text -> Bool -> m V1ModelsModelIdWriteArrayPost200Response

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

• v1ModelsPost :: CreateModelRequest -> m Model

  Compile a Stan model

• v1OperationsOperationIdGet :: Text -> m Operation

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

createHttpstanClient :: HttpstanBackend HttpstanClient

runHttpstanServer :: (MonadIO m, MonadThrow m) => Config -> HttpstanBackend (ExceptT ServerError IO) -> m ()

Run the Httpstan server at the provided host and port.

runHttpstanMiddlewareServer :: (MonadIO m, MonadThrow m) => Config -> Middleware -> HttpstanBackend (ExceptT ServerError IO) -> m ()

Run the Httpstan server at the provided host and port.

runHttpstanClient :: Config -> HttpstanClient a -> ExceptT ClientError IO a

Run requests in the HttpstanClient monad.

runHttpstanClientWithManager :: Manager -> Config -> HttpstanClient a -> ExceptT ClientError IO a

Run requests in the HttpstanClient monad using a custom manager.

callHttpstan :: (MonadIO m, MonadThrow m) => ClientEnv -> HttpstanClient a -> m a

Like runClient, but returns the response or throws a HttpstanClientError

data HttpstanClient a

Instances

MonadIO HttpstanClient

Defined in Httpstan.API

Methods

liftIO :: IO a -> HttpstanClient a

Applicative HttpstanClient

Defined in Httpstan.API

Methods

pure :: a -> HttpstanClient a

(<*>) :: HttpstanClient (a -> b) -> HttpstanClient a -> HttpstanClient b

liftA2 :: (a -> b -> c) -> HttpstanClient a -> HttpstanClient b -> HttpstanClient c

(*>) :: HttpstanClient a -> HttpstanClient b -> HttpstanClient b

(<*) :: HttpstanClient a -> HttpstanClient b -> HttpstanClient a

Functor HttpstanClient

Defined in Httpstan.API

Methods

fmap :: (a -> b) -> HttpstanClient a -> HttpstanClient b

(<$) :: a -> HttpstanClient b -> HttpstanClient a

Monad HttpstanClient

Defined in Httpstan.API

Methods

(>>=) :: HttpstanClient a -> (a -> HttpstanClient b) -> HttpstanClient b

(>>) :: HttpstanClient a -> HttpstanClient b -> HttpstanClient b

return :: a -> HttpstanClient a

newtype HttpstanClientError

Custom exception type for our errors.

Constructors

HttpstanClientError ClientError

Instances

Exception HttpstanClientError

Defined in Httpstan.API

Methods

toException :: HttpstanClientError -> SomeException

fromException :: SomeException -> Maybe HttpstanClientError

displayException :: HttpstanClientError -> String

Show HttpstanClientError

Defined in Httpstan.API

Methods

showsPrec :: Int -> HttpstanClientError -> ShowS

show :: HttpstanClientError -> String

showList :: [HttpstanClientError] -> ShowS

Servant

type HttpstanAPI = ("v1" :> ("health" :> Verb 'GET 200 '[JSON] NoContent)) :<|> (("v1" :> ("models" :> Verb 'GET 200 '[JSON] V1ModelsGet200Response)) :<|> (("v1" :> ("models" :> (Capture "model_id" Text :> Verb 'DELETE 200 '[JSON] NoContent))) :<|> (("v1" :> ("models" :> (Capture "model_id" Text :> ("fits" :> (Capture "fit_id" Text :> Verb 'DELETE 200 '[JSON] NoContent))))) :<|> (("v1" :> ("models" :> (Capture "model_id" Text :> ("fits" :> (Capture "fit_id" Text :> Verb 'GET 200 '[JSON] NoContent))))) :<|> (("v1" :> ("models" :> (Capture "model_id" Text :> ("fits" :> (ReqBody '[JSON] CreateFitRequest :> Verb 'POST 201 '[JSON] Fit))))) :<|> (("v1" :> ("models" :> (Capture "model_id" Text :> ("log_prob_grad" :> (ReqBody '[JSON] Bool :> Verb 'POST 200 '[JSON] V1ModelsModelIdLogProbGradPost200Response))))) :<|> (("v1" :> ("models" :> (Capture "model_id" Text :> ("log_prob" :> (ReqBody '[JSON] Bool :> Verb 'POST 200 '[JSON] V1ModelsModelIdLogProbPost200Response))))) :<|> (("v1" :> ("models" :> (Capture "model_id" Text :> ("params" :> (ReqBody '[JSON] Value :> Verb 'POST 200 '[JSON] V1ModelsModelIdParamsPost200Response))))) :<|> (("v1" :> ("models" :> (Capture "model_id" Text :> ("transform_inits" :> (ReqBody '[JSON] Value :> Verb 'POST 200 '[JSON] V1ModelsModelIdTransformInitsPost200Response))))) :<|> (("v1" :> ("models" :> (Capture "model_id" Text :> ("write_array" :> (ReqBody '[JSON] Bool :> Verb 'POST 200 '[JSON] V1ModelsModelIdWriteArrayPost200Response))))) :<|> (("v1" :> ("models" :> (ReqBody '[JSON] CreateModelRequest :> Verb 'POST 201 '[JSON] Model))) :<|> (("v1" :> ("operations" :> (Capture "operation_id" Text :> Verb 'GET 200 '[JSON] Operation))) :<|> Raw))))))))))))

Servant type-level API, generated from the OpenAPI spec for Httpstan.

Plain WAI Application

serverWaiApplicationHttpstan :: HttpstanBackend (ExceptT ServerError IO) -> Application

Plain Network.Wai Application for the Httpstan server.

Can be used to implement e.g. tests that call the API without a full webserver.