ExperimentsAPI (databricks-sdk-java 0.5.0 API)

java.lang.Object
- com.databricks.sdk.service.ml.ExperimentsAPI

```
@Generated
public class ExperimentsAPI
extends Object
```
Experiments are the primary unit of organization in MLflow; all MLflow runs belong to an experiment. Each experiment lets you visualize, search, and compare runs, as well as download run artifacts or metadata for analysis in other tools. Experiments are maintained in a Databricks hosted MLflow tracking server.
Experiments are located in the workspace file tree. You manage experiments using the same tools you use to manage other workspace objects such as folders, notebooks, and libraries.

Constructor Summary

Constructors
Constructor and Description

ExperimentsAPI(ApiClient apiClient)
Regular-use constructor

ExperimentsAPI(ExperimentsService mock)
Constructor for mocks

Constructors
Constructor and Description
`ExperimentsAPI(ApiClient apiClient)` Regular-use constructor
`ExperimentsAPI(ExperimentsService mock)` Constructor for mocks

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateExperimentResponse`	`createExperiment(CreateExperiment request)` Create experiment.
`CreateExperimentResponse`	`createExperiment(String name)`
`CreateRunResponse`	`createRun(CreateRun request)` Create a run.
`void`	`deleteExperiment(DeleteExperiment request)` Delete an experiment.
`void`	`deleteExperiment(String experimentId)`
`void`	`deleteRun(DeleteRun request)` Delete a run.
`void`	`deleteRun(String runId)`
`void`	`deleteTag(DeleteTag request)` Delete a tag.
`void`	`deleteTag(String runId, String key)`
`GetExperimentByNameResponse`	`getByName(GetByNameRequest request)` Get metadata.
`GetExperimentByNameResponse`	`getByName(String experimentName)`
`Experiment`	`getExperiment(GetExperimentRequest request)` Get an experiment.
`Experiment`	`getExperiment(String experimentId)`
`GetExperimentPermissionLevelsResponse`	`getExperimentPermissionLevels(GetExperimentPermissionLevelsRequest request)` Get experiment permission levels.
`GetExperimentPermissionLevelsResponse`	`getExperimentPermissionLevels(String experimentId)`
`ExperimentPermissions`	`getExperimentPermissions(GetExperimentPermissionsRequest request)` Get experiment permissions.
`ExperimentPermissions`	`getExperimentPermissions(String experimentId)`
`GetMetricHistoryResponse`	`getHistory(GetHistoryRequest request)` Get history of a given metric within a run.
`GetMetricHistoryResponse`	`getHistory(String metricKey)`
`GetRunResponse`	`getRun(GetRunRequest request)` Get a run.
`GetRunResponse`	`getRun(String runId)`
`ExperimentsService`	`impl()`
`Iterable<FileInfo>`	`listArtifacts(ListArtifactsRequest request)` Get all artifacts.
`Iterable<Experiment>`	`listExperiments(ListExperimentsRequest request)` List experiments.
`void`	`logBatch(LogBatch request)` Log a batch.
`void`	`logInputs(LogInputs request)` Log inputs to a run.
`void`	`logMetric(LogMetric request)` Log a metric.
`void`	`logMetric(String key, float value, long timestamp)`
`void`	`logModel(LogModel request)` Log a model.
`void`	`logParam(LogParam request)` Log a param.
`void`	`logParam(String key, String value)`
`void`	`restoreExperiment(RestoreExperiment request)` Restores an experiment.
`void`	`restoreExperiment(String experimentId)`
`void`	`restoreRun(RestoreRun request)` Restore a run.
`void`	`restoreRun(String runId)`
`Iterable<Experiment>`	`searchExperiments(SearchExperiments request)` Search experiments.
`Iterable<Run>`	`searchRuns(SearchRuns request)` Search for runs.
`ExperimentPermissions`	`setExperimentPermissions(ExperimentPermissionsRequest request)` Set experiment permissions.
`ExperimentPermissions`	`setExperimentPermissions(String experimentId)`
`void`	`setExperimentTag(SetExperimentTag request)` Set a tag.
`void`	`setExperimentTag(String experimentId, String key, String value)`
`void`	`setTag(SetTag request)` Set a tag.
`void`	`setTag(String key, String value)`
`void`	`updateExperiment(String experimentId)`
`void`	`updateExperiment(UpdateExperiment request)` Update an experiment.
`ExperimentPermissions`	`updateExperimentPermissions(ExperimentPermissionsRequest request)` Update experiment permissions.
`ExperimentPermissions`	`updateExperimentPermissions(String experimentId)`
`UpdateRunResponse`	`updateRun(UpdateRun request)` Update a run.

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

- Constructor Detail
  - ExperimentsAPI
```
public ExperimentsAPI(ApiClient apiClient)
```
    Regular-use constructor
  - ExperimentsAPI
```
public ExperimentsAPI(ExperimentsService mock)
```
    Constructor for mocks
- Method Detail
  - createExperiment
```
public CreateExperimentResponse createExperiment(String name)
```
  - createExperiment
```
public CreateExperimentResponse createExperiment(CreateExperiment request)
```
    Create experiment.
    Creates an experiment with a name. Returns the ID of the newly created experiment. Validates that another experiment with the same name does not already exist and fails if another experiment with the same name already exists.
    Throws `RESOURCE_ALREADY_EXISTS` if a experiment with the given name exists.
  - createRun
```
public CreateRunResponse createRun(CreateRun request)
```
    Create a run.
    Creates a new run within an experiment. A run is usually a single execution of a machine learning or data ETL pipeline. MLflow uses runs to track the `mlflowParam`, `mlflowMetric` and `mlflowRunTag` associated with a single execution.
  - deleteExperiment
```
public void deleteExperiment(String experimentId)
```
  - deleteExperiment
```
public void deleteExperiment(DeleteExperiment request)
```
    Delete an experiment.
    Marks an experiment and associated metadata, runs, metrics, params, and tags for deletion. If the experiment uses FileStore, artifacts associated with experiment are also deleted.
  - deleteRun
```
public void deleteRun(String runId)
```
  - deleteRun
```
public void deleteRun(DeleteRun request)
```
    Delete a run.
    Marks a run for deletion.
  - deleteTag
```
public void deleteTag(String runId,
                      String key)
