MlflowClient (MLflow Tracking API 1.0.0 API)

java.lang.Object
- org.mlflow.tracking.MlflowClient

public class MlflowClient
extends Object

Client to an MLflow Tracking Sever.

Constructor Summary

Constructors
Constructor and Description
`MlflowClient()` Return a default client based on the MLFLOW_TRACKING_URI environment variable.
`MlflowClient(MlflowHostCredsProvider hostCredsProvider)` Create a new MlflowClient; users should prefer constructing ApiClients via `MlflowClient()` or `MlflowClient(String)` if possible.
`MlflowClient(String trackingUri)` Instantiate a new client using the provided tracking uri.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`createExperiment(String experimentName)` Create a new experiment using the default artifact location provided by the server.
`Service.RunInfo`	`createRun()` Create a new run under the default experiment with no application name.
`Service.RunInfo`	`createRun(Service.CreateRun request)` Create a new run.
`Service.RunInfo`	`createRun(String experimentId)` Create a new run under the given experiment.
`void`	`deleteExperiment(String experimentId)` Mark an experiment and associated runs, params, metrics, etc.
`void`	`deleteRun(String runId)` Delete a run with the given ID.
`File`	`downloadArtifacts(String runId)` Return a local directory containing all artifacts within the run's artifact directory.
`File`	`downloadArtifacts(String runId, String artifactPath)` Return a local file or directory containing all artifacts within the given artifactPath within the run's root artifactDirectory.
`Service.GetExperiment.Response`	`getExperiment(String experimentId)`
`Optional<Service.Experiment>`	`getExperimentByName(String experimentName)`
`List<Service.Metric>`	`getMetricHistory(String runId, String key)`
`Service.Run`	`getRun(String runId)` Get metadata, params, tags, and metrics for a run.
`List<Service.FileInfo>`	`listArtifacts(String runId)` List the artifacts immediately under the run's root artifact directory.
`List<Service.FileInfo>`	`listArtifacts(String runId, String artifactPath)` List the artifacts immediately under the given artifactPath within the run's root artifact directory.
`List<Service.Experiment>`	`listExperiments()`
`List<Service.RunInfo>`	`listRunInfos(String experimentId)`
`void`	`logArtifact(String runId, File localFile)` Upload the given local file to the run's root artifact directory.
`void`	`logArtifact(String runId, File localFile, String artifactPath)` Upload the given local file to an artifactPath within the run's root directory.
`void`	`logArtifacts(String runId, File localDir)` Upload all files within the given local directory the run's root artifact directory.
`void`	`logArtifacts(String runId, File localDir, String artifactPath)` Upload all files within the given local director an artifactPath within the run's root artifact directory.
`void`	`logBatch(String runId, Iterable<Service.Metric> metrics, Iterable<Service.Param> params, Iterable<Service.RunTag> tags)` Log multiple metrics, params, and/or tags against a given run (argument runId).
`void`	`logMetric(String runId, String key, double value)` Log a new metric against the given run, as a key-value pair.
`void`	`logMetric(String runId, String key, double value, long timestamp, long step)` Log a new metric against the given run, as a key-value pair.
`void`	`logParam(String runId, String key, String value)` Log a parameter against the given run, as a key-value pair.
`void`	`renameExperiment(String experimentId, String newName)` Update an experiment's name.
`void`	`restoreExperiment(String experimentId)` Restore an experiment marked for deletion.
`void`	`restoreRun(String runId)` Restore a deleted run with the given ID.
`List<Service.RunInfo>`	`searchRuns(List<String> experimentIds, String searchFilter)` Return runs from provided list of experiments that satisfy the search query.
`List<Service.RunInfo>`	`searchRuns(List<String> experimentIds, String searchFilter, Service.ViewType runViewType)` Return runs from provided list of experiments that satisfy the search query.
`String`	`sendGet(String path)` :: Experimental :: This API may change or be removed in a future release without warning.
`String`	`sendPost(String path, String json)` :: Experimental :: This API may change or be removed in a future release without warning.
`void`	`setTag(String runId, String key, String value)` Log a new tag against the given run, as a key-value pair.
`void`	`setTerminated(String runId)` Set the status of a run to be FINISHED at the current time.
`void`	`setTerminated(String runId, Service.RunStatus status)` Set the status of a run to be completed at the current time.
`void`	`setTerminated(String runId, Service.RunStatus status, long endTime)` Set the status of a run to be completed at the given endTime.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MlflowClient
```
public MlflowClient()
```
    Return a default client based on the MLFLOW_TRACKING_URI environment variable.
  - MlflowClient
```
public MlflowClient(String trackingUri)
```
    Instantiate a new client using the provided tracking uri.
  - MlflowClient
```
public MlflowClient(MlflowHostCredsProvider hostCredsProvider)
```
    Create a new MlflowClient; users should prefer constructing ApiClients via MlflowClient() or MlflowClient(String) if possible.
- Method Detail
  - getRun
