mltrace.db package

Submodules

mltrace.db.base module

class mltrace.db.base.BaseWithRepr

Bases: object

mltrace.db.models module

class mltrace.db.models.Component(name, description, owner, tags=[])

Bases: Base

add_tags(tags: List[Tag])

component_runs

description

name

owner

tags

class mltrace.db.models.ComponentRun(component_name)

Bases: Base

add_input(input: IOPointer)

Add a single input (instance of IOPointer).

add_inputs(inputs: List[IOPointer])

Add a list of inputs (each element should be an instance of IOPointer).

add_notes(notes: str)

Add notes describing details of component run

add_output(output: IOPointer)

“Add a single output (instance of IOPointer).

add_outputs(outputs: List[IOPointer])

Add a list of outputs (each element should be an instance of IOPointer).

add_staleness_message(message: str)

Staleness indicator.

check_completeness() → dict

Returns a dictionary of success indicator and error messages.

code_snapshot

component_name

dependencies

end_timestamp

git_hash

git_tags

id

inputs

mlflow_run_id

mlflow_run_metrics

mlflow_run_params

notes

outputs

set_code_snapshot(code_snapshot: bytes)

Code snapshot setter.

set_end_timestamp(ts: Optional[datetime] = None)

Call this function to set the end timestamp to a specific timestamp or now.

set_git_hash(git_hash: str)

Git hash setter.

set_git_tags(git_tags: List[str])

Git tag setter.

set_mlflow_run_id(mlflow_run_id: str)

Call this function to set the mlflow component run id

set_mlflow_run_metrics(mlflow_run_metrics: dict)

Call this function to set the mlflow component run id

set_mlflow_run_params(mlflow_run_params: dict)

Call this function to set the mlflow component run id

set_start_timestamp(ts: Optional[datetime] = None)

Call this function to set the start timestamp to a specific timestamp or now.

set_test_result(test_results: JSON)

set_upstream(dependencies: Union[List[ComponentRun], ComponentRun])

Set dependencies for this ComponentRun. API similar to Airflow set_upstream.

stale

start_timestamp

test_results

class mltrace.db.models.IOPointer(name, value=b'', pointer_type=PointerTypeEnum.UNKNOWN, labels=[])

Bases: Base

add_label(label: Label)

add_labels(labels: list[Label])

clear_flag()

dedup_labels()

flag

labels

name

pointer_type

set_flag()

set_pointer_type(pointer_type: PointerTypeEnum)

value

class mltrace.db.models.Label(id)

Bases: Base

id

io_pointers

class mltrace.db.models.PointerTypeEnum(value)

Bases: str, Enum

An enumeration.

DATA = 'DATA'

ENDPOINT = 'ENDPOINT'

MODEL = 'MODEL'

UNKNOWN = 'UNKNOWN'

class mltrace.db.models.Tag(name)

Bases: Base

name

mltrace.db.store module

mltrace.db.utils module

Module contents