```
  - deleteTag
```
public void deleteTag(DeleteTag request)
```
    Delete a tag.
    Deletes a tag on a run. Tags are run metadata that can be updated during a run and after a run completes.
  - getByName
```
public GetExperimentByNameResponse getByName(String experimentName)
```
  - getByName
```
public GetExperimentByNameResponse getByName(GetByNameRequest request)
```
    Get metadata.
    Gets metadata for an experiment.
    This endpoint will return deleted experiments, but prefers the active experiment if an active and deleted experiment share the same name. If multiple deleted experiments share the same name, the API will return one of them.
    Throws `RESOURCE_DOES_NOT_EXIST` if no experiment with the specified name exists.
  - getExperiment
```
public Experiment getExperiment(String experimentId)
```
  - getExperiment
```
public Experiment getExperiment(GetExperimentRequest request)
```
    Get an experiment.
    Gets metadata for an experiment. This method works on deleted experiments.
  - getExperimentPermissionLevels
```
public GetExperimentPermissionLevelsResponse getExperimentPermissionLevels(String experimentId)
```
  - getExperimentPermissionLevels
```
public GetExperimentPermissionLevelsResponse getExperimentPermissionLevels(GetExperimentPermissionLevelsRequest request)
```
    Get experiment permission levels.
    Gets the permission levels that a user can have on an object.
  - getExperimentPermissions
```
public ExperimentPermissions getExperimentPermissions(String experimentId)
```
  - getExperimentPermissions
```
public ExperimentPermissions getExperimentPermissions(GetExperimentPermissionsRequest request)
```
    Get experiment permissions.
    Gets the permissions of an experiment. Experiments can inherit permissions from their root object.
  - getHistory
```
public GetMetricHistoryResponse getHistory(String metricKey)
```
  - getHistory
```
public GetMetricHistoryResponse getHistory(GetHistoryRequest request)
```
    Get history of a given metric within a run.
    Gets a list of all values for the specified metric for a given run.
  - getRun
```
public GetRunResponse getRun(String runId)
```
  - getRun
```
public GetRunResponse getRun(GetRunRequest request)
```
    Get a run.
    Gets the metadata, metrics, params, and tags for a run. In the case where multiple metrics with the same key are logged for a run, return only the value with the latest timestamp.
    If there are multiple values with the latest timestamp, return the maximum of these values.
  - listArtifacts
```
public Iterable<FileInfo> listArtifacts(ListArtifactsRequest request)
```
    Get all artifacts.
    List artifacts for a run. Takes an optional `artifact_path` prefix. If it is specified, the response contains only artifacts with the specified prefix.",
  - listExperiments
```
public Iterable<Experiment> listExperiments(ListExperimentsRequest request)
```
    List experiments.
    Gets a list of all experiments.
  - logBatch
```
public void logBatch(LogBatch request)
```
    Log a batch.
    Logs a batch of metrics, params, and tags for a run. If any data failed to be persisted, the server will respond with an error (non-200 status code).
    In case of error (due to internal server error or an invalid request), partial data may be written.
    You can write metrics, params, and tags in interleaving fashion, but within a given entity type are guaranteed to follow the order specified in the request body.
    The overwrite behavior for metrics, params, and tags is as follows:
    * Metrics: metric values are never overwritten. Logging a metric (key, value, timestamp) appends to the set of values for the metric with the provided key.
    * Tags: tag values can be overwritten by successive writes to the same tag key. That is, if multiple tag values with the same key are provided in the same API request, the last-provided tag value is written. Logging the same tag (key, value) is permitted. Specifically, logging a tag is idempotent.
    * Parameters: once written, param values cannot be changed (attempting to overwrite a param value will result in an error). However, logging the same param (key, value) is permitted. Specifically, logging a param is idempotent.
    Request Limits ------------------------------- A single JSON-serialized API request may be up to 1 MB in size and contain:
    * No more than 1000 metrics, params, and tags in total * Up to 1000 metrics * Up to 100 params * Up to 100 tags
    For example, a valid request might contain 900 metrics, 50 params, and 50 tags, but logging 900 metrics, 50 params, and 51 tags is invalid.
    The following limits also apply to metric, param, and tag keys and values:
    * Metric keys, param keys, and tag keys can be up to 250 characters in length * Parameter and tag values can be up to 250 characters in length
  - logInputs
```
public void logInputs(LogInputs request)
```
    Log inputs to a run.
    **NOTE:** Experimental: This API may change or be removed in a future release without warning.
  - logMetric
```
public void logMetric(String key,
                      float value,
                      long timestamp)
