CM-4552: Implemented example to run existing Comet experiment with COMET_EXPERIMENT_KEY 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);