org.nd4j.linalg.dataset.api.preprocessor.stats.NormalizerStats Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of nd4j-api Show documentation

There is a newer version: 1.0.0-M2.1

package org.nd4j.linalg.dataset.api.preprocessor.stats;

import org.nd4j.linalg.api.ndarray.INDArray;

import java.io.Serializable;

/**
 * Interface for certain statistics about a population of data.
 * Can be constructed incrementally by using the Builder, which is useful for obtaining these statistics from an
 * iterator.
 *
 * @author Ede Meijer
 */
public interface NormalizerStats extends Serializable {
    interface Builder {
        Builder addFeatures(org.nd4j.linalg.dataset.api.DataSet dataSet);

        /**
         * Add the labels of a DataSet to the statistics
         */
        Builder addLabels(org.nd4j.linalg.dataset.api.DataSet dataSet);

        /**
         * Add rows of data to the statistics
         *
         * @param data the matrix containing multiple rows of data to include
         * @param mask (optionally) the mask of the data, useful for e.g. time series
         */
        Builder add(INDArray data, INDArray mask);

        /**
         * Builder pattern
         * @return
         */
        S build();
    }
}