Model#

Model

Create a new model by parsing and validating input data from keyword arguments.

ModelTag

Model tag

ModelVersion

Model version representation

ModelVersionTag

Model version tag

ModelVersionStage

Model version stage

ModelVersionState

Model version state

ModelVersionStatus

Model version state with message

class mlflow_rest_client.model.Model(**data)#

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

class mlflow_rest_client.model.ModelTag(**data)#

Bases: Tag

Model tag

Parameters
keystr

Tag name

valuestr

Tag value

Examples

tag = ModelTag(key="some.tag", value="some.val")
Attributes
keystr

Tag name

valuestr

Tag value

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

class mlflow_rest_client.model.ModelVersion(**data)#

Model version representation

Parameters
namestr

Model name

versionint

Version number

creation_timestampint (UNIX timestamp) or datetime.datetime, optional

Version creation timestamp

last_updated_timestampint (UNIX timestamp) or datetime.datetime, optional

Version last update timestamp

stagestr or ModelVersionStage, optional

Version stage

descriptionstr, optional

Version description

sourcestr, optional

Version source path

run_idstr, optional

Run ID used for generating version

statestr or ModelVersionState, optional

Version stage

state_messagestr, optional

Version state message

tagsdict or list of dict, optional

Experiment tags list

Examples

model_version = ModelVersion(name="some_model", version=1)
Attributes
namestr

Model name

versionint

Version number

created_timedatetime.datetime

Version creation timestamp

updated_timedatetime.datetime

Version last update timestamp

stageModelVersionStage

Version stage

descriptionstr

Version description

sourcestr

Version source path

run_idstr

Run ID used for generating version

statusModelVersionStatus

Version status

tagsModelVersionTagList

Experiment tags list

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

class mlflow_rest_client.model.ModelVersionTag(**data)#

Bases: Tag

Model version tag

Parameters
keystr

Tag name

valuestr

Tag value

Examples

tag = ModelVersionTag(key="some.tag", value="some.val")
Attributes
keystr

Tag name

valuestr

Tag value

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

class mlflow_rest_client.model.ModelVersionStage(value)#

Model version stage

ARCHIVED = 'Archived'#

Model version was archived

PROD = 'Production'#

Is a production model version

TEST = 'Staging'#

Is a testing model version

UNKNOWN = 'None'#

Model version has no stage

class mlflow_rest_client.model.ModelVersionState(value)#

Model version state

FAILED = 'FAILED_REGISTRATION'#

Model version registration was failed

PENDING = 'PENDING_REGISTRATION'#

Model version registration is pending

READY = 'READY'#

Model version registration was successful

class mlflow_rest_client.model.ModelVersionStatus(**data)#

Model version state with message

Parameters
statestr or ModelVersionState, optional

Model version state

messagestr, optional

Model version state message

Examples

status = ModelVersionStatus(state="READY")

status = ModelVersionStatus(state=ModelVersionState.READY)

status = ModelVersionStatus(state=ModelVersionState.FAILED, message="Reason")
Attributes
stateModelVersionState

Model version state

messagestr

Model version state message

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.