Package io.github.kirstenali.deepj.transformer

Record Class TransformerStack

java.lang.Object

java.lang.Record

io.github.kirstenali.deepj.transformer.TransformerStack

All Implemented Interfaces:

Layer, Trainable

public record TransformerStack(List<TransformerBlock> blocks)
extends Record
implements Layer

A simple sequential stack of TransformerBlocks.

This exists to make transformer composition explicit (instead of reusing a generic Sequential).

Constructor Summary

Constructors

Constructor	Description
TransformerStack(List<TransformerBlock> blocks)	Creates an instance of a TransformerStack record class.

Method Summary

Modifier and Type	Method	Description
Tensor	backward(Tensor gradOut)
List<TransformerBlock>	blocks()	Returns the value of the blocks record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Tensor	forward(Tensor x)
final int	hashCode()	Returns a hash code value for this object.
List<Parameter>	parameters()
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.kirstenali.deepj.training.Trainable

zeroGrad

Constructor Details

TransformerStack

public TransformerStack(List<TransformerBlock> blocks)

Creates an instance of a TransformerStack record class.

Parameters:

blocks - the value for the blocks record component

Method Details

forward

public Tensor forward(Tensor x)

Specified by:

forward in interface Layer

backward

public Tensor backward(Tensor gradOut)

Specified by:

backward in interface Layer

parameters

public List<Parameter> parameters()

Specified by:

parameters in interface Trainable

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

blocks

public List<TransformerBlock> blocks()

Returns the value of the blocks record component.

Returns:

the value of the blocks record component