Belle II Software development
SNEmbedding Class Reference
Inheritance diagram for SNEmbedding:
SN

Public Member Functions

 __init__ (self, num_embeddings, embedding_dim, padding_idx=None, max_norm=None, norm_type=2, scale_grad_by_freq=False, sparse=False, _weight=None, num_svs=1, num_itrs=1, eps=1e-12)
 Constructor.
 
 forward (self, x)
 forward
 
 u (self)
 
 sv (self)
 
 W_ (self)
 

Public Attributes

 num_itrs = num_itrs
 Number of power iterations per step.
 
 num_svs = num_svs
 Number of singular values.
 
 transpose = transpose
 Transposed?
 
 eps = eps
 Epsilon value for avoiding divide-by-0.
 
 training
 

Detailed Description

Embedding layer with spectral norm
We use num_embeddings as the dim instead of embedding_dim here
for convenience sake

Definition at line 799 of file ieagan.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
num_embeddings,
embedding_dim,
padding_idx = None,
max_norm = None,
norm_type = 2,
scale_grad_by_freq = False,
sparse = False,
_weight = None,
num_svs = 1,
num_itrs = 1,
eps = 1e-12 )

Constructor.

Definition at line 807 of file ieagan.py.

820 ):
821 nn.Embedding.__init__(
822 self,
823 num_embeddings,
824 embedding_dim,
825 padding_idx,
826 max_norm,
827 norm_type,
828 scale_grad_by_freq,
829 sparse,
830 _weight,
831 )
832 SN.__init__(self, num_svs, num_itrs, num_embeddings, eps=eps)
833

Member Function Documentation

◆ forward()

forward ( self,
x )

forward

Definition at line 835 of file ieagan.py.

835 def forward(self, x):
836 return F.embedding(x, self.W_())
837
838

◆ sv()

sv ( self)
inherited
Singular values
note that these buffers are just for logging and are not used in training.

Definition at line 256 of file ieagan.py.

256 def sv(self):
257 """
258 Singular values
259 note that these buffers are just for logging and are not used in training.
260 """
261 return [getattr(self, f"sv{i:d}") for i in range(self.num_svs)]
262

◆ u()

u ( self)
inherited
Singular vectors (u side)

Definition at line 249 of file ieagan.py.

249 def u(self):
250 """
251 Singular vectors (u side)
252 """
253 return [getattr(self, f"u{i:d}") for i in range(self.num_svs)]
254

◆ W_()

W_ ( self)
inherited
Compute the spectrally-normalized weight

Definition at line 263 of file ieagan.py.

263 def W_(self):
264 """
265 Compute the spectrally-normalized weight
266 """
267 W_mat = self.weight.view(self.weight.size(0), -1)
268 if self.transpose:
269 W_mat = W_mat.t()
270 # Apply num_itrs power iterations
271 for _ in range(self.num_itrs):
272 svs, _, _ = power_iteration(
273 W_mat, self.u, update=self.training, eps=self.eps
274 )
275 # Update the svs
276 if self.training:
277 # Make sure to do this in a no_grad() context or you'll get memory leaks! # noqa
278 with torch.no_grad():
279 for i, sv in enumerate(svs):
280 self.sv[i][:] = sv
281 return self.weight / svs[0]
282
283

Member Data Documentation

◆ eps

eps = eps
inherited

Epsilon value for avoiding divide-by-0.

Definition at line 242 of file ieagan.py.

◆ num_itrs

num_itrs = num_itrs
inherited

Number of power iterations per step.

Definition at line 236 of file ieagan.py.

◆ num_svs

num_svs = num_svs
inherited

Number of singular values.

Definition at line 238 of file ieagan.py.

◆ training

training
inherited
Initial value:
= power_iteration(
W_mat, self.u, update=self.training, eps=self.eps
)

Definition at line 276 of file ieagan.py.

◆ transpose

transpose = transpose
inherited

Transposed?

Definition at line 240 of file ieagan.py.


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