```
  - logMetric
```
public void logMetric(LogMetric request)
```
    Log a metric.
    Logs a metric for a run. A metric is a key-value pair (string key, float value) with an associated timestamp. Examples include the various metrics that represent ML model accuracy. A metric can be logged multiple times.
  - logModel
```
public void logModel(LogModel request)
```
    Log a model.
    **NOTE:** Experimental: This API may change or be removed in a future release without warning.
  - logParam
```
public void logParam(String key,
                     String value)
```
  - logParam
```
public void logParam(LogParam request)
```
    Log a param.
    Logs a param used for a run. A param is a key-value pair (string key, string value). Examples include hyperparameters used for ML model training and constant dates and values used in an ETL pipeline. A param can be logged only once for a run.
  - restoreExperiment
```
public void restoreExperiment(String experimentId)
```
  - restoreExperiment
```
public void restoreExperiment(RestoreExperiment request)
```
    Restores an experiment.
    Restore an experiment marked for deletion. This also restores associated metadata, runs, metrics, params, and tags. If experiment uses FileStore, underlying artifacts associated with experiment are also restored.
    Throws `RESOURCE_DOES_NOT_EXIST` if experiment was never created or was permanently deleted.
  - restoreRun
```
public void restoreRun(String runId)
```
  - restoreRun
```
public void restoreRun(RestoreRun request)
```
    Restore a run.
    Restores a deleted run.
  - searchExperiments
```
public Iterable<Experiment> searchExperiments(SearchExperiments request)
```
    Search experiments.
    Searches for experiments that satisfy specified search criteria.
  - searchRuns
```
public Iterable<Run> searchRuns(SearchRuns request)
```
    Search for runs.
    Searches for runs that satisfy expressions.
    Search expressions can use `mlflowMetric` and `mlflowParam` keys.",
  - setExperimentPermissions
```
public ExperimentPermissions setExperimentPermissions(String experimentId)
```
  - setExperimentPermissions
```
public ExperimentPermissions setExperimentPermissions(ExperimentPermissionsRequest request)
```
    Set experiment permissions.
    Sets permissions on an experiment. Experiments can inherit permissions from their root object.
  - setExperimentTag
```
public void setExperimentTag(String experimentId,
                             String key,
                             String value)
```
  - setExperimentTag
```
public void setExperimentTag(SetExperimentTag request)
```
    Set a tag.
    Sets a tag on an experiment. Experiment tags are metadata that can be updated.
  - setTag
```
public void setTag(String key,
                   String value)
```
  - setTag
```
public void setTag(SetTag request)
```
    Set a tag.
    Sets a tag on a run. Tags are run metadata that can be updated during a run and after a run completes.
  - updateExperiment
```
public void updateExperiment(String experimentId)
```
  - updateExperiment
```
public void updateExperiment(UpdateExperiment request)
```
    Update an experiment.
    Updates experiment metadata.
  - updateExperimentPermissions
```
public ExperimentPermissions updateExperimentPermissions(String experimentId)
```
  - updateExperimentPermissions
```
public ExperimentPermissions updateExperimentPermissions(ExperimentPermissionsRequest request)
```
    Update experiment permissions.
    Updates the permissions on an experiment. Experiments can inherit permissions from their root object.
  - updateRun
```
public UpdateRunResponse updateRun(UpdateRun request)
```
    Update a run.
    Updates run metadata.
  - impl
```
public ExperimentsService impl()
```

Class ExperimentsAPI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExperimentsAPI

ExperimentsAPI

Method Detail

createExperiment

createExperiment

createRun

deleteExperiment

deleteExperiment

deleteRun

deleteRun

deleteTag

deleteTag

getByName

getByName

getExperiment

getExperiment

getExperimentPermissionLevels

getExperimentPermissionLevels

getExperimentPermissions

getExperimentPermissions

getHistory

getHistory

getRun

getRun

listArtifacts

listExperiments

logBatch

logInputs

logMetric

logMetric

logModel

logParam

logParam

restoreExperiment

restoreExperiment

restoreRun

restoreRun

searchExperiments

searchRuns

setExperimentPermissions

setExperimentPermissions

setExperimentTag

setExperimentTag

setTag

setTag

updateExperiment

updateExperiment

updateExperimentPermissions

updateExperimentPermissions

updateRun

impl