Merge pull request #72 from comet-ml/CM-4552-COMET_EXPERIMENT_KEY

[CM-4552]: Allow COMET_EXPERIMENT_KEY as environment variable

Author: yaricom

comet-examples/src/main/java/ml/comet/examples/BaseExample.java

@@ -11,6 +11,7 @@
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Random;
 
 import static java.lang.Math.log;
 import static ml.comet.examples.Utils.getResourceFile;
@@ -35,17 +36,24 @@ interface BaseExample {
 
     static void generateCharts(OnlineExperiment experiment) {
         long currentStep = experiment.getStep();
+        Random rd = new Random();
 
         for (int i = 1; i < 15; i++) {
-            experiment.logMetric("numMetric", 123 + i, currentStep + i, getUpdatedEpochValue(experiment));
+            int value = (int) (Math.sin(i) * 20.0);
+            experiment.logMetric("numMetricChart", value,
+                    currentStep + i, getUpdatedEpochValue(experiment));
         }
 
         for (int i = 1; i < 15; i++) {
-            experiment.logMetric("strMetric", "123" + i, currentStep + i, getUpdatedEpochValue(experiment));
+            float value = rd.nextFloat() * 100;
+            experiment.logMetric("strMetricChart", String.valueOf(value),
+                    currentStep + i, getUpdatedEpochValue(experiment));
         }
 
         for (int i = 1; i < 15; i++) {
-            experiment.logMetric("doubleMetric", 123.12d + i, currentStep + i, getUpdatedEpochValue(experiment));
+            double value = Math.cos(i);
+            experiment.logMetric("doubleMetricChart", 123.12d + value,
+                    currentStep + i, getUpdatedEpochValue(experiment));
         }
     }
 

comet-examples/src/main/java/ml/comet/examples/ExistingExperimentExample.java

@@ -0,0 +1,54 @@
+package ml.comet.examples;
+
+import ml.comet.experiment.ExperimentBuilder;
+import ml.comet.experiment.OnlineExperiment;
+import ml.comet.experiment.impl.config.CometConfig;
+
+import java.util.Objects;
+import java.util.Random;
+import java.util.UUID;
+
+/**
+ * Provides variety of examples of updating existing Comet experiment.
+ *
+ * <p>To run from command line execute the following at the root of this module:
+ * <pre>
+ * COMET_API_KEY=your_api_key \
+ * COMET_EXPERIMENT_KEY=existing_experiment_key
+ * mvn exec:java -Dexec.mainClass="ml.comet.examples.ExistingExperimentExample"
+ * </pre>
+ * Make sure to provide correct values above.
+ */
+public class ExistingExperimentExample {
+
+    /**
+     * The main entry point to the example.
+     *
+     * @param args the command line arguments if any.
+     */
+    public static void main(String[] args) throws Exception {
+        // check that COMET_EXPERIMENT_KEY environment variable is set
+        if (Objects.isNull(System.getenv(CometConfig.COMET_EXPERIMENT_KEY.getEnvironmentKey()))) {
+            System.err.println("To run this experiment you should set COMET_EXPERIMENT_KEY environment variable "
+                    + "with ID of existing Comet experiment."
+            );
+            System.exit(1);
+        }
+
+        try (OnlineExperiment experiment = ExperimentBuilder.OnlineExperiment().build()) {
+            runExample(experiment);
+        }
+    }
+
+    private static void runExample(OnlineExperiment experiment) {
+        // log some continuous data
+        Random rd = new Random();
+        String metricName = UUID.randomUUID().toString();
+        for (int i = 0; i < 100; i++) {
+            experiment.logMetric(metricName, rd.nextDouble() * 20, i);
+        }
+
+        // log single metric value
+        experiment.logMetric(metricName, 20, 100);
+    }
+}

comet-examples/src/main/java/ml/comet/examples/OnlineExperimentExample.java

@@ -56,10 +56,10 @@ private static void run(OnlineExperiment experiment) throws Exception {
         experiment.nextStep();
 
         //metric can be a number, string , or double
-        experiment.logMetric("strMetric", "123");
+        experiment.logMetric("strMetric", "123", 1);
         experiment.logMetric("numMetric", 123, 123, 4);
         experiment.nextEpoch();
-        experiment.logMetric("doubleMetric", 123.5d);
+        experiment.logMetric("doubleMetric", 123.5d, 1);
 
         experiment.setEpoch(3);
 

comet-java-client/src/main/java/ml/comet/experiment/exception/CometGeneralException.java

@@ -26,8 +26,9 @@ public CometGeneralException(String message) {
 
     /**
      * Constructs a new runtime exception with the specified detail message and
-     * cause.  <p>Note that the detail message associated with
-     * {@code cause} is <i>not</i> automatically incorporated in
+     * cause.
+     *
+     * <p>Note that the detail message associated with {@code cause} is <i>not</i> automatically incorporated in
      * this runtime exception's detail message.
      *
      * @param message the detail message (which is saved for later retrieval

comet-java-client/src/main/java/ml/comet/experiment/impl/ApiExperimentImpl.java

@@ -17,6 +17,7 @@
 
 import static ml.comet.experiment.impl.config.CometConfig.COMET_API_KEY;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_BASE_URL;
+import static ml.comet.experiment.impl.config.CometConfig.COMET_EXPERIMENT_KEY;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_MAX_AUTH_RETRIES;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_PROJECT_NAME;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_TIMEOUT_CLEANING_SECONDS;
@@ -173,6 +174,9 @@ public ApiExperiment build() {
             if (StringUtils.isBlank(this.workspace)) {
                 this.workspace = COMET_WORKSPACE_NAME.getOptionalString().orElse(null);
             }
+            if (StringUtils.isBlank(this.experimentKey)) {
+                this.experimentKey = COMET_EXPERIMENT_KEY.getOptionalString().orElse(null);
+            }
             ApiExperimentImpl experiment = new ApiExperimentImpl(
                     this.apiKey, this.experimentKey, this.logger,
                     COMET_BASE_URL.getString(),

comet-java-client/src/main/java/ml/comet/experiment/impl/OnlineExperimentBuilderImpl.java

@@ -11,6 +11,7 @@
 
 import static ml.comet.experiment.impl.config.CometConfig.COMET_API_KEY;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_BASE_URL;
+import static ml.comet.experiment.impl.config.CometConfig.COMET_EXPERIMENT_KEY;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_MAX_AUTH_RETRIES;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_PROJECT_NAME;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_TIMEOUT_CLEANING_SECONDS;
@@ -111,6 +112,9 @@ public OnlineExperimentImpl build() {
         if (StringUtils.isBlank(this.baseUrl)) {
             this.baseUrl = COMET_BASE_URL.getString();
         }
+        if (StringUtils.isBlank(this.experimentKey)) {
+            this.experimentKey = COMET_EXPERIMENT_KEY.getOptionalString().orElse(null);
+        }
         if (this.maxAuthRetries == -1) {
             this.maxAuthRetries = COMET_MAX_AUTH_RETRIES.getInt();
         }

comet-java-client/src/main/java/ml/comet/experiment/impl/config/CometConfig.java

@@ -50,6 +50,11 @@ public final class CometConfig {
      */
     public static final ConfigItem COMET_PROJECT_NAME =
             new ConfigItem("project", "COMET_PROJECT_NAME", instance);
+    /**
+     * The key of the existing Comet experiment.
+     */
+    public static final ConfigItem COMET_EXPERIMENT_KEY =
+            new ConfigItem("experimentKey", "COMET_EXPERIMENT_KEY", instance);
     /**
      * The Comet workspace name.
      */

comet-java-client/src/test/java/ml/comet/experiment/impl/config/CometConfigTest.java

@@ -125,4 +125,18 @@ public void testClearOverrideConfig() {
         assertNotNull(timeout);
         assertEquals(timeout.getSeconds(), 3600);
     }
+
+    @Test
+    public void testReadAllConfigVariables() {
+        CometConfig.applyConfigOverride(fullCometConfig);
+        String defaultStringValue = "full";
+
+        assertEquals(defaultStringValue, CometConfig.COMET_API_KEY.getString());
+        assertEquals(defaultStringValue, CometConfig.COMET_PROJECT_NAME.getString());
+        assertEquals(defaultStringValue, CometConfig.COMET_EXPERIMENT_KEY.getString());
+        assertEquals(defaultStringValue, CometConfig.COMET_WORKSPACE_NAME.getString());
+        assertEquals("https://www.comet.ml", CometConfig.COMET_BASE_URL.getString());
+        assertEquals(5, CometConfig.COMET_MAX_AUTH_RETRIES.getInt());
+        assertEquals(60, CometConfig.COMET_TIMEOUT_CLEANING_SECONDS.getInt());
+    }
 }

comet-java-client/src/test/resources/full-comet-config.conf

@@ -4,5 +4,6 @@ comet {
     apiKey = "full"
     project = "full"
     workspace = "full"
+    experimentKey = "full"
     cleaningTimeoutSeconds = 60
 }