Belle II Software  release-08-01-10
GATGAPModel Class Reference
Inheritance diagram for GATGAPModel:
Collaboration diagram for GATGAPModel:

Public Member Functions

def __init__ (self, units=128, num_features=8, num_pdg=NUM_PDG, emb_size=8, attention_heads=4, n_layers=5, use_gap=False)
 
def forward (self, graph)
 

Public Attributes

 pdg_embedding
 TODO.
 
 gat_layers
 TODO.
 
 fc_output
 TODO.
 

Detailed Description

Input:
   dgl graph built from decay event

Arguments:
   units(int): Number of units for the output dimension of GAT Convolutional layers
   as well as the dimension of global features
   num_features(int): Number of features attached to each node or particle as NN input
   num_pdg(int): Number of all possible PDG IDs
   emb_size(int): Dimension of embedded PDG space
   attention_heads(int): Number of attention heads for GAT Convolutional layers
   n_layers(int): Number of GAT Convolutional layers
   use_gap(bool): Whether use Global Attention Pooling or Global Average

Returns:
   logits(float): Indicating the probability of an event being able to pass the
   corresponding skim, need `sigmoid` to be used as a prediction

Definition at line 76 of file gatgap.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  units = 128,
  num_features = 8,
  num_pdg = NUM_PDG,
  emb_size = 8,
  attention_heads = 4,
  n_layers = 5,
  use_gap = False 
)
Initialise the class.
:param units: TODO
:param num_features: TODO
:param num_pdg: TODO
:param emb_size: TODO
:param attention_heads: TODO
:param n_layers: TODO
:param use_gap: TODO

Definition at line 96 of file gatgap.py.

Member Function Documentation

◆ forward()

def forward (   self,
  graph 
)
TODO

Definition at line 139 of file gatgap.py.


The documentation for this class was generated from the following file: