Workspace operations

Workspace management requires the MLflow server to run with --enable-workspaces.

MLFlowClient.listworkspaces — Function

listworkspaces(instance::MLFlow)

List all workspaces available to the current principal.

Note

Workspace management requires the MLflow server to run with --enable-workspaces.

Arguments

instance: MLFlow configuration.

Returns

Vector of Workspace entities.

source

MLFlowClient.createworkspace — Function

createworkspace(instance::MLFlow, name::String;
    description::Union{String,Missing}=missing,
    default_artifact_root::Union{String,Missing}=missing,
    trace_archival_config::Union{Dict,Missing}=missing)

Create a new workspace.

Arguments

instance: MLFlow configuration.
name: Workspace name to create.
description: Optional workspace description.
default_artifact_root: Optional default artifact root override.
trace_archival_config: Optional trace archival settings with location and/or retention keys.

Returns

An instance of type Workspace.

source

MLFlowClient.getworkspace — Function

getworkspace(instance::MLFlow, workspace_name::String)

Get a workspace by name.

Arguments

instance: MLFlow configuration.
workspace_name: Name of the workspace to retrieve.

Returns

An instance of type Workspace.

source

MLFlowClient.updateworkspace — Function

updateworkspace(instance::MLFlow, workspace_name::String;
    description::Union{String,Missing}=missing,
    default_artifact_root::Union{String,Missing}=missing,
    trace_archival_config::Union{Dict,Missing}=missing)

Update a workspace's metadata.

Arguments

instance: MLFlow configuration.
workspace_name: Name of the workspace to update.
description: Optional new description.
default_artifact_root: Optional new default artifact root override.
trace_archival_config: Optional new trace archival settings.

Returns

An instance of type Workspace.

source

MLFlowClient.deleteworkspace — Function

deleteworkspace(instance::MLFlow, workspace_name::String)

Delete a workspace.

Arguments

instance: MLFlow configuration.
workspace_name: Name of the workspace to delete.

Returns

true if successful. Otherwise, raises exception.

source