Merge pull request #69 from comet-ml/CM-1579-log-text-type-asset

[CM-1579]: Log text type of the asset

Author: yaricom

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

@@ -24,6 +24,12 @@ interface BaseExample {
     String GRAPH_JSON_FILE = "graph.json";
     String CODE_FILE = "code_sample.py";
 
+    Map<String, Object> SOME_METADATA = new HashMap<String, Object>() {{
+        put("metaInt", 10);
+        put("metaString", "test");
+        put("metaBoolean", true);
+    }};
+
     static void generateCharts(OnlineExperiment experiment) {
         long currentStep = experiment.getStep();
 

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

@@ -71,6 +71,12 @@ private static void run(OnlineExperiment experiment) throws Exception {
         experiment.logParameter("batch_size", "500");
         experiment.logParameter("learning_rate", 12);
 
+        experiment.logText("Sample text",
+                ExperimentContext.builder()
+                        .withContext("train")
+                        .withStep(12).build(),
+                SOME_METADATA);
+
         // upload assets
         //
         experiment.uploadAsset(getResourceFile(CHART_IMAGE_FILE), "amazing chart.png", false);

comet-java-client/src/main/java/ml/comet/experiment/Experiment.java

@@ -10,6 +10,7 @@
 
 import java.io.File;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 
 /**
@@ -307,6 +308,20 @@ public interface Experiment extends AutoCloseable {
      */
     void logCode(File file);
 
+    /**
+     * Allows to log additional textual data associated with Comet Experiment.
+     * These strings appear on the Text Tab in the Comet UI.
+     *
+     * @param text     the text data to be logged.
+     * @param context  the current experiment context to be associated.
+     * @param metadata the additional metadata for the text.
+     */
+    void logText(String text, ExperimentContext context, Map<String, Object> metadata);
+
+    void logText(String text, ExperimentContext context);
+
+    void logText(String text);
+
     /**
      * Upload an asset to be associated with the experiment, for example the trained weights of a neural net.
      * For running experiment updates current step to one from param!

comet-java-client/src/main/java/ml/comet/experiment/builder/ApiExperimentBuilder.java

@@ -14,4 +14,20 @@ public interface ApiExperimentBuilder extends BaseCometBuilder<ApiExperiment> {
      * @return the builder configured with specified key of the previous experiment.
      */
     ApiExperimentBuilder withExistingExperimentKey(String experimentKey);
+
+    /**
+     * Set project name for the experiment.
+     *
+     * @param projectName The project under which the experiment should run
+     * @return the builder configured with specified project name.
+     */
+    ApiExperimentBuilder withProjectName(String projectName);
+
+    /**
+     * Set workspace for the project.
+     *
+     * @param workspace The workspace under which the experiment should be run.
+     * @return the builder configured with specified workspace name.
+     */
+    ApiExperimentBuilder withWorkspace(String workspace);
 }

comet-java-client/src/main/java/ml/comet/experiment/context/ExperimentContext.java

@@ -82,6 +82,35 @@ public void mergeFrom(@NonNull ExperimentContext other) {
         }
     }
 
+    /**
+     * Allows to check if this is empty context, i.e., has no value set.
+     *
+     * @return {@code true} if this is empty context.
+     */
+    public boolean isEmpty() {
+        return Objects.isNull(this.step) && Objects.isNull(this.epoch) && StringUtils.isBlank(this.context);
+    }
+
+    /**
+     * Indicates whether provided context object equals to this one.
+     *
+     * @param obj the instance of {@code ExperimentContext} to check.
+     * @return {@code true} if provided context object equals to this one.
+     */
+    public boolean equals(Object obj) {
+        if (Objects.isNull(obj) || !(obj instanceof ExperimentContext)) {
+            return false;
+        }
+
+        if (this == obj) {
+            return true;
+        }
+        ExperimentContext ctx = (ExperimentContext) obj;
+        return Objects.equals(this.context, ctx.context)
+                && Objects.equals(this.epoch, ctx.epoch)
+                && Objects.equals(this.step, ctx.step);
+    }
+
     /**
      * The factory to return empty {@link ExperimentContext} instance.
      *

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

@@ -18,7 +18,9 @@
 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_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;
+import static ml.comet.experiment.impl.config.CometConfig.COMET_WORKSPACE_NAME;
 import static ml.comet.experiment.impl.resources.LogMessages.EXPERIMENT_CLEANUP_PROMPT;
 import static ml.comet.experiment.impl.resources.LogMessages.getString;
 
@@ -35,8 +37,10 @@ private ApiExperimentImpl(
             final Logger logger,
             final String baseUrl,
             int maxAuthRetries,
-            final Duration cleaningTimeout) {
-        super(apiKey, baseUrl, maxAuthRetries, experimentKey, cleaningTimeout);
+            final Duration cleaningTimeout,
+            final String projectName,
+            final String workspaceName) {
+        super(apiKey, baseUrl, maxAuthRetries, experimentKey, cleaningTimeout, projectName, workspaceName);
         if (logger != null) {
             this.logger = logger;
         }
@@ -45,6 +49,8 @@ private ApiExperimentImpl(
     @Override
     void init() {
         super.init();
+
+        registerExperiment();
     }
 
     @Override
@@ -114,6 +120,8 @@ public static final class ApiExperimentBuilderImpl implements ApiExperimentBuild
         private String experimentKey;
         private String apiKey;
         private Logger logger;
+        private String projectName;
+        private String workspace;
 
         private ApiExperimentBuilderImpl() {
         }
@@ -130,6 +138,18 @@ public ApiExperimentImpl.ApiExperimentBuilderImpl withApiKey(@NonNull final Stri
             return this;
         }
 
+        @Override
+        public ApiExperimentImpl.ApiExperimentBuilderImpl withProjectName(@NonNull String projectName) {
+            this.projectName = projectName;
+            return this;
+        }
+
+        @Override
+        public ApiExperimentImpl.ApiExperimentBuilderImpl withWorkspace(@NonNull String workspace) {
+            this.workspace = workspace;
+            return this;
+        }
+
         @Override
         public ApiExperimentImpl.ApiExperimentBuilderImpl withLogger(@NonNull final Logger logger) {
             this.logger = logger;
@@ -147,11 +167,18 @@ public ApiExperiment build() {
             if (StringUtils.isBlank(this.apiKey)) {
                 this.apiKey = COMET_API_KEY.getString();
             }
+            if (StringUtils.isBlank(this.projectName)) {
+                this.projectName = COMET_PROJECT_NAME.getOptionalString().orElse(null);
+            }
+            if (StringUtils.isBlank(this.workspace)) {
+                this.workspace = COMET_WORKSPACE_NAME.getOptionalString().orElse(null);
+            }
             ApiExperimentImpl experiment = new ApiExperimentImpl(
                     this.apiKey, this.experimentKey, this.logger,
                     COMET_BASE_URL.getString(),
                     COMET_MAX_AUTH_RETRIES.getInt(),
-                    COMET_TIMEOUT_CLEANING_SECONDS.getDuration());
+                    COMET_TIMEOUT_CLEANING_SECONDS.getDuration(),
+                    this.projectName, this.workspace);
             try {
                 // initialize experiment
                 experiment.init();

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

@@ -57,13 +57,16 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
 
 import static java.util.Optional.empty;
 import static ml.comet.experiment.impl.asset.AssetType.ALL;
 import static ml.comet.experiment.impl.asset.AssetType.SOURCE_CODE;
+import static ml.comet.experiment.impl.asset.AssetType.TEXT_SAMPLE;
+import static ml.comet.experiment.impl.constants.Common.AUTOGENERATED_LOGICAL_PATH_HOLDER;
 import static ml.comet.experiment.impl.constants.SdkErrorCodes.artifactVersionStateNotClosed;
 import static ml.comet.experiment.impl.constants.SdkErrorCodes.artifactVersionStateNotClosedErrorOccurred;
 import static ml.comet.experiment.impl.constants.SdkErrorCodes.noArtifactFound;
@@ -137,14 +140,6 @@ abstract class BaseExperiment implements Experiment {
      */
     protected abstract Logger getLogger();
 
-    BaseExperiment(@NonNull final String apiKey,
-                   @NonNull final String baseUrl,
-                   int maxAuthRetries,
-                   final String experimentKey,
-                   @NonNull final Duration cleaningTimeout) {
-        this(apiKey, baseUrl, maxAuthRetries, experimentKey, cleaningTimeout, StringUtils.EMPTY, StringUtils.EMPTY);
-    }
-
     BaseExperiment(@NonNull final String apiKey,
                    @NonNull final String baseUrl,
                    int maxAuthRetries,
@@ -454,6 +449,27 @@ public void logCode(File file) {
         this.logCode(file, ExperimentContext.empty());
     }
 
+    @Override
+    public void logText(String text, ExperimentContext context, Map<String, Object> metadata) {
+        if (getLogger().isDebugEnabled()) {
+            getLogger().debug("logging text {} with context {}", text, context);
+        }
+        AssetImpl asset = createAssetFromData(text.getBytes(StandardCharsets.UTF_8),
+                AUTOGENERATED_LOGICAL_PATH_HOLDER, false,
+                Optional.ofNullable(metadata), Optional.of(TEXT_SAMPLE.type()));
+        this.logAsset(asset, context);
+    }
+
+    @Override
+    public void logText(String text, ExperimentContext context) {
+        this.logText(text, context, null);
+    }
+
+    @Override
+    public void logText(String text) {
+        this.logText(text, ExperimentContext.empty());
+    }
+
     @Override
     public void uploadAsset(@NonNull File file, @NonNull String logicalPath,
                             boolean overwrite, @NonNull ExperimentContext context) {