Inheritance diagram for PerfectLCA:

Collaboration diagram for PerfectLCA:

Public Member Functions
def	__init__ (self, ignore_index, output_transform, device='cpu')

def	reset (self)

def	update (self, output)

def	compute (self)

Public Attributes
	ignore_index
	Ignore index.

	device
	CPU or GPU.

Private Attributes
	_per_corrects
	Good samples.

	_num_examples
	Total samples.

Detailed Description

Computes the rate of perfectly predicted LCAS matrices over a batch.

``output_transform`` should return the following items: ``(edge_pred, edge_y, edge_index, u_y, batch, num_graphs)``.

* ``edge_pred`` must contain edge prediction logits and have shape (num_edges_in_batch, edge_classes);
* ``edge_y`` must contain edge ground-truth class indices and have shape (num_edges_in_batch, 1);
* ``edge index`` maps edges to its nodes;
* ``u_y`` is the signal/background class (always 1 in the current setting);
* ``batch`` maps nodes to their graph;
* ``num_graphs`` is the number of graph in a batch (could be derived from ``batch`` also).

.. seealso::
    `Ignite metrics <https://pytorch.org/ignite/metrics.html>`_

:param ignore_index: Class or list of classes to ignore during the computation (e.g. padding).
:type ignore_index: list[int]
:param output_transform: Function to transform engine's output to desired output.
:type output_transform: `function <https://docs.python.org/3/glossary.html#term-function>`_
:param device: ``cpu`` or ``gpu``.
:type device: str

Definition at line 17 of file metrics.py.

Constructor & Destructor Documentation

◆ init()

def __init__	(	self,
		ignore_index,
		output_transform,
		device = `'cpu'`
	)

Initialization.

Definition at line 41 of file metrics.py.

     def __init__(self, ignore_index, output_transform, device='cpu'):
         """
         Initialization.
         """
         
         self.ignore_index = ignore_index if isinstance(ignore_index, list) else [ignore_index]
         
         self.device = device
         
         self._per_corrects = None
         
         self._num_examples = None
  
         super(PerfectLCA, self).__init__(output_transform=output_transform, device=device)
  

Member Function Documentation

◆ compute()

def compute ( self )

Final result.

Definition at line 101 of file metrics.py.

◆ reset()

def reset ( self )

Resets counters.

Definition at line 57 of file metrics.py.

◆ update()

def update	(	self,
		output
	)

Updates counts.

Definition at line 67 of file metrics.py.

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

analysis/scripts/grafei/model/metrics.py

Public Member Functions

Public Attributes

Private Attributes