mlflow.entities
The mlflow.entities
module defines entities returned by the MLflow
REST API.
-
class
mlflow.entities.
Dataset
(name: str, digest: str, source_type: str, source: str, schema: Optional[str] = None, profile: Optional[str] = None)[source] Note
Experimental: This class may change or be removed in a future release without warning.
Dataset object associated with an experiment.
-
classmethod
from_proto
(proto)[source]
-
to_proto
()[source]
-
classmethod
-
class
mlflow.entities.
DatasetInput
(dataset: Dataset, tags: Optional[List[InputTag]] = None)[source] Note
Experimental: This class may change or be removed in a future release without warning.
DatasetInput object associated with an experiment.
-
classmethod
from_proto
(proto)[source]
Array of input tags.
-
to_proto
()[source]
-
classmethod
-
class
mlflow.entities.
Experiment
(experiment_id, name, artifact_location, lifecycle_stage, tags=None, creation_time=None, last_update_time=None)[source] Experiment object.
-
classmethod
from_proto
(proto)[source]
Tags that have been set on the experiment.
-
to_proto
()[source]
-
classmethod
-
class
mlflow.entities.
ExperimentTag
(key, value)[source] Tag object associated with an experiment.
-
classmethod
from_proto
(proto)[source]
-
to_proto
()[source]
-
classmethod
-
class
mlflow.entities.
FileInfo
(path, is_dir, file_size)[source] Metadata about a file or directory.
-
classmethod
from_proto
(proto)[source]
-
to_proto
()[source]
-
classmethod
-
class
mlflow.entities.
InputTag
(key: str, value: str)[source] Note
Experimental: This class may change or be removed in a future release without warning.
Input tag object associated with a dataset.
-
classmethod
from_proto
(proto)[source]
-
to_proto
()[source]
-
classmethod
-
class
mlflow.entities.
LifecycleStage
[source] -
-
classmethod
is_valid
(lifecycle_stage)[source]
-
classmethod
matches_view_type
(view_type, lifecycle_stage)[source]
-
classmethod
view_type_to_stages
(view_type=3)[source]
-
classmethod
-
class
mlflow.entities.
Metric
(key, value, timestamp, step)[source] Metric object.
-
classmethod
from_proto
(proto)[source]
-
to_proto
()[source]
-
classmethod
-
class
mlflow.entities.
Param
(key, value)[source] Parameter object.
-
classmethod
from_proto
(proto)[source]
-
to_proto
()[source]
-
classmethod
-
class
mlflow.entities.
Run
(run_info: RunInfo, run_data: RunData, run_inputs: Optional[RunInputs] = None)[source] Run object.
-
classmethod
from_proto
(proto)[source]
-
to_dictionary
() → Dict[Any, Any][source]
-
to_proto
()[source]
-
classmethod
-
class
mlflow.entities.
RunData
(metrics=None, params=None, tags=None)[source] Run data (metrics and parameters).
-
classmethod
from_proto
(proto)[source]
-
property
metrics
Dictionary of string key -> metric value for the current run. For each metric key, the metric value with the latest timestamp is returned. In case there are multiple values with the same latest timestamp, the maximum of these values is returned.
Dictionary of tag key (string) -> tag value for the current run.
-
to_dictionary
()[source]
-
to_proto
()[source]
-
classmethod
-
class
mlflow.entities.
RunInfo
(run_uuid, experiment_id, user_id, status, start_time, end_time, lifecycle_stage, artifact_uri=None, run_id=None, run_name=None)[source] Metadata about a run.
-
property
artifact_uri
[source] String root artifact URI of the run.
-
property
end_time
[source] End time of the run, in number of milliseconds since the UNIX epoch.
-
classmethod
from_proto
(proto)[source]
-
classmethod
get_orderable_attributes
()[source]
-
classmethod
get_searchable_attributes
()[source]
-
property
run_id
[source] String containing run id.
-
property
run_name
[source] String containing run name.
-
property
start_time
[source] Start time of the run, in number of milliseconds since the UNIX epoch.
-
property
status
[source] One of the values in
mlflow.entities.RunStatus
describing the status of the run.
-
to_proto
()[source]
-
property
user_id
[source] String ID of the user who initiated this run.
-
property
-
class
mlflow.entities.
RunInputs
(dataset_inputs: List[DatasetInput])[source] RunInputs object.
-
classmethod
from_proto
(proto)[source]
-
to_dictionary
() → Dict[Any, Any][source]
-
to_proto
()[source]
-
classmethod
-
class
mlflow.entities.
RunStatus
[source] Enum for status of an
mlflow.entities.Run
.-
static
all_status
()[source]
-
static
from_string
(status_str)[source]
-
static
is_terminated
(status)[source]
-
static
to_string
(status)[source]
-
static
-
class
mlflow.entities.
RunTag
(key, value)[source] Tag object associated with a run.
-
classmethod
from_proto
(proto)[source]
-
to_proto
()[source]
-
classmethod
-
class
mlflow.entities.
SourceType
[source] Enum for originating source of a
mlflow.entities.Run
.-
SOURCETYPE_TO_STRING
= {1: 'NOTEBOOK', 2: 'JOB', 3: 'PROJECT', 4: 'LOCAL', 5: 'UNKNOWN', 6: 'RECIPE'}
-
static
from_string
(status_str)[source]
-
static
to_string
(status)[source]
-
-
class
mlflow.entities.
ViewType
[source] Enum to filter requested experiment types.
-
classmethod
from_proto
(proto_view_type)[source]
-
classmethod
from_string
(view_str)[source]
-
classmethod
to_proto
(view_type)[source]
-
classmethod
to_string
(view_type)[source]
-
classmethod
-
class
mlflow.entities.model_registry.
ModelVersion
(name, version, creation_timestamp, last_updated_timestamp=None, description=None, user_id=None, current_stage=None, source=None, run_id=None, status='READY', status_message=None, tags=None, run_link=None, aliases=None)[source] MLflow entity for Model Version.
-
property
creation_timestamp
Integer. Model version creation timestamp (milliseconds since the Unix epoch).
-
classmethod
from_proto
(proto)[source]
-
property
last_updated_timestamp
Integer. Timestamp of last update for this model version (milliseconds since the Unix epoch).
-
property
run_link
String. MLflow run link referring to the exact run that generated this model version.
Dictionary of tag key (string) -> tag value for the current model version.
-
to_proto
()[source]
-
property
-
class
mlflow.entities.model_registry.
ModelVersionTag
(key, value)[source] Tag object associated with a model version.
-
classmethod
from_proto
(proto)[source]
-
to_proto
()[source]
-
classmethod
-
class
mlflow.entities.model_registry.
RegisteredModel
(name, creation_timestamp=None, last_updated_timestamp=None, description=None, latest_versions=None, tags=None, aliases=None)[source] MLflow entity for Registered Model.
-
property
creation_timestamp
Integer. Model version creation timestamp (milliseconds since the Unix epoch).
-
classmethod
from_proto
(proto)[source]
-
property
last_updated_timestamp
Integer. Timestamp of last update for this model version (milliseconds since the Unix epoch).
-
property
latest_versions
List of the latest
mlflow.entities.model_registry.ModelVersion
instances for each stage
Dictionary of tag key (string) -> tag value for the current registered model.
-
to_proto
()[source]
-
property
-
class
mlflow.entities.model_registry.
RegisteredModelAlias
(alias, version)[source] Alias object associated with a registered model.
-
classmethod
from_proto
(proto)[source]
-
to_proto
()[source]
-
classmethod