Skip to main content
MlFoundry.

Properties

Methods

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

Returns

List[str]

Usage

Creates an ML Repository.

Parameters

str
required
str
required
Optional[str]
default:"None"

Returns

None

Usage

Initialize a run.

Parameters

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

Returns

MlFoundryRun

Usage

Get an existing run by the run_id.

Parameters

str
required

Returns

MlFoundryRun

Usage

Get an existing run by fqn.

Parameters

str
required

Returns

MlFoundryRun

Usage

Get an existing run by run_name.

Parameters

str
required
str
required

Returns

MlFoundryRun

Usage

The user must have READ access to the ML Repo.

Parameters

str
required
str
ViewType
default:"value"
Sequence[str]
default:"..."
Optional[str]
default:"None"

Returns

Iterator[MlFoundryRun]

Usage

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

Parameters

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

Returns

Optional[ModelVersion]

Usage

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

Parameters

str
required

Returns

ModelVersion

Usage

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

Parameters

str
required
str
required

Returns

Iterator[ModelVersion]

Usage

List versions for a given model

Parameters

str
required

Returns

Iterator[ModelVersion]

Usage

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

Parameters

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

Returns

Optional[ArtifactVersion]

Usage

Get the artifact version to download contents

Parameters

str
required

Returns

ArtifactVersion

Usage

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

Parameters

str
required
str
required
Optional[ArtifactType]
default:"ArtifactType.ARTIFACT"

Returns

Iterator[ArtifactVersion]

Usage

List versions for a given artifact

Parameters

str
required

Returns

Iterator[ArtifactVersion]

Usage

Logs an artifact for the current ml_repo.

Parameters

str
required
str
required
List[Union[Tuple[str], Tuple[str, Optional[str]], ArtifactPath]]
required
Optional[str]
default:"None"
Optional[Dict[str, Any]]
default:"None"
Optional[bool]
default:"None"

Returns

Optional[ArtifactVersion]

Usage

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

Parameters

str
required
str
required
Union[str, BlobStorageDirectory]
required
Optional[str]
default:"None"
Optional[Dict[str, Any]]
default:"None"
Optional[bool]
default:"None"
Optional[Union[str, ModelFramework, Any]]
default:"None"
Optional[ModelVersionEnvironment]
default:"None"

Returns

ModelVersion

Usage

Create DataDirectory to Upload the files

Parameters

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

Returns

DataDirectory

Usage

Get the DataDirectory by DataDirectory FQN

Parameters

str
required

Returns

DataDirectory

Usage

Get an existing data_directory by name.

Parameters

str
required
str
required

Returns

DataDirectory

Usage

Get the list of DataDirectory in a ml_repo

Parameters

str
required

Returns

Iterator[DataDirectory]

Usage