org.mlflow.artifacts

Class CliBasedArtifactRepository

java.lang.Object

org.mlflow.artifacts.CliBasedArtifactRepository

All Implemented Interfaces:

ArtifactRepository

public class CliBasedArtifactRepository
extends Object
implements ArtifactRepository

Shells out to the 'mlflow' command line utility to upload, download, and list artifacts. This is used as a fallback to implement any artifact repositories which are not natively supported within Java. We require that 'mlflow' is available in the system path.

Constructor Summary

Constructors

Constructor and Description
CliBasedArtifactRepository(String artifactBaseDir, String runId, MlflowHostCredsProvider hostCredsProvider)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CliBasedArtifactRepository

public CliBasedArtifactRepository(String artifactBaseDir,
                                  String runId,
                                  MlflowHostCredsProvider hostCredsProvider)

Method Detail

logArtifact

public void logArtifact(File localFile,
                        String artifactPath)

Description copied from interface: ArtifactRepository

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).

Specified by:

logArtifact in interface ArtifactRepository

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 /.

logArtifact

public void logArtifact(File localFile)

Description copied from interface: ArtifactRepository

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

Specified by:

logArtifact in interface ArtifactRepository

Parameters:

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

logArtifacts

public void logArtifacts(File localDir,
                         String artifactPath)

Description copied from interface: ArtifactRepository

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/).

Specified by:

logArtifacts in interface ArtifactRepository

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 /.

logArtifacts

public void logArtifacts(File localDir)

Description copied from interface: ArtifactRepository

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"

Specified by:

logArtifacts in interface ArtifactRepository

Parameters:

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

downloadArtifacts

public File downloadArtifacts(String artifactPath)

Description copied from interface: ArtifactRepository

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.

Specified by:

downloadArtifacts in interface ArtifactRepository

Parameters:

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

downloadArtifacts

public File downloadArtifacts()

Description copied from interface: ArtifactRepository

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.

Specified by:

downloadArtifacts in interface ArtifactRepository

listArtifacts

public List<Service.FileInfo> listArtifacts(String artifactPath)

Description copied from interface: ArtifactRepository

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.

Specified by:

listArtifacts in interface ArtifactRepository

Parameters:

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

listArtifacts

public List<Service.FileInfo> listArtifacts()

Description copied from interface: ArtifactRepository

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.

Specified by:

listArtifacts in interface ArtifactRepository