org.deeplearning4j.nn.api.TrainingConfig Maven / Gradle / Ivy
/*
* ******************************************************************************
* *
* *
* * 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.nn.api;
import org.deeplearning4j.nn.conf.GradientNormalization;
import org.nd4j.linalg.api.buffer.DataType;
import org.nd4j.linalg.learning.config.IUpdater;
import org.nd4j.linalg.learning.regularization.Regularization;
import java.util.List;
public interface TrainingConfig {
/**
* @return Name of the layer
*/
String getLayerName();
/**
* Get the regularization types (l1/l2/weight decay) for the given parameter. Different parameters may have different
* regularization types.
*
* @param paramName Parameter name ("W", "b" etc)
* @return Regularization types (if any) for the specified parameter
*/
List getRegularizationByParam(String paramName);
/**
* Is the specified parameter a layerwise pretraining only parameter?
* For example, visible bias params in an autoencoder (or, decoder params in a variational autoencoder) aren't
* used during supervised backprop.
* Layers (like DenseLayer, etc) with no pretrainable parameters will return false for all (valid) inputs.
*
* @param paramName Parameter name/key
* @return True if the parameter is for layerwise pretraining only, false otherwise
*/
boolean isPretrainParam(String paramName);
/**
* Get the updater for the given parameter. Typically the same updater will be used for all updaters, but this
* is not necessarily the case
*
* @param paramName Parameter name
* @return IUpdater for the parameter
*/
IUpdater getUpdaterByParam(String paramName);
/**
* @return The gradient normalization configuration
*/
GradientNormalization getGradientNormalization();
/**
* @return The gradient normalization threshold
*/
double getGradientNormalizationThreshold();
void setDataType(DataType dataType);
}