bigml.api.prediction — bigml/clj-bigml 0.3.0

Offers functions specific for BigML predictions. https://bigml.com/developers/predictions

create clj

(create model inputs & params)

Creates a prediction given a model and the field inputs. The model may be either a string representing the model id (model/123123), or a map with either the full model (as returned with get) or a partial model (as returned with list).

The inputs may either be a map (field ids to values), or a sequence of the inputs fields in the order they appeared during training.

This function also accepts the optional creation parameters defined in the BigML API docs: https://bigml.com/developers/predictions#p_create

HTTP response information is attached as meta data. Exceptions are thrown on failure unless :throw-exceptions is set as false (default is true), in which case the HTTP response details are returned as a map on failure.

list clj

(list & params)

Retrieves a list of predictions. The optional parameters can include pagination and filtering options detailed here: https://bigml.com/developers/predictions#s_list

Pagination details are returned as meta data attached to the list, along with the HTTP response information. Exceptions are thrown on failure unless :throw-exceptions is set as false (default is true), in which case the HTTP response details are returned as a map on failure.

output clj

(output prediction)

Returns the prediction output.

predictor clj

(predictor model)

Returns the model as a function for making predictions locally. The returned function expects either a map of inputs (field ids to values), or a sequence of the input fields in the order they appeared during training.

The generated fn will also accept optional parameters: :details - When false, returns only the prediction output value. When true, returns a map including output, count, confidence, and the objective summary.