From 986f01b0a9b0ac55e6050dae46eec44c608c21b6 Mon Sep 17 00:00:00 2001 From: Aaron Davidson Date: Thu, 11 Oct 2018 19:13:49 -0700 Subject: [PATCH] [Java] Add documentation on how to use extended createRun (#622) --- .../main/java/org/mlflow/tracking/MlflowClient.java | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/mlflow/java/client/src/main/java/org/mlflow/tracking/MlflowClient.java b/mlflow/java/client/src/main/java/org/mlflow/tracking/MlflowClient.java index eef1a495fb772..979a333670cf7 100644 --- a/mlflow/java/client/src/main/java/org/mlflow/tracking/MlflowClient.java +++ b/mlflow/java/client/src/main/java/org/mlflow/tracking/MlflowClient.java @@ -85,7 +85,17 @@ public RunInfo createRun(long experimentId, String appName) { } /** - * Creates a new run. + * Creates 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());
+   *
+ * * @return RunInfo created by the server */ public RunInfo createRun(CreateRun request) {