org.nd4j.linalg.dataset.api.preprocessor.NormalizerStrategy 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;

import org.nd4j.linalg.api.ndarray.INDArray;
import org.nd4j.linalg.dataset.api.preprocessor.stats.NormalizerStats;

import java.io.Serializable;

/**
 * Interface for strategies that can normalize and denormalize data arrays based on statistics of the population
 *
 * @author Ede Meijer
 */
public interface NormalizerStrategy extends Serializable {
    /**
     * Normalize a data array
     *
     * @param array the data to normalize
     * @param stats statistics of the data population
     */
    void preProcess(INDArray array, INDArray maskArray, S stats);

    /**
     * Denormalize a data array
     *
     * @param array the data to denormalize
     * @param stats statistics of the data population
     */
    void revert(INDArray array, INDArray maskArray, S stats);

    /**
     * Create a new {@link NormalizerStats.Builder} instance that can be used to fit new data and of the type that 
     * belongs to the current NormalizerStrategy implementation
     * 
     * @return the new builder
     */
    S.Builder newStatsBuilder();
}