Merge - Multiply

Multiply

"Multiply" is constructed as a "factory" to complete the "multiply" operation. To apply the "Multiply" function, it is required that the shapes of all input layers are the same (otherwise, we can't perform the operation). The "factory" returns a merged layer instance as the output.

Factory style

layerMultiplyResult = TSP.layers.Multiply( [layer1, layer2, ...], { configs } )

The first parameter is a list of layer objects.

The second parameter is the configurations of the output merged layer object.

Fig. 1 - Multiply layer close and open

Configuration

Name Tag	Type	Instruction	Usage Notes and Examples
name	String	Name of the layer	For example, name: "layerName" In Sequential Model: Highly recommend to add a name attribute to make it easier to get Layer object from model. In Functional Model: It is required to configure name attribute for TensorSpace Layer, and the name should be the same as the name of corresponding Layer in pre-trained model.
color	Color Format	Color of layer	Multiply's default color is red #E23E57
closeButton	Dict	Close button appearance control dict. More about close button	display: Bool. true[default] Show button, false Hide button ratio: Int. Times to close button's normal size, default is 1, for example, set ratio to be 2, close button will become twice the normal size
initStatus	String	Layer initial status. Open or Close. More about Layer initial Status	close[default]: Closed at beginning, open: Open at beginning
animeTime	Int	The speed of open and close animation	For example, animeTime: 2000 means the animation time will last 2 seconds. Note: Configure animeTime in a specific layer will override model's animeTime configuration.

Properties

.outputShape : Int[]

The shape of the output tensor is 3-dimensional. 3️⃣

The dataFormat is "channel last". For example, outputShape = [ 32, 32, 4 ] represents the output through this layer has 4 feature maps and each one is 32 by 32.

After model.init() data is available, otherwise is undefined.

.neuralValue : Float[]

The intermediate raw data after this layer.

After load and model.predict(), the data are available. Otherwise is undefined.

.name : String

The customized name of this layer.

Once created, you can get it.

.layerType : String

Type of this layer, return a constant: string Multiply1d, Multiply2d, or Multiply3d. This type can identify the dimension of input layers

Once created, you can get it.

Methods

.openLayer() : void

Open Layer, if layer is already in "open" status, the layer will keep open.

See Layer Status for more details.

.closeLayer() : void

Close Layer, if layer is already in "close" status, the layer will keep close.

See Layer Status for more details.

Examples

Multiply two TensorSpace Layers, get Multiply Layer instance:

let multiplyLayer = TSP.layers.Multiply(

    [ layer1, layer2 ],

    {
        // Recommend Configuration. Required for TensorSpace Functional Model.
        name: "MultipleLayer",
        // Optional Configuration.
        animeTime: 4000,
        initStatus: "open"
    }

);

Use Case

When you add multiply operation layer with Keras | TensorFlow | tfjs in your model the corresponding API is Multiply in TensorSpace.

Framework	Documentation
Keras	keras.layers.Multiply()
TensorFlow	tf.keras.layers.multiply( inputs, **kwargs )
TensorFlow.js	tf.layers.multiply (config)

Source Code

tensorspace/src/merge/Multiply.js