[Java] Add documentation on how to use extended createRun (#622)

mlflow · Oct 12, 2018 · 986f01b · 986f01b
1 parent 966ce4a
commit 986f01b
Showing 1 changed file with 11 additions and 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
@@ -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:
+   *
+   *   <pre>
+   *   import org.mlflow.api.proto.Service.CreateRun;
+   *   CreateRun.Builder request = CreateRun.newBuilder();
+   *   request.setExperimentId(experimentId);
+   *   request.setSourceVersion("my-version");
+   *   createRun(request.build());
+   *   </pre>
+   *
    * @return RunInfo created by the server
    */
   public RunInfo createRun(CreateRun request) {