org.deeplearning4j.spark.api.TrainingHook Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of dl4j-spark3_2.12 Show documentation
The newest version!
/*
 *  ******************************************************************************
 *  *
 *  *
 *  * This program and the accompanying materials are made available under the
 *  * terms of the Apache License, Version 2.0 which is available at
 *  * https://www.apache.org/licenses/LICENSE-2.0.
 *  *
 *  *  See the NOTICE file distributed with this work for additional
 *  *  information regarding copyright ownership.
 *  * Unless required by applicable law or agreed to in writing, software
 *  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 *  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 *  * License for the specific language governing permissions and limitations
 *  * under the License.
 *  *
 *  * SPDX-License-Identifier: Apache-2.0
 *  *****************************************************************************
 */

package org.deeplearning4j.spark.api;

import org.deeplearning4j.nn.api.Model;
import org.nd4j.linalg.dataset.api.DataSet;
import org.nd4j.linalg.dataset.api.MultiDataSet;

import java.io.Serializable;

public interface TrainingHook extends Serializable {
    /**
     * A hook method for pre update.
     * @param minibatch the inibatch
     *                  that was used for the update
     * @param model themodel that was update
     */
    void preUpdate(DataSet minibatch, Model model);

    /**
     * A hook method for post update
     * @param minibatch the minibatch
     *                  that was usd for the update
     * @param model the model that was updated
     */
    void postUpdate(DataSet minibatch, Model model);

    /**
     * A hook method for pre update.
     * @param minibatch the inibatch
     *                  that was used for the update
     * @param model the model that was update
     */
    void preUpdate(MultiDataSet minibatch, Model model);

    /**
     * A hook method for post update
     * @param minibatch the minibatch
     *                  that was usd for the update
     * @param model the model that was updated
     */
    void postUpdate(MultiDataSet minibatch, Model model);

}