```
public Service.Run getRun(String runId)
```
    Get metadata, params, tags, and metrics for a run. A single value is returned for each metric key: the most recently logged metric value at the largest step.
    
    Returns:
    
    Run associated with the ID.
  - getMetricHistory
```
public List<Service.Metric> getMetricHistory(String runId,
                                             String key)
```
  - createRun
```
public Service.RunInfo createRun()
```
    Create a new run under the default experiment with no application name.
    
    Returns:
    
    RunInfo created by the server.
  - createRun
```
public Service.RunInfo createRun(String experimentId)
```
    Create a new run under the given experiment.
    
    Returns:
    
    RunInfo created by the server.
  - createRun
```
public Service.RunInfo createRun(Service.CreateRun request)
```
    Create a new run. This method allows providing all possible fields of CreateRun, and can be invoked as follows:
```
   import org.mlflow.api.proto.Service.CreateRun;
   CreateRun.Builder request = CreateRun.newBuilder();
   request.setExperimentId(experimentId);
   request.setSourceVersion("my-version");
   createRun(request.build());
   
```
    Returns:
    
    RunInfo created by the server.
  - listRunInfos
```
public List<Service.RunInfo> listRunInfos(String experimentId)
```
    Returns:
    
    A list of all RunInfos associated with the given experiment.
  - searchRuns
```
public List<Service.RunInfo> searchRuns(List<String> experimentIds,
                                        String searchFilter)
```
    Return runs from provided list of experiments that satisfy the search query.
    
    Parameters:
    
    experimentIds - List of experiment IDs.
    
    searchFilter - SQL compatible search query string. Format of this query string is similar to that specified on MLflow UI. Example : "params.model = 'LogisticRegression' and metrics.acc = 0.9"
    
    Returns:
    
    A list of all RunInfos that satisfy search filter.
  - searchRuns
```
public List<Service.RunInfo> searchRuns(List<String> experimentIds,
                                        String searchFilter,
                                        Service.ViewType runViewType)
```
    Return runs from provided list of experiments that satisfy the search query.
    
    Parameters:
    
    experimentIds - List of experiment IDs.
    
    searchFilter - SQL compatible search query string. Format of this query string is similar to that specified on MLflow UI. Example : "params.model = 'LogisticRegression' and metrics.acc != 0.9"
    
    runViewType - ViewType for expected runs. One of (ACTIVE_ONLY, DELETED_ONLY, ALL) Defaults to ACTIVE_ONLY.
    
    Returns:
    
    A list of all RunInfos that satisfy search filter.
  - listExperiments
```
public List<Service.Experiment> listExperiments()
```
    Returns:
    
    A list of all experiments.
  - getExperiment
```
public Service.GetExperiment.Response getExperiment(String experimentId)
```
    Returns:
    
    An experiment with the given ID.
  - getExperimentByName
```
public Optional<Service.Experiment> getExperimentByName(String experimentName)
```
    Returns:
    
    The experiment associated with the given name or Optional.empty if none exists.
  - createExperiment
```
public String createExperiment(String experimentName)
```
    Create a new experiment using the default artifact location provided by the server.
    
    Parameters:
    
    experimentName - Name of the experiment. This must be unique across all experiments.
    
    Returns:
    
    Experiment ID of the newly created experiment.
  - deleteExperiment
```
public void deleteExperiment(String experimentId)
```
    Mark an experiment and associated runs, params, metrics, etc. for deletion.
  - restoreExperiment
```
public void restoreExperiment(String experimentId)
```
    Restore an experiment marked for deletion.
  - renameExperiment
```
public void renameExperiment(String experimentId,
                             String newName)
```
    Update an experiment's name. The new name must be unique.
  - deleteRun
```
public void deleteRun(String runId)
```
    Delete a run with the given ID.
  - restoreRun
```
public void restoreRun(String runId)
```
    Restore a deleted run with the given ID.
  - logParam
```
public void logParam(String runId,
                     String key,
                     String value)
```
    Log a parameter against the given run, as a key-value pair. This cannot be called against the same parameter key more than once.
  - logMetric
```
public void logMetric(String runId,
                      String key,
                      double value)
```
    Log a new metric against the given run, as a key-value pair. Metrics are recorded against two axes: timestamp and step. This method uses the number of milliseconds since the Unix epoch for the timestamp, and it uses the default step of zero.
    
    Parameters:
    
    runId - The ID of the run in which to record the metric.
    
    key - The key identifying the metric for which to record the specified value.
    
    value - The value of the metric.
  - logMetric
```
public void logMetric(String runId,
                      String key,
                      double value,
                      long timestamp,
                      long step)
```
    Log a new metric against the given run, as a key-value pair. Metrics are recorded against two axes: timestamp and step.
    
    Parameters:
    
    runId - The ID of the run in which to record the metric.
    
    key - The key identifying the metric for which to record the specified value.
    
    value - The value of the metric.
    
    timestamp - The timestamp at which to record the metric value.
    
    step - The step at which to record the metric value.
  - setTag
