KonanSDK

class konan_sdk.sdk.KonanSDK(auth_url='https://auth.konan.ai', api_url='https://api.konan.ai', verbose=False)

Bases: object

konan-sdk’s main class for API integration.

__init__(auth_url='https://auth.konan.ai', api_url='https://api.konan.ai', verbose=False)

login(email: str, password: str) → None

Login to Konan with user credentials

Parameters

• email (str) – email of registered user

• password (str) – password of registered user

create_deployment(name: str, docker_credentials: konan_sdk.konan_types.KonanDockerCredentials, docker_image: konan_sdk.konan_types.KonanDockerImage) → konan_sdk.konan_types.KonanDeploymentCreationResponse

Call the create deployment function

Parameters

• name (str) – name of the deployment to create

• docker_credentials (KonanDockerCredentials) – credentials for the docker registry to use

• docker_image (KonanDockerImage) – docker image information

Returns

konan_deployment_creation_response

Return type

KonanDeploymentCreationResponse

predict(deployment_uuid: str, input_data: Union[Dict, str]) → Tuple[str, Dict]

Call the predict function for a given deployment

Parameters

• deployment_uuid (str) – uuid of deployment to use for prediction

• input_data (Union[Dict, str]) – data to pass to the model

Returns

A tuple of prediction uuid and the prediction output

Return type

Tuple[str, Dict]

evaluate(deployment_uuid: str, start_time: datetime.datetime, end_time: datetime.datetime) → List[konan_sdk.konan_metrics.KonanBaseMetric]

Call the evaluate function for a given deployment

Parameters

• deployment_uuid (str) – uuid of deployment to use for evaluation

• start_time (datetime.datetime) – use predictins made at or after this time

• end_time (datetime.datetime) – use predictins made before or at this time

Returns

A model evaluation object

Return type

EvaluateEndpoint.ResponseObject

feedback(deployment_uuid: str, feedbacks: List[konan_sdk.konan_types.KonanFeedbackSubmission]) → konan_sdk.konan_types.KonanFeedbacksResult

Call the feedback function for a given deployment

Parameters

• deployment_uuid (str) – uuid of deployment to use for prediction

• feedbacks (List[KonanFeedbackSubmission]) – feedback objects to register with the deployment

Returns

feedback result

Return type

KonanFeedbacksResult

delete_deployment(deployment_uuid: str) → bool

Call the delete function for a given deployment WARNING: Using this method with a valid deployment_uuid will DELETE it!! :param deployment_uuid: uuid of deployment to delete :type deployment_uuid: str :return: success :rtype: bool