Layer - Layer3d

Layer3d

Use this Layer when the API you are using cannot be found in the TensorSpace support list.

Create an abstract layer. You need to maintain the shape is the same as the shape of the data in the layer in your model. For example, 1-dimensional [100], use Layer1d API; 2-dimensional [100, 100], use Layer2d API; 3-dimensional [100, 100, 3]. dataFormat is channel last, use Layer3d API.

⭐Abstract Layer, user can directly defined shape of the layer, but will not show any relation lines. Please submit Issue, we will support the corresponding API as soon as possible.️

Constructor

Two methods to create a new layer. Arguments are required.

〔Method 1〕Use shape

TSP.layers.Layer3d( { shape: [ Int, Int, Int ] } );

Arguments

Name Tag	Type	Instruction	Usage Notes and Examples
shape ⭐📦️	Int[]	shape of output	shape=[100, 100, 3] means the output is 3-dimensional array by 100*100 with 3 feature maps
name 🔧	String	Name of this layer. Highly recommend to arrange to make code more readable.	name: "layerName"
color ⚙️🎨️	color format	Color of layer	Layer3d default is #f08a5d
closeButton ⚙️🎨️	Dict	Close button appearance control dict, more about close button	display : Boolean. true[default] Show button, false Hide button ratio : Int. Times to normal size, default is 1 For example, 2 means twice the normal size
initStatus ⚙️️🎦	String	Layer status at beginning. Open or Close	close[default] : Closed at beginning
animation- TimeRatio ⚙️🎦️	Int	The speed of open and close animation	Integer for multiple of speed. For example, 2 for 2 times of basic speed.

Properties

.inputShape : Int[]

The shape of input tensor, for example inputShape = [ 28, 28, 3 ] represents 3 feature maps and each one is 28 by 28.

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

.outputShape : Int[]

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

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 : Int[]

The intermediate raw data after this layer.

After load and model.predict() data is available, otherwise is undefined.

.name : String

The custom name for this layer.

Once created, you can get it.

.layerType : String

Type of this layer, return a constant: string Layer3d.

Once created, you can get it.

Method

.apply( layer ) : void

This method only used in Functional Model (Non-sequential, Graph structure).

Link this layer to layer which is the previous layer.

To crete a link between this layer and the previous layer. You don't need to use this method specifically to create links in Sequential Model; Instead, you can simply add layers along the lines of Keras or TensorFlow.js build the model syntax.

let inputLayer = new TSP.layers.GreyscaleInput( {

    shape: [28, 28]

} );

let layer3d = new TSP.layers.Layer3d( {

    shape: [28, 28, 3]

} );

layer3d.apply( inputLayer );

.openLayer() : void

Click on the layer directly to open it by interacting directly with the object in the 3D scene.

In code, calling the method to open it.

let layer3d = new TSP.layers.Layer3d( {

    // configure some parameters for Layer3d.

} );

model.add( layer3d );

// ... add more layers for model.

model.init();

// Call openLayer API to open layer.

layer3d.openLayer();

.closeLayer() : void

To close by interacting directly with objects in a 3D scene by clicking the close button.

In code, calling the method to close it.

let layer3d = new TSP.layers.Layer3d( {

    // configure some parameters for Layer3d.

} );

model.add( layer3d );

// ... add more layers for model.

model.init();

// If this layer already opened, call closeLayer API to close layer.

layer3d.closeLayer();

Example

Declare an instance of Layer3d to facilitate reuse

let layer3d = new TSP.layers.Layer3d( {

    shape: [ 100, 100, 3 ],
    name: "Layer3d1",
    initStatus: "open"

} );

model.add( layer3d );

Add Layer3d directly

model.add(new TSP.layers.Layer3d( {

    shape: [ 100, 100, 3 ],
    name: "Layer3d2"

} ));

Tag Lookup

Tag Icon	Meaning	Instruction
⭐️	Required	Must be provided, cannot be empty. Meanwhile constructor works properly if this arguments provided. Control arguments use default value.
🔧	Suggest	Recommended for giving. The API can work without them.
⚙️	Optional	As an auxiliary adjustment parameter when used, selectively added according to the specific situation The parameters here have no effect on the structure of the layer (3D visualized form).
📦	Model	Configure the properties of the Layer. It changes the output shape.
🎨	Style	Override the properties in TSP.model (model configuration)
🎦	Animation	Override the properties in TSP.model (model configuration)

Source Code

tensorspace/src/layer/intermediate/Layer3d.js