torchcell.loader.dense_padding_data_loader.dense_padded_from_data_list

dense_padded_from_data_list(data_list: list[BaseData], follow_batch: list[str] | None = None, exclude_keys: list[str] | None = None) → Batch[source]

Construct a dense Batch object from a Python list of data objects.

Builds a dense ~torch_geometric.data.Batch from a list of ~torch_geometric.data.Data or ~torch_geometric.data.HeteroData objects. The assignment vector batch is created on the fly. In addition, creates assignment vectors for each key in follow_batch. Will exclude any keys given in exclude_keys.

Parameters:
  • data_list (list) – A list of data objects.

  • follow_batch (list, optional) – Creates assignment batch vectors for each key in the list. (default: None)

  • exclude_keys (list, optional) – Will exclude each key in the list. (default: None)

Returns:

A single Batch object holding a mini-batch of data.