```
public void setTag(String runId,
                   String key,
                   String value)
```
    Log a new tag against the given run, as a key-value pair.
  - logBatch
```
public void logBatch(String runId,
                     Iterable<Service.Metric> metrics,
                     Iterable<Service.Param> params,
                     Iterable<Service.RunTag> tags)
```
    Log multiple metrics, params, and/or tags against a given run (argument runId). Argument metrics, params, and tag iterables can be nulls.
  - setTerminated
```
public void setTerminated(String runId)
```
    Set the status of a run to be FINISHED at the current time.
  - setTerminated
```
public void setTerminated(String runId,
                          Service.RunStatus status)
```
    Set the status of a run to be completed at the current time.
  - setTerminated
```
public void setTerminated(String runId,
                          Service.RunStatus status,
                          long endTime)
```
    Set the status of a run to be completed at the given endTime.
  - sendGet
```
public String sendGet(String path)
```
    :: Experimental :: This API may change or be removed in a future release without warning. Send a GET to the following path, including query parameters. This is mostly an internal API, but allows making lower-level or unsupported requests.
    
    Returns:
    
    JSON response from the server.
  - sendPost
```
public String sendPost(String path,
                       String json)
```
    :: Experimental :: This API may change or be removed in a future release without warning. Send a POST to the following path, with a String-encoded JSON body. This is mostly an internal API, but allows making lower-level or unsupported requests.
    
    Returns:
    
    JSON response from the server.
  - logArtifact
```
public void logArtifact(String runId,
                        File localFile)
```
    Upload the given local file to the run's root artifact directory. For example,
```
   logArtifact(runId, "/my/localModel")
   listArtifacts(runId) // returns "localModel"
   
```
    Parameters:
    
    runId - Run ID of an existing MLflow run.
    
    localFile - File to upload. Must exist, and must be a simple file (not a directory).
  - logArtifact
```
public void logArtifact(String runId,
                        File localFile,
                        String artifactPath)
```
    Upload the given local file to an artifactPath within the run's root directory. For example,
```
   logArtifact(runId, "/my/localModel", "model")
   listArtifacts(runId, "model") // returns "model/localModel"
   
```
    (i.e., the localModel file is now available in model/localModel).
    Parameters:
    
    runId - Run ID of an existing MLflow run.
    
    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
```
public void logArtifacts(String runId,
                         File localDir)
```
    Upload all files within the given local directory the run's root artifact directory. For example, if /my/local/dir/ contains two files "file1" and "file2", then
```
   logArtifacts(runId, "/my/local/dir")
   listArtifacts(runId) // returns "file1" and "file2"
   
```
    Parameters:
    
    runId - Run ID of an existing MLflow run.
    
    localDir - Directory to upload. Must exist, and must be a directory (not a simple file).
  - logArtifacts
```
public void logArtifacts(String runId,
                         File localDir,
                         String artifactPath)
```
    Upload 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(runId, "/my/local/dir", "model")
   listArtifacts(runId, "model") // returns "model/file1" and "model/file2"
   
```
    (i.e., the contents of the local directory are now available in model/).
    Parameters:
    
    runId - Run ID of an existing MLflow run.
    
    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
```
public List<Service.FileInfo> listArtifacts(String runId)
```
    List 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.
    
    Parameters:
    
    runId - Run ID of an existing MLflow run.
  - listArtifacts
```
public List<Service.FileInfo> listArtifacts(String runId,
                                            String artifactPath)
```
    List the artifacts immediately under the given artifactPath within 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.
    
    Parameters:
    
    runId - Run ID of an existing MLflow run.
    
    artifactPath - Artifact path relative to the run's root directory. Should NOT start with a /.
  - downloadArtifacts
```
public File downloadArtifacts(String runId)
```
    Return 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 has a lot of data.
    
    Parameters:
    
    runId - Run ID of an existing MLflow run.
  - downloadArtifacts
```
public File downloadArtifacts(String runId,
                              String artifactPath)
```
    Return 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(runId, "model") // returns a local directory containing "file1" and "file2"
   downloadArtifacts(runId, "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 has a lot of data.
    Parameters:
    
    runId - Run ID of an existing MLflow run.
    
    artifactPath - Artifact path relative to the run's root directory. Should NOT start with a /.

Class MlflowClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MlflowClient

MlflowClient

MlflowClient

Method Detail

getRun

getMetricHistory

createRun

createRun

createRun

listRunInfos

searchRuns

searchRuns

listExperiments

getExperiment

getExperimentByName

createExperiment

deleteExperiment

restoreExperiment

renameExperiment

deleteRun

restoreRun

logParam

logMetric

logMetric

setTag

logBatch

setTerminated

setTerminated

setTerminated

sendGet

sendPost

logArtifact

logArtifact

logArtifacts

logArtifacts

listArtifacts

listArtifacts

downloadArtifacts

downloadArtifacts