Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from Oct 12, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -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) {
Expand Down