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

import java.io.File;
import java.io.IOException;

public interface OnlineExperiment extends Experiment {

    /**
     * Tells Comet that the Experiment is complete.
     */
    void end();

    /**
     * Turn on intercept of stdout and stderr and the logging of both in Comet
     * @throws IOException
     */
    void setInterceptStdout() throws IOException;

    /**
     * Turn off intercept of stdout and stderr and turns off their logging in Comet
     */
    void stopInterceptStdout();

    /**
     * Send logs to Comet.
     * @param line Text to be logged
     * @param offset Offset describes the place for current text to be inserted
     * @param stderr
     */
    void logLine(String line, long offset, boolean stderr);

    /**
     * Sets the current step for the experiment.  This is used when logging metrics and params
     */
    void setStep(long step);

    /**
     * Increments the step that the experiment is on
     */
    void nextStep();

    /**
     * Gets the current step as recorded by the Experiment object locally
     * @return
     */
    long getStep();

    /**
     * Sets the context for any logs and uploaded files
     */
    void setContext(String context);

    /**
     * Gets the current context as recorded in the Experiment object locally
     * @return
     */
    String getContext();

    /**
     * Logs a metric with Comet under the current experiment step.  Metrics are generally values that change from step to step
     * @param metricName The name for the metric to be logged
     * @param metricValue The new value for the metric.  If the values for a metric are plottable we will plot them
     */
    void logMetric(String metricName, Object metricValue);


    /**
     * Logs a param with Comet under the current experiment step.  Params should be set at the start of the experiment
     * @param parameterName The name of the param being logged
     * @param paramValue The value for the param being logged
     */
    void logParameter(String parameterName, Object paramValue);

    /**
     * Upload an asset under the current experiment step to be associated with the experiment, for example the trained weights of a neural net
     * @param asset The asset to be stored
     * @param fileName The file name under which the asset should be stored in Comet. E.g. "someFile.txt"
     * @param overwrite Whether to overwrite files of the same name in Comet
     */
    void uploadAsset(File asset, String fileName, boolean overwrite);
    void uploadAsset(File asset, boolean overwrite);
}