ml.comet.experiment.impl.utils.CometUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of comet-java-client Show documentation
There is a newer version: 1.1.14
package ml.comet.experiment.impl.utils;

import lombok.NonNull;
import lombok.experimental.UtilityClass;
import ml.comet.experiment.context.ExperimentContext;
import org.apache.commons.lang3.StringUtils;

import java.net.URI;
import java.time.Duration;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;

import static ml.comet.experiment.impl.utils.ResourceUtils.readCometSdkVersion;

/**
 * The common Comet SDK utilities.
 */
@UtilityClass
public final class CometUtils {
    /**
     * The current version of the Comet Java SDK.
     */
    public static final String COMET_JAVA_SDK_VERSION = readCometSdkVersion();

    /**
     * Prints the current version of the Comet Java SDK.
     */
    public void printCometSdkVersion() {
        System.out.println();
        System.out.println("Comet Java SDK version: " + COMET_JAVA_SDK_VERSION);
        System.out.println();
    }

    /**
     * Creates link to the experiment at Comet.
     *
     * @param baseUrl       the server's base URL
     * @param workspaceName the name of the workspace.
     * @param projectName   the name of project
     * @param experimentKey the key of the experiment.
     * @return the link to the experiment.
     */
    public String createExperimentLink(String baseUrl, String workspaceName, String projectName, String experimentKey) {
        String url = String.format("%s/%s/%s/%s",
                baseUrl, workspaceName, projectName, experimentKey);
        // check URI syntax and return
        URI uri = URI.create(url);
        return uri.toString();
    }

    /**
     * Generates global unique identifier in format supported by Comet.ml
     *
     * @return the global unique identifier in format supported by Comet.ml.
     */
    @SuppressWarnings("checkstyle:AbbreviationAsWordInName")
    public static String generateGUID() {
        String guid = UUID.randomUUID().toString();
        return StringUtils.remove(guid, '-');
    }

    /**
     * Puts provided value into the map as string if it is not {@code null}.
     *
     * @param map   the container map.
     * @param key   the key to use.
     * @param value the optional value.
     * @param    the type of the key.
     */
    public static  void putNotNull(@NonNull Map map, @NonNull T key, Object value) {
        if (value != null) {
            map.put(key, value.toString());
        }
    }

    /**
     * Creates full name of the metric as it is returned by backend.
     *
     * @param name    the short name of the metric
     * @param context the experiment context associated with metric
     * @return the full name of the metric, which can be prefixed by context ID if present in the
     * provided {@code context} parameter.
     */
    public static String fullMetricName(@NonNull String name, @NonNull ExperimentContext context) {
        if (StringUtils.isEmpty(context.getContext())) {
            return name;
        } else {
            return String.format("%s_%s", context.getContext(), name);
        }
    }

    /**
     * Allows safe conversion of timestamp into {@link Instant}.
     *
     * @param timestamp the time in millis since epoch or {@code null}.
     * @return the instance of {@link Instant} or {@code null} if timestamp is not set.
     */
    public static Instant instantOrNull(Long timestamp) {
        if (timestamp != null) {
            return Instant.ofEpochMilli(timestamp);
        }
        return null;
    }

    /**
     * Allows safe conversion of duration in millis into {@link Duration}.
     *
     * @param durationMillis the duration in millis since epoch or {@code null}.
     * @return the instance of {@link Duration} or {@code null} if duration is not set.
     */
    public static Duration durationOrNull(Long durationMillis) {
        if (durationMillis != null) {
            return Duration.of(durationMillis, ChronoUnit.MILLIS);
        }
        return null;
    }

    /**
     * Safe conversion of list to set.
     *
     * @param list the list to be converted
     * @param   the type of the data objects in the list.
     * @return the set from provided list or empty set if list is {@code null}.
     */
    public  Set setFromList(List list) {
        if (list == null) {
            return Collections.emptySet();
        }
        return new HashSet<>(list);
    }

}