mantik.utils.mantik_api.models

Interact with trained models in mantik api

Attributes

T

logger

Exceptions

InvalidModelError

The given model payload is invalid

Classes

GetModel

GetModelNoKeywords

ModelBase

ModelBaseKeywords

PostPutModel

Functions

add(→ uuid.UUID)

Creates a trained model entry through the Mantik API

delete(project_id, model_id, token)

Deletes a trained model entry through the Mantik API

get_all(→ List[GetModel])

Retrieves trained model entries through the Mantik API

get_image_url(→ str)

Retrieves a download url

get_one(→ GetModel)

Retrieves a trained model entry from the Mantik API

optional_cast(→ Optional[T])

start_build(→ None)

Trigger the build for a containerized trained model

update(updated_model_schema, project_id, model_id, token)

Updates a trained model entry through the Mantik API

Module Contents

class mantik.utils.mantik_api.models.GetModel[source]

Bases: ModelBaseKeywords, GetModelNoKeywords

classmethod from_json(json_str)[source]
class mantik.utils.mantik_api.models.GetModelNoKeywords[source]

Bases: ModelBase

model_id: uuid.UUID[source]
status: str[source]
exception mantik.utils.mantik_api.models.InvalidModelError[source]

Bases: Exception

The given model payload is invalid

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

class mantik.utils.mantik_api.models.ModelBase[source]
name: str[source]
class mantik.utils.mantik_api.models.ModelBaseKeywords[source]
connection_id: uuid.UUID | None = None[source]
location: str | None = None[source]
mlflow_parameters: dict | None = None[source]
run_id: uuid.UUID | None = None[source]
uri: str | None = None[source]
class mantik.utils.mantik_api.models.PostPutModel[source]

Bases: ModelBaseKeywords, ModelBase

to_dict()[source]
validate()[source]
mantik.utils.mantik_api.models.T[source]
mantik.utils.mantik_api.models.add(new_model_schema: PostPutModel, project_id: uuid.UUID, token: str) uuid.UUID[source]

Creates a trained model entry through the Mantik API

mantik.utils.mantik_api.models.delete(project_id: uuid.UUID, model_id: uuid.UUID, token: str)[source]

Deletes a trained model entry through the Mantik API

mantik.utils.mantik_api.models.get_all(project_id: uuid.UUID, token: str) List[GetModel][source]

Retrieves trained model entries through the Mantik API

mantik.utils.mantik_api.models.get_image_url(project_id: uuid.UUID, model_id: uuid.UUID, token: str) str[source]

Retrieves a download url for a containerized trained model from the Mantik API

mantik.utils.mantik_api.models.get_one(project_id: uuid.UUID, model_id: uuid.UUID, token: str) GetModel[source]

Retrieves a trained model entry from the Mantik API

mantik.utils.mantik_api.models.logger[source]
mantik.utils.mantik_api.models.optional_cast(_type: T, optional_value: Any | None) T | None[source]
mantik.utils.mantik_api.models.start_build(project_id: uuid.UUID, model_id: uuid.UUID, token: str) None[source]

Trigger the build for a containerized trained model from the Mantik API

mantik.utils.mantik_api.models.update(updated_model_schema: PostPutModel, project_id: uuid.UUID, model_id: uuid.UUID, token: str)[source]

Updates a trained model entry through the Mantik API