ml.comet.experiment.asset.Asset 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.asset;

import ml.comet.experiment.context.ExperimentContext;

import java.io.File;
import java.util.Map;
import java.util.Optional;

/**
 * Defines public contract of the assets associated with particular Comet experiment.
 */
public interface Asset {
    /**
     * Returns the logical file path for this asset.
     *
     * @return the logical file path for this asset.
     */
    String getLogicalPath();

    /**
     * Returns the type of this asset.
     *
     * @return the type of this asset.
     */
    String getType();

    /**
     * Returns metadata associated with this asset or {@link Map} if there is no metadata.
     *
     * @return the metadata associated with this asset or empty {@link Map} if there is no metadata.
     */
    Map getMetadata();

    /**
     * Returns the optional asset's file.
     *
     * @return the optional asset's file.
     */
    Optional getFile();

    /**
     * Returns the optional asset's data array.
     *
     * @return the optional asset's data array.
     */
    Optional getFileLikeData();

    /**
     * Returns the optional {@link ExperimentContext} associated with this asset.
     *
     * @return the {@link ExperimentContext} associated with this asset.
     */
    Optional getExperimentContext();
}