Predictions

class citrination_client.models.predicted_value.PredictedValue(key, value, loss=None, class_probabilities=None)

The value/loss output from a prediction.

__init__(key, value, loss=None, class_probabilities=None)

Constructor.

Parameters

• key (str) – The descriptor key for the prediction

• value (str or float) – The predicted value

• loss (float) – The loss for the prediction

• class_probabilities (dict) – The probabilities for categoricals

class citrination_client.models.prediction_result.PredictionResult

The collection of predicted values resulting from a prediction.

__init__()

Initialize self. See help(type(self)) for accurate signature.

add_value(key, value)

Registers a predicted value in the result.

Parameters

• key (str) – The descriptor key for the predicted value

• value (object) – A PredictedValue

Returns

None

Return type

NoneType

all_keys()

Retrieves a list of all the values which were predicted.

Returns

A list of keys for which predictions have been made and can be retrieved using get_value

Return type

list of str

get_value(key)

Retrieves a predicted value.

Parameters

key (str) – A descriptor key for a registered predicted value.

Returns

The value stored at the provided descriptor key. None if no key is provided.

Return type

PredictedValue