Skip to content

Models

models

JSONType = Union[str, int, float, bool, None, Dict[str, Any], List[Any]] module-attribute

TrackingStore

Abstract class for tracking store.

This class is used to define the interface for tracking store.

__enter__()

__exit__(exc_type, exc_value, traceback)

create_experiment(name: str, description: Optional[str] = None, artifact_uri: Optional[str] = None) -> Experiment abstractmethod

list_experiments() -> List[Experiment] abstractmethod

get_experiment(experiment_id: int) -> Experiment abstractmethod

get_experiment_by_name(name: str) -> Experiment abstractmethod

create_run(experiment_id: int, name: str, description: Optional[str] = None) -> Run abstractmethod

delete_run(experiment_id: int, run_id: int) -> None abstractmethod

list_runs(experiment_id: int) -> List[Run] abstractmethod

search_runs(experiment_id: int, **kwargs) -> List[Run] abstractmethod

set_tag(run_id: int, name: str, value: JSONType = None) -> RunTags abstractmethod

get_tag(run_id: int, name: str) -> JSONType abstractmethod

get_tags(run_id: int) -> Dict[str, JSONType] abstractmethod

count_tags(run_id: int) -> int abstractmethod

delete_tag(run_id: int, name: str) -> RunTags abstractmethod

log_value(run_id: int, key: str, value: str, *, step_id: Optional[int] = None, type: Optional[VariableType] = None, is_step: Optional[bool] = None) -> Value abstractmethod

log_values(run_id: int, values: List[Union[ValueMapping, ValueTuple, Value]], *, step_id: Optional[int] = None, type: Optional[VariableType] = None) -> List[Value]

get_values(run_id: int) -> List[Tuple[Variable, Value]] abstractmethod

import_store(other: TrackingStore)

TrackingClient

store: TrackingStore property

__init__(store: TrackingStore) -> None

create_experiment(name: str, description: Optional[str] = None, artifact_uri: Optional[str] = None) -> Experiment

get_experiment_by_name(name: str) -> Optional[Experiment]

get_or_create_experiment(name: str, *, description: Optional[str] = None, artifact_uri: Optional[str] = None) -> Experiment

list_experiments()

Experiment

Bases: StoredModel

id: int = field(init=False) class-attribute instance-attribute

name: str instance-attribute

description: Optional[str] instance-attribute

artifact_uri: Optional[str] instance-attribute

start_run(name: str, description: Optional[str] = None) -> Run

search_runs(**kwargs) -> List[Run]

delete_run(run: Union[Run, int]) -> None

TagsMapping

Bases: MutableMapping[str, JSONType]

data: Dict[str, JSONType] property

__init__(run: Run) -> None

__getitem__(key: str) -> JSONType

__setitem__(key: str, value: JSONType) -> None

__delitem__(key: str) -> None

__iter__() -> Iterator[str]

__len__() -> int

__repr__() -> str

Run

Bases: StoredModel

id: int = field(init=False) class-attribute instance-attribute

experiment_id: int instance-attribute

name: str instance-attribute

description: Optional[str] instance-attribute

created_at: Optional[dt.datetime] = None class-attribute instance-attribute

tags: MutableMapping[str, JSONType] = field(init=False) class-attribute instance-attribute

__post_init__()

log_param(key: str, value: ValueType, *, step: Union[Value, int, None] = None) -> Value

log_params(values: Mapping[str, ValueType], *, step: Optional[Value] = None, prefix: Optional[str] = None) -> List[Value]

log_metric(key: str, value: ValueType, *, step: Union[Value, int, None] = None) -> Value

log_metrics(values: Mapping[str, ValueType], *, step: Optional[Value] = None, prefix: Optional[str] = None) -> List[Value]

get_values() -> List[Tuple[Variable, Value]]

Variable

Bases: StoredModel

id: int = field(init=False) class-attribute instance-attribute

experiment_id: int instance-attribute

key: str instance-attribute

parent_id: Optional[int] instance-attribute

type: Optional[VariableType] = None class-attribute instance-attribute

is_step: Optional[bool] = None class-attribute instance-attribute

Value

Bases: StoredModel

id: int = field(init=False) class-attribute instance-attribute

run_id: int instance-attribute

variable_id: int instance-attribute

value: ValueType instance-attribute

timestamp: Optional[dt.datetime] = None class-attribute instance-attribute

step_id: Optional[int] = None class-attribute instance-attribute

RunTags

Bases: StoredModel

id: int = field(init=False) class-attribute instance-attribute

run_id: int instance-attribute

tag_id: int instance-attribute

value: JSONType = None class-attribute instance-attribute

Tag

Bases: StoredModel

id: int = field(init=False) class-attribute instance-attribute

name: str instance-attribute

TreeNode

Bases: UserDict

is_nested: bool = False class-attribute instance-attribute

from_values(values: List[Tuple[Variable, Value]]) -> Self classmethod

flatten() -> Dict[Tuple, List]