mlflow.artifacts
APIs for interacting with artifacts in MLflow
-
mlflow.artifacts.
download_artifacts
(artifact_uri: Optional[str] = None, run_id: Optional[str] = None, artifact_path: Optional[str] = None, dst_path: Optional[str] = None) → str[source] Download an artifact file or directory to a local directory.
- Parameters
artifact_uri – URI pointing to the artifacts, such as
"runs:/500cf58bee2b40a4a82861cc31a617b1/my_model.pkl"
,"models:/my_model/Production"
, or"s3://my_bucket/my/file.txt"
. Exactly one ofartifact_uri
orrun_id
must be specified.run_id – ID of the MLflow Run containing the artifacts. Exactly one of
run_id
orartifact_uri
must be specified.artifact_path – (For use with
run_id
) If specified, a path relative to the MLflow Run’s root directory containing the artifacts to download.dst_path – Path of the local filesystem destination directory to which to download the specified artifacts. If the directory does not exist, it is created. If unspecified, the artifacts are downloaded to a new uniquely-named directory on the local filesystem, unless the artifacts already exist on the local filesystem, in which case their local path is returned directly.
- Returns
The location of the artifact file or directory on the local filesystem.