Skip to main content
MlFoundry.

Properties

Methods

Returns a list of names of ML Repos accessible by the current user.

Returns

return
List[str]

Usage

Creates an ML Repository.

Parameters

name
str
required
storage_integration_fqn
str
required
description
Optional[str]
default:"None"

Returns

return
None

Usage

Initialize a run.

Parameters

ml_repo
str
required
run_name
Optional[str]
default:"None"
tags
Optional[Dict[str, Any]]
default:"None"

Returns

return
MlFoundryRun

Usage

Get an existing run by the run_id.

Parameters

run_id
str
required

Returns

return
MlFoundryRun

Usage

Get an existing run by fqn.

Parameters

run_fqn
str
required

Returns

return
MlFoundryRun

Usage

Get an existing run by run_name.

Parameters

ml_repo
str
required
run_name
str
required

Returns

return
MlFoundryRun

Usage

The user must have READ access to the ML Repo.

Parameters

ml_repo
str
required
filter_string
str
run_view_type
ViewType
default:"value"
order_by
Sequence[str]
default:"..."
job_run_name
Optional[str]
default:"None"

Returns

return
Iterator[MlFoundryRun]

Usage

Get the model version to download contents or load it in memory

Parameters

ml_repo
str
required
name
str
required
version
Union[str, int]
default:"constants.LATEST_ARTIFACT_OR_MODEL_VERSION"

Returns

return
Optional[ModelVersion]

Usage

Get the model version to download contents or load it in memory

Parameters

fqn
str
required

Returns

return
ModelVersion

Usage

Get all the version of a model to download contents or load them in memory

Parameters

ml_repo
str
required
name
str
required

Returns

return
Iterator[ModelVersion]

Usage

List versions for a given model

Parameters

model_fqn
str
required

Returns

return
Iterator[ModelVersion]

Usage

Get the model version to download contents or load it in memory

Parameters

ml_repo
str
required
name
str
required
artifact_type
Optional[ArtifactType]
default:"ArtifactType.ARTIFACT"
version
Union[str, int]
default:"constants.LATEST_ARTIFACT_OR_MODEL_VERSION"

Returns

return
Optional[ArtifactVersion]

Usage

Get the artifact version to download contents

Parameters

fqn
str
required

Returns

return
ArtifactVersion

Usage

Get all the version of na artifact to download contents or load them in memory

Parameters

ml_repo
str
required
name
str
required
artifact_type
Optional[ArtifactType]
default:"ArtifactType.ARTIFACT"

Returns

return
Iterator[ArtifactVersion]

Usage

List versions for a given artifact

Parameters

artifact_fqn
str
required

Returns

return
Iterator[ArtifactVersion]

Usage

Logs an artifact for the current ml_repo.

Parameters

ml_repo
str
required
name
str
required
artifact_paths
List[Union[Tuple[str], Tuple[str, Optional[str]], ArtifactPath]]
required
description
Optional[str]
default:"None"
metadata
Optional[Dict[str, Any]]
default:"None"
progress
Optional[bool]
default:"None"

Returns

return
Optional[ArtifactVersion]

Usage

Serialize and log a versioned model under the current ml_repo. Each logged model generates a new version

Parameters

ml_repo
str
required
name
str
required
model_file_or_folder
Union[str, BlobStorageDirectory]
required
description
Optional[str]
default:"None"
metadata
Optional[Dict[str, Any]]
default:"None"
progress
Optional[bool]
default:"None"
framework
Optional[Union[str, ModelFramework, Any]]
default:"None"
environment
Optional[ModelVersionEnvironment]
default:"None"

Returns

return
ModelVersion

Usage

Create DataDirectory to Upload the files

Parameters

ml_repo
str
required
name
str
required
description
Optional[str]
default:"None"
metadata
Optional[Dict[str, Any]]
default:"None"

Returns

return
DataDirectory

Usage

Get the DataDirectory by DataDirectory FQN

Parameters

fqn
str
required

Returns

return
DataDirectory

Usage

Get an existing data_directory by name.

Parameters

ml_repo
str
required
name
str
required

Returns

return
DataDirectory

Usage

Get the list of DataDirectory in a ml_repo

Parameters

ml_repo
str
required

Returns

return
Iterator[DataDirectory]

Usage