org.mlflow.artifacts

Interface ArtifactRepository

All Known Implementing Classes:

CliBasedArtifactRepository

public interface ArtifactRepository

Allows logging, listing, and downloading artifacts against a remote Artifact Repository. This is used for storing potentially-large objects associated with MLflow runs.

Method Summary

Modifier and Type	Method and Description
File	downloadArtifacts() Returns a local directory containing *all* artifacts within the run's artifact directory.
File	downloadArtifacts(String artifactPath) Returns a local file or directory containing all artifacts within the given artifactPath within the run's root artifactDirectory.
List<Service.FileInfo>	listArtifacts() Lists the artifacts immediately under the run's root artifact directory.
List<Service.FileInfo>	listArtifacts(String artifactPath) Lists the artifacts immediately under the given artifactPath within the run's root artifact irectory.
void	logArtifact(File localFile) Uploads the given local file to the run's root artifact directory.
void	logArtifact(File localFile, String artifactPath) Uploads the given local file to an artifactPath within the run's root directory.
void	logArtifacts(File localDir) Uploads all files within the given local director the run's root artifact directory.
void	logArtifacts(File localDir, String artifactPath) Uploads all files within the given local director an artifactPath within the run's root artifact directory.

Method Detail

logArtifact

void logArtifact(File localFile)

Uploads the given local file to the run's root artifact directory. For example, logArtifact("/my/localModel") listArtifacts() // returns "localModel"

Parameters:

localFile - File to upload. Must exist, and must be a simple file (not a directory).

logArtifact

void logArtifact(File localFile,
                 String artifactPath)

Uploads the given local file to an artifactPath within the run's root directory. For example, logArtifact("/my/localModel", "model") listArtifacts("model") // returns "model/localModel" (i.e., the localModel file is now available in model/localModel).

Parameters:

localFile - File to upload. Must exist, and must be a simple file (not a directory).

artifactPath - Artifact path relative to the run's root directory. Should NOT start with a /.

logArtifacts

void logArtifacts(File localDir)

Uploads all files within the given local director the run's root artifact directory. For example, if /my/local/dir/ contains two files "file1" and "file2", then logArtifacts("/my/local/dir") listArtifacts() // returns "file1" and "file2"

Parameters:

localDir - Directory to upload. Must exist, and must be a directory (not a simple file).

logArtifacts

void logArtifacts(File localDir,
                  String artifactPath)

Uploads all files within the given local director an artifactPath within the run's root artifact directory. For example, if /my/local/dir/ contains two files "file1" and "file2", then logArtifacts("/my/local/dir", "model") listArtifacts("model") // returns "model/file1" and "model/file2" (i.e., the contents of the local directory are now available in model/).

Parameters:

localDir - Directory to upload. Must exist, and must be a directory (not a simple file).

artifactPath - Artifact path relative to the run's root directory. Should NOT start with a /.

listArtifacts

List<Service.FileInfo> listArtifacts()

Lists the artifacts immediately under the run's root artifact directory. This does not recursively list; instead, it will return FileInfos with isDir=true where further listing may be done.

listArtifacts

List<Service.FileInfo> listArtifacts(String artifactPath)

Lists the artifacts immediately under the given artifactPath within the run's root artifact irectory. This does not recursively list; instead, it will return FileInfos with isDir=true where further listing may be done.

Parameters:

artifactPath - Artifact path relative to the run's root directory. Should NOT start with a /.

downloadArtifacts

File downloadArtifacts()

Returns a local directory containing *all* artifacts within the run's artifact directory. Note that this will download the entire directory path, and so may be expensive if the directory a lot of data.

downloadArtifacts

File downloadArtifacts(String artifactPath)

Returns a local file or directory containing all artifacts within the given artifactPath within the run's root artifactDirectory. For example, if "model/file1" and "model/file2" exist within the artifact directory, then downloadArtifacts("model") // returns a local directory containing "file1" and "file2" downloadArtifacts("model/file1") // returns a local *file* with the contents of file1. Note that this will download the entire subdirectory path, and so may be expensive if the subdirectory a lot of data.

Parameters:

artifactPath - Artifact path relative to the run's root directory. Should NOT start with a /.