mlrun.common.schemas.artifact#

class mlrun.common.schemas.artifact.Artifact(*, kind: str, metadata: ArtifactMetadata, spec: ArtifactSpec, status: ObjectStatus)[source]#

Bases: BaseModel

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.

kind: str#
metadata: ArtifactMetadata#
spec: ArtifactSpec#
status: ObjectStatus#
class mlrun.common.schemas.artifact.ArtifactCategories(value)[source]#

Bases: StrEnum

An enumeration.

dataset = 'dataset'#
model = 'model'#
other = 'other'#
to_kinds_filter() tuple[list[str], bool][source]#
class mlrun.common.schemas.artifact.ArtifactIdentifier(*, kind: str | None = None, key: str | None = None, iter: int | None = None, uid: str | None = None, producer_id: str | None = None)[source]#

Bases: BaseModel

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.

iter: int | None#
key: str | None#
kind: str | None#
producer_id: str | None#
uid: str | None#
class mlrun.common.schemas.artifact.ArtifactMetadata(*, key: str, project: str, iter: int | None = None, tree: str | None = None, tag: str | None = None, **extra_data: Any)[source]#

Bases: BaseModel

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 Config[source]#

Bases: object

extra = 'allow'#
iter: int | None#
key: str#
project: str#
tag: str | None#
tree: str | None#
class mlrun.common.schemas.artifact.ArtifactSpec(*, src_path: str | None = None, target_path: str | None = None, viewer: str | None = None, inline: str | None = None, size: int | None = None, db_key: str | None = None, extra_data: dict[str, Any] | None = None, unpackaging_instructions: dict[str, Any] | None = None, **extra_data_: Any)[source]#

Bases: BaseModel

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 Config[source]#

Bases: object

extra = 'allow'#
db_key: str | None#
extra_data: dict[str, Any] | None#
inline: str | None#
size: int | None#
src_path: str | None#
target_path: str | None#
unpackaging_instructions: dict[str, Any] | None#
viewer: str | None#
class mlrun.common.schemas.artifact.ArtifactsDeletionStrategies(value)[source]#

Bases: StrEnum

Artifacts deletion strategies types.

data_force = 'data-force'#

Delete the artifact data, and if cannot delete it fail the deletion and don’t delete the artifact db record

data_optional = 'data-optional'#

Delete the artifact data of the artifact as a best-effort. If artifact data deletion fails still try to delete the artifact db record

metadata_only = 'metadata-only'#

Only removes the artifact db record, leaving all related artifact data in-place