org.deeplearning4j.nn.conf.module.GraphBuilderModule 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.conf.module;
import org.deeplearning4j.nn.conf.ComputationGraphConfiguration;
public interface GraphBuilderModule {
/**
* A module should return its name. Useful for automatically generating layer names.
*
* @note Convention is to define module names that are entirely lowercase for the purpose of generating layer names.
*
* @return The module name as a string.
*/
String getModuleName();
/**
* Add a layer to the collection of layers being generated by this module.
*
* @param graph
* @param layerName
* @param inputSize
* @param config
* @param inputLayer
*
* @return An instance of GraphBuilder with appended layers.
*/
ComputationGraphConfiguration.GraphBuilder updateBuilder(ComputationGraphConfiguration.GraphBuilder graph,
String layerName, int inputSize, int[][] config, String inputLayer);
}