pyagc.encoders.TabularGraphEncoder

class TabularGraphEncoder(tabular_encoder: Module, graph_encoder: Module)

Bases: Module

A two-stage encoder for Tabular Graphs:

1. Encode node tabular attributes with a TabularEncoder.

2. Encode graph structure with a PyG GNN model.

This module is useful when each node is associated with a row-like tabular feature representation (stored as a torch_frame.TensorFrame) and graph connectivity should be exploited afterwards.

Parameters:

• tabular_encoder (torch.nn.Module) – A tabular encoder using PyTorch Frame. It maps a single TensorFrame into embeddings.

• graph_encoder (torch.nn.Module) – A graph encoder that consumes node embeddings and graph connectivity. Typical examples are: torch_geometric.nn.models.GCN, torch_geometric.nn.models.GraphSAGE, etc.

__init__(tabular_encoder: Module, graph_encoder: Module)

Initialize internal Module state, shared by both nn.Module and ScriptModule.

Methods

__init__(tabular_encoder, graph_encoder)	Initialize internal Module state, shared by both nn.Module and ScriptModule.
add_module(name, module)	Add a child module to the current module.
apply(fn)	Apply fn recursively to every submodule (as returned by .children()) as well as self.
bfloat16()	Casts all floating point parameters and buffers to bfloat16 datatype.
buffers([recurse])	Return an iterator over module buffers.
children()	Return an iterator over immediate children modules.
compile(*args, **kwargs)	Compile this Module's forward using torch.compile().
cpu()	Move all model parameters and buffers to the CPU.
cuda([device])	Move all model parameters and buffers to the GPU.
double()	Casts all floating point parameters and buffers to double datatype.
encode_graph(x, edge_index[, edge_weight, ...])	Apply the graph encoder on node embeddings.
encode_tabular(tf)	Encode node tabular attributes into dense node embeddings.
eval()	Set the module in evaluation mode.
extra_repr()	Return the extra representation of the module.
float()	Casts all floating point parameters and buffers to float datatype.
forward(x, edge_index[, edge_weight, ...])	Full forward pass: tabular node attributes -> tabular embeddings -> graph encoder output.
get_buffer(target)	Return the buffer given by target if it exists, otherwise throw an error.
get_extra_state()	Return any extra state to include in the module's state_dict.
get_parameter(target)	Return the parameter given by target if it exists, otherwise throw an error.
get_submodule(target)	Return the submodule given by target if it exists, otherwise throw an error.
half()	Casts all floating point parameters and buffers to half datatype.
ipu([device])	Move all model parameters and buffers to the IPU.
load_state_dict(state_dict[, strict, assign])	Copy parameters and buffers from state_dict into this module and its descendants.
modules()	Return an iterator over all modules in the network.
mtia([device])	Move all model parameters and buffers to the MTIA.
named_buffers([prefix, recurse, ...])	Return an iterator over module buffers, yielding both the name of the buffer as well as the buffer itself.
named_children()	Return an iterator over immediate children modules, yielding both the name of the module as well as the module itself.
named_modules([memo, prefix, remove_duplicate])	Return an iterator over all modules in the network, yielding both the name of the module as well as the module itself.
named_parameters([prefix, recurse, ...])	Return an iterator over module parameters, yielding both the name of the parameter as well as the parameter itself.
parameters([recurse])	Return an iterator over module parameters.
register_backward_hook(hook)	Register a backward hook on the module.
register_buffer(name, tensor[, persistent])	Add a buffer to the module.
register_forward_hook(hook, *[, prepend, ...])	Register a forward hook on the module.
register_forward_pre_hook(hook, *[, ...])	Register a forward pre-hook on the module.
register_full_backward_hook(hook[, prepend])	Register a backward hook on the module.
register_full_backward_pre_hook(hook[, prepend])	Register a backward pre-hook on the module.
register_load_state_dict_post_hook(hook)	Register a post-hook to be run after module's load_state_dict() is called.
register_load_state_dict_pre_hook(hook)	Register a pre-hook to be run before module's load_state_dict() is called.
register_module(name, module)	Alias for add_module().
register_parameter(name, param)	Add a parameter to the module.
register_state_dict_post_hook(hook)	Register a post-hook for the state_dict() method.
register_state_dict_pre_hook(hook)	Register a pre-hook for the state_dict() method.
requires_grad_([requires_grad])	Change if autograd should record operations on parameters in this module.
reset_parameters()	Reset parameters of both the tabular encoder and the graph encoder.
set_extra_state(state)	Set extra state contained in the loaded state_dict.
set_submodule(target, module[, strict])	Set the submodule given by target if it exists, otherwise throw an error.
share_memory()	See torch.Tensor.share_memory_().
state_dict(*args[, destination, prefix, ...])	Return a dictionary containing references to the whole state of the module.
to(*args, **kwargs)	Move and/or cast the parameters and buffers.
to_empty(*, device[, recurse])	Move the parameters and buffers to the specified device without copying storage.
train([mode])	Set the module in training mode.
type(dst_type)	Casts all parameters and buffers to dst_type.
xpu([device])	Move all model parameters and buffers to the XPU.
zero_grad([set_to_none])	Reset gradients of all model parameters.

Attributes

T_destination	alias of TypeVar('T_destination', bound=dict[str, Any])
call_super_init
dump_patches

reset_parameters()

Reset parameters of both the tabular encoder and the graph encoder.

encode_tabular(tf: TensorFrame) → Tensor

Encode node tabular attributes into dense node embeddings.

Parameters:

tf (torch_frame.TensorFrame) – Node features in TensorFrame format.

Returns:

Node embeddings of shape [num_nodes, channels].

Return type:

Tensor

encode_graph(x: Tensor, edge_index: Union[Tensor, SparseTensor], edge_weight: Optional[Tensor] = None, edge_attr: Optional[Tensor] = None, batch: Optional[Tensor] = None, batch_size: Optional[int] = None, num_sampled_nodes_per_hop: Optional[List[int]] = None, num_sampled_edges_per_hop: Optional[List[int]] = None) → Tensor

Apply the graph encoder on node embeddings.

Only arguments supported by the graph encoder’s forward method will be passed through.

Return type:

Tensor

forward(x: TensorFrame, edge_index: Union[Tensor, SparseTensor], edge_weight: Optional[Tensor] = None, edge_attr: Optional[Tensor] = None, batch: Optional[Tensor] = None, batch_size: Optional[int] = None, num_sampled_nodes_per_hop: Optional[List[int]] = None, num_sampled_edges_per_hop: Optional[List[int]] = None) → Tensor

Full forward pass: tabular node attributes -> tabular embeddings -> graph encoder output.

Return type:

Tensor