Skip to main content
MlFoundryRun.

Properties

Get run_id for the current run

Returns

str
Get run_name for the current run

Returns

str
Get fqn for the current run

Returns

str
Get status for the current run

Returns

Get ml_repo name of which the current run is part of

Returns

str
Tells whether automatic end for run is True or False

Returns

bool

Methods

End a run.

Parameters

RunStatus
default:"RunStatus.FINISHED"

Returns

None

Usage

This function permanently delete the run

Returns

Any

Usage

Get all the version of an artifact from a particular run to download contents or load them in memory

Parameters

Optional[ArtifactType]
default:"ArtifactType.ARTIFACT"

Returns

Iterator[ArtifactVersion]

Usage

Get all the version of a models from a particular run to download contents or load them in memory

Returns

Iterator[ModelVersion]

Usage

Logs an artifact for the current ML Repo.

Parameters

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

Returns

Usage

Log metrics for the current run.

Parameters

Dict[str, Union[int, float]]
required
int
default:"0"

Returns

None

Usage

Logs parameters for the run.

Parameters

ParamsType
required
bool
default:"False"

Returns

None

Usage

Set tags for the current run.

Parameters

Dict[str, str]
required

Returns

None

Usage

Returns all the tags set for the current run.

Parameters

Any
default:"False"

Returns

Dict[str, str]

Usage

Get metrics logged for the current run grouped by metric name.

Parameters

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

Returns

Dict[str, List[Metric]]

Usage

Get all the params logged for the current run.

Parameters

Any
default:"False"

Returns

Dict[str, str]

Usage

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

Parameters

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

Returns

Usage