Skip to content

Commit 97e76f4

Browse files
committed
CM-1597: Updated README to show how to use new experiment builder interface.
1 parent e3756f1 commit 97e76f4

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
```
1919
#### Create experiment and log metrics and parameters:
2020
```java
21-
OnlineExperiment experiment = OnlineExperimentImpl.builder()
21+
OnlineExperiment experiment = ExperimentBuilder.OnlineExperiment()
2222
.withApiKey("someApiKey")
2323
.withProjectName("someProject")
2424
.withWorkspace("someWorkspace")
@@ -31,13 +31,13 @@ OnlineExperiment experiment = OnlineExperimentImpl.builder()
3131

3232
#### Configure you experiment object:
3333
```java
34-
#Configuration hierarchy:
35-
#Environment Variable > Configuration File Override > Default config file (application.conf)
34+
# Configuration hierarchy:
35+
Environment Variable > Configuration File Override > Default config file (application.conf)
3636

37-
#Setting configuration in code:
37+
# Setting configuration in code:
3838
OnlineExperimentImpl.builder().withApiKey("someApiKey").build();
3939

40-
#Override configuration file (can have partial keys)
40+
# Override configuration file (can have partial keys)
4141
OnlineExperimentImpl.builder().withConfig(new File("/tmp/comet.conf")).build();
4242

4343
# Read from environment variables OR from configuration file in classpath (application.conf)
@@ -55,5 +55,7 @@ COMET_MAX_AUTH_RETRIES
5555

5656
#### Examples
5757

58-
* You also can check [sample experiment](comet-examples/src/main/java/ml/comet/examples/OnlineExperimentExample.java)
58+
* You also can check
59+
* [sample experiment](comet-examples/src/main/java/ml/comet/examples/OnlineExperimentExample.java)
60+
* [MNIST classification experiment](comet-examples/src/main/java/ml/comet/examples/mnist/MnistExperimentExample.java)
5961
* For more usage examples refer to [tests](comet-java-client/src/test/java/ml/comet/experiment)

0 commit comments

Comments
 (0)