Files
dmlc--dgl/tools/distpartitioning/dataset_utils.py
T
2026-07-13 13:35:51 +08:00

667 lines
27 KiB
Python

import gc
import logging
import os
import array_readwriter
import constants
import numpy as np
import pyarrow
import pyarrow.parquet as pq
import torch
import torch.distributed as dist
from gloo_wrapper import alltoallv_cpu
from utils import (
DATA_TYPE_ID,
generate_read_list,
get_gid_offsets,
get_idranges,
map_partid_rank,
REV_DATA_TYPE_ID,
)
def _broadcast_shape(
data, rank, world_size, num_parts, is_feat_data, feat_name
):
"""Auxiliary function to broadcast the shape of a feature data.
This information is used to figure out the type-ids for the
local features.
Parameters:
-----------
data : numpy array
which is the feature data read from the disk
rank : integer
which represents the id of the process in the process group
world_size : integer
represents the total no. of process in the process group
num_parts : integer
specifying the no. of partitions
is_feat_data : bool
flag used to seperate feature data and edge data
feat_name : string
name of the feature
Returns:
-------
list of tuples :
which represents the range of type-ids for the data array.
"""
assert len(data.shape) in [
1,
2,
], f"Data is expected to be 1-D or 2-D but got {data.shape}."
data_shape = list(data.shape)
if len(data_shape) == 1:
data_shape.append(1)
if is_feat_data:
data_shape.append(DATA_TYPE_ID[data.dtype])
data_shape = torch.tensor(data_shape, dtype=torch.int64)
data_shape_output = [
torch.zeros_like(data_shape) for _ in range(world_size)
]
dist.all_gather(data_shape_output, data_shape)
logging.debug(
f"[Rank: {rank} Received shapes from all ranks: {data_shape_output}"
)
shapes = [x.numpy() for x in data_shape_output if x[0] != 0]
shapes = np.vstack(shapes)
if is_feat_data:
logging.debug(
f"shapes: {shapes}, condition: {all(shapes[0,2] == s for s in shapes[:,2])}"
)
assert all(
shapes[0, 2] == s for s in shapes[:, 2]
), f"dtypes for {feat_name} does not match on all ranks"
# compute tids here.
type_counts = list(shapes[:, 0])
tid_start = np.cumsum([0] + type_counts[:-1])
tid_end = np.cumsum(type_counts)
tid_ranges = list(zip(tid_start, tid_end))
logging.debug(f"starts -> {tid_start} ... end -> {tid_end}")
return tid_ranges
def get_dataset(
input_dir, graph_name, rank, world_size, num_parts, schema_map, ntype_counts
):
"""
Function to read the multiple file formatted dataset.
Parameters:
-----------
input_dir : string
root directory where dataset is located.
graph_name : string
graph name string
rank : int
rank of the current process
world_size : int
total number of process in the current execution
num_parts : int
total number of output graph partitions
schema_map : dictionary
this is the dictionary created by reading the graph metadata json file
for the input graph dataset
Return:
-------
dictionary
where keys are node-type names and values are tuples. Each tuple represents the
range of type ids read from a file by the current process. Please note that node
data for each node type is split into "p" files and each one of these "p" files are
read a process in the distributed graph partitioning pipeline
dictionary
Data read from numpy files for all the node features in this dataset. Dictionary built
using this data has keys as node feature names and values as tensor data representing
node features
dictionary
in which keys are node-type and values are a triplet. This triplet has node-feature name,
and range of tids for the node feature data read from files by the current process. Each
node-type may have mutiple feature(s) and associated tensor data.
dictionary
Data read from edges.txt file and used to build a dictionary with keys as column names
and values as columns in the csv file.
dictionary
in which keys are edge-type names and values are triplets. This triplet has edge-feature name,
and range of tids for theedge feature data read from the files by the current process. Each
edge-type may have several edge features and associated tensor data.
dictionary
Data read from numpy files for all the edge features in this dataset. This dictionary's keys
are feature names and values are tensors data representing edge feature data.
dictionary
This dictionary is used for identifying the global-id range for the associated edge features
present in the previous return value. The keys are edge-type names and values are triplets.
Each triplet consists of edge-feature name and starting and ending points of the range of
tids representing the corresponding edge feautres.
"""
# node features dictionary
# TODO: With the new file format, It is guaranteed that the input dataset will have
# no. of nodes with features (node-features) files and nodes metadata will always be the same.
# This means the dimension indicating the no. of nodes in any node-feature files and the no. of
# nodes in the corresponding nodes metadata file will always be the same. With this guarantee,
# we can eliminate the `node_feature_tids` dictionary since the same information is also populated
# in the `node_tids` dictionary. This will be remnoved in the next iteration of code changes.
node_features = {}
node_feature_tids = {}
"""
The structure of the node_data is as follows, which is present in the input metadata json file.
"node_data" : {
"ntype0-name" : {
"feat0-name" : {
"format" : {"name": "numpy"},
"data" : [ #list
"<path>/feat-0.npy",
"<path>/feat-1.npy",
....
"<path>/feat-<p-1>.npy"
]
},
"feat1-name" : {
"format" : {"name": "numpy"},
"data" : [ #list
"<path>/feat-0.npy",
"<path>/feat-1.npy",
....
"<path>/feat-<p-1>.npy"
]
}
}
}
As shown above, the value for the key "node_data" is a dictionary object, which is
used to describe the feature data for each of the node-type names. Keys in this top-level
dictionary are node-type names and value is a dictionary which captures all the features
for the current node-type. Feature data is captured with keys being the feature-names and
value is a dictionary object which has 2 keys namely format and data. Format entry is used
to mention the format of the storage used by the node features themselves and "data" is used
to mention all the files present for this given node feature.
Data read from each of the node features file is a multi-dimensional tensor data and is read
in numpy or parquet format, which is also the storage format of node features on the permanent storage.
"node_type" : ["ntype0-name", "ntype1-name", ....], #m node types
"num_nodes_per_chunk" : [
[a0, a1, ...a<p-1>], #p partitions
[b0, b1, ... b<p-1>],
....
[c0, c1, ..., c<p-1>] #no, of node types
],
The "node_type" points to a list of all the node names present in the graph
And "num_nodes_per_chunk" is used to mention no. of nodes present in each of the
input nodes files. These node counters are used to compute the type_node_ids as
well as global node-ids by using a simple cumulative summation and maitaining an
offset counter to store the end of the current.
Since nodes are NOT actually associated with any additional metadata, w.r.t to the processing
involved in this pipeline this information is not needed to be stored in files. This optimization
saves a considerable amount of time when loading massively large datasets for paritioning.
As opposed to reading from files and performing shuffling process each process/rank generates nodes
which are owned by that particular rank. And using the "num_nodes_per_chunk" information each
process can easily compute any nodes per-type node_id and global node_id.
The node-ids are treated as int64's in order to support billions of nodes in the input graph.
"""
# read my nodes for each node type
"""
node_tids, ntype_gnid_offset = get_idranges(
schema_map[constants.STR_NODE_TYPE],
schema_map[constants.STR_NUM_NODES_PER_CHUNK],
num_chunks=num_parts,
)
"""
logging.debug(f"[Rank: {rank} ntype_counts: {ntype_counts}")
ntype_gnid_offset = get_gid_offsets(
schema_map[constants.STR_NODE_TYPE], ntype_counts
)
logging.debug(f"[Rank: {rank} - ntype_gnid_offset = {ntype_gnid_offset}")
# iterate over the "node_data" dictionary in the schema_map
# read the node features if exists
# also keep track of the type_nids for which the node_features are read.
dataset_features = schema_map[constants.STR_NODE_DATA]
if (dataset_features is not None) and (len(dataset_features) > 0):
for ntype_name, ntype_feature_data in dataset_features.items():
for feat_name, feat_data in ntype_feature_data.items():
assert feat_data[constants.STR_FORMAT][constants.STR_NAME] in [
constants.STR_NUMPY,
constants.STR_PARQUET,
]
# It is guaranteed that num_chunks is always greater
# than num_partitions.
node_data = []
num_files = len(feat_data[constants.STR_DATA])
if num_files == 0:
continue
reader_fmt_meta = {
"name": feat_data[constants.STR_FORMAT][constants.STR_NAME]
}
read_list = generate_read_list(num_files, world_size)
for idx in read_list[rank]:
data_file = feat_data[constants.STR_DATA][idx]
if not os.path.isabs(data_file):
data_file = os.path.join(input_dir, data_file)
node_data.append(
array_readwriter.get_array_parser(
**reader_fmt_meta
).read(data_file)
)
if len(node_data) > 0:
node_data = np.concatenate(node_data)
else:
node_data = np.array([])
node_data = torch.from_numpy(node_data)
cur_tids = _broadcast_shape(
node_data,
rank,
world_size,
num_parts,
True,
f"{ntype_name}/{feat_name}",
)
logging.debug(f"[Rank: {rank} - cur_tids: {cur_tids}")
# collect data on current rank.
for local_part_id in range(num_parts):
data_key = (
f"{ntype_name}/{feat_name}/{local_part_id//world_size}"
)
if map_partid_rank(local_part_id, world_size) == rank:
if len(cur_tids) > local_part_id:
start, end = cur_tids[local_part_id]
assert node_data.shape[0] == (
end - start
), f"Node feature data, {data_key}, shape = {node_data.shape} does not match with tids = ({start},{end})"
node_features[data_key] = node_data
node_feature_tids[data_key] = [(start, end)]
else:
node_features[data_key] = None
node_feature_tids[data_key] = [(0, 0)]
# done building node_features locally.
if len(node_features) <= 0:
logging.debug(
f"[Rank: {rank}] This dataset does not have any node features"
)
else:
assert len(node_features) == len(node_feature_tids)
# Note that the keys in the node_features dictionary are as follows:
# `ntype_name/feat_name/local_part_id`.
# where ntype_name and feat_name are self-explanatory, and
# local_part_id indicates the partition-id, in the context of current
# process which take the values 0, 1, 2, ....
for feat_name, feat_info in node_features.items():
if feat_info == None:
continue
logging.debug(
f"[Rank: {rank}] node feature name: {feat_name}, feature data shape: {feat_info.size()}"
)
tokens = feat_name.split("/")
assert len(tokens) == 3
# Get the range of type ids which are mapped to the current node.
tids = node_feature_tids[feat_name]
# Iterate over the range of type ids for the current node feature
# and count the number of features for this feature name.
count = tids[0][1] - tids[0][0]
assert (
count == feat_info.size()[0]
), f"{feat_name}, {count} vs {feat_info.size()[0]}."
"""
Reading edge features now.
The structure of the edge_data is as follows, which is present in the input metadata json file.
"edge_data" : {
"etype0-name" : {
"feat0-name" : {
"format" : {"name": "numpy"},
"data" : [ #list
"<path>/feat-0.npy",
"<path>/feat-1.npy",
....
"<path>/feat-<p-1>.npy"
]
},
"feat1-name" : {
"format" : {"name": "numpy"},
"data" : [ #list
"<path>/feat-0.npy",
"<path>/feat-1.npy",
....
"<path>/feat-<p-1>.npy"
]
}
}
}
As shown above, the value for the key "edge_data" is a dictionary object, which is
used to describe the feature data for each of the edge-type names. Keys in this top-level
dictionary are edge-type names and value is a dictionary which captures all the features
for the current edge-type. Feature data is captured with keys being the feature-names and
value is a dictionary object which has 2 keys namely `format` and `data`. Format entry is used
to mention the format of the storage used by the node features themselves and "data" is used
to mention all the files present for this given node feature.
Data read from each of the node features file is a multi-dimensional tensor data and is read
in numpy format, which is also the storage format of node features on the permanent storage.
"""
edge_features = {}
edge_feature_tids = {}
# Iterate over the "edge_data" dictionary in the schema_map.
# Read the edge features if exists.
# Also keep track of the type_eids for which the edge_features are read.
dataset_features = schema_map[constants.STR_EDGE_DATA]
if dataset_features and (len(dataset_features) > 0):
for etype_name, etype_feature_data in dataset_features.items():
for feat_name, feat_data in etype_feature_data.items():
assert feat_data[constants.STR_FORMAT][constants.STR_NAME] in [
constants.STR_NUMPY,
constants.STR_PARQUET,
]
edge_data = []
num_files = len(feat_data[constants.STR_DATA])
if num_files == 0:
continue
reader_fmt_meta = {
"name": feat_data[constants.STR_FORMAT][constants.STR_NAME]
}
read_list = generate_read_list(num_files, world_size)
for idx in read_list[rank]:
data_file = feat_data[constants.STR_DATA][idx]
if not os.path.isabs(data_file):
data_file = os.path.join(input_dir, data_file)
logging.debug(
f"[Rank: {rank}] Loading edges-feats of {etype_name}[{feat_name}] from {data_file}"
)
edge_data.append(
array_readwriter.get_array_parser(
**reader_fmt_meta
).read(data_file)
)
if len(edge_data) > 0:
edge_data = np.concatenate(edge_data)
else:
edge_data = np.array([])
edge_data = torch.from_numpy(edge_data)
# exchange the amount of data read from the disk.
edge_tids = _broadcast_shape(
edge_data,
rank,
world_size,
num_parts,
True,
f"{etype_name}/{feat_name}",
)
# collect data on current rank.
for local_part_id in range(num_parts):
data_key = (
f"{etype_name}/{feat_name}/{local_part_id//world_size}"
)
if map_partid_rank(local_part_id, world_size) == rank:
if len(edge_tids) > local_part_id:
start, end = edge_tids[local_part_id]
assert edge_data.shape[0] == (
end - start
), f"Edge Feature data, for {data_key}, of shape = {edge_data.shape} does not match with tids = ({start}, {end})"
edge_features[data_key] = edge_data
edge_feature_tids[data_key] = [(start, end)]
else:
edge_features[data_key] = None
edge_feature_tids[data_key] = [(0, 0)]
# Done with building node_features locally.
if len(edge_features) <= 0:
logging.debug(
f"[Rank: {rank}] This dataset does not have any edge features"
)
else:
assert len(edge_features) == len(edge_feature_tids)
for k, v in edge_features.items():
if v == None:
continue
logging.debug(
f"[Rank: {rank}] edge feature name: {k}, feature data shape: {v.shape}"
)
tids = edge_feature_tids[k]
count = tids[0][1] - tids[0][0]
assert count == v.size()[0]
"""
Code below is used to read edges from the input dataset with the help of the metadata json file
for the input graph dataset.
In the metadata json file, we expect the following key-value pairs to help read the edges of the
input graph.
"edge_type" : [ # a total of n edge types
canonical_etype_0,
canonical_etype_1,
...,
canonical_etype_n-1
]
The value for the key is a list of strings, each string is associated with an edgetype in the input graph.
Note that these strings are in canonical edgetypes format. This means, these edge type strings follow the
following naming convention: src_ntype:etype:dst_ntype. src_ntype and dst_ntype are node type names of the
src and dst end points of this edge type, and etype is the relation name between src and dst ntypes.
The files in which edges are present and their storage format are present in the following key-value pair:
"edges" : {
"canonical_etype_0" : {
"format" : { "name" : "csv", "delimiter" : " " },
"data" : [
filename_0,
filename_1,
filename_2,
....
filename_<p-1>
]
},
}
As shown above the "edges" dictionary value has canonical edgetypes as keys and for each canonical edgetype
we have "format" and "data" which describe the storage format of the edge files and actual filenames respectively.
Please note that each edgetype data is split in to `p` files, where p is the no. of partitions to be made of
the input graph.
Each edge file contains two columns representing the source per-type node_ids and destination per-type node_ids
of any given edge. Since these are node-ids as well they are read in as int64's.
"""
# read my edges for each edge type
etype_names = schema_map[constants.STR_EDGE_TYPE]
etype_name_idmap = {e: idx for idx, e in enumerate(etype_names)}
edge_tids = {}
edge_typecounts = {}
edge_datadict = {}
edge_data = schema_map[constants.STR_EDGES]
# read the edges files and store this data in memory.
for col in [
constants.GLOBAL_SRC_ID,
constants.GLOBAL_DST_ID,
constants.GLOBAL_TYPE_EID,
constants.ETYPE_ID,
]:
edge_datadict[col] = []
for etype_name, etype_id in etype_name_idmap.items():
etype_info = edge_data[etype_name]
edge_info = etype_info[constants.STR_DATA]
# edgetype strings are in canonical format, src_node_type:edge_type:dst_node_type
tokens = etype_name.split(":")
assert len(tokens) == 3
src_ntype_name = tokens[0]
dst_ntype_name = tokens[2]
num_chunks = len(edge_info)
read_list = generate_read_list(num_chunks, world_size)
src_ids = []
dst_ids = []
"""
curr_partids = []
for part_id in range(num_parts):
if map_partid_rank(part_id, world_size) == rank:
curr_partids.append(read_list[part_id])
for idx in np.concatenate(curr_partids):
"""
for idx in read_list[rank]:
edge_file = edge_info[idx]
if not os.path.isabs(edge_file):
edge_file = os.path.join(input_dir, edge_file)
logging.debug(
f"[Rank: {rank}] Loading edges of etype[{etype_name}] from {edge_file}"
)
if (
etype_info[constants.STR_FORMAT][constants.STR_NAME]
== constants.STR_CSV
):
read_options = pyarrow.csv.ReadOptions(
use_threads=True,
block_size=4096,
autogenerate_column_names=True,
)
parse_options = pyarrow.csv.ParseOptions(delimiter=" ")
if os.path.getsize(edge_file) == 0:
# if getsize() == 0, the file is empty, indicating that the partition doesn't have this attribute.
# The src_ids and dst_ids should remain empty.
continue
with pyarrow.csv.open_csv(
edge_file,
read_options=read_options,
parse_options=parse_options,
) as reader:
for next_chunk in reader:
if next_chunk is None:
break
next_table = pyarrow.Table.from_batches([next_chunk])
src_ids.append(next_table["f0"].to_numpy())
dst_ids.append(next_table["f1"].to_numpy())
elif (
etype_info[constants.STR_FORMAT][constants.STR_NAME]
== constants.STR_PARQUET
):
data_df = pq.read_table(edge_file)
data_df = data_df.rename_columns(["f0", "f1"])
src_ids.append(data_df["f0"].to_numpy())
dst_ids.append(data_df["f1"].to_numpy())
else:
raise ValueError(
f"Unknown edge format {etype_info[constants.STR_FORMAT][constants.STR_NAME]} for edge type {etype_name}"
)
if len(src_ids) > 0:
src_ids = np.concatenate(src_ids)
dst_ids = np.concatenate(dst_ids)
# currently these are just type_edge_ids... which will be converted to global ids
edge_datadict[constants.GLOBAL_SRC_ID].append(
src_ids + ntype_gnid_offset[src_ntype_name][0]
)
edge_datadict[constants.GLOBAL_DST_ID].append(
dst_ids + ntype_gnid_offset[dst_ntype_name][0]
)
edge_datadict[constants.ETYPE_ID].append(
etype_name_idmap[etype_name]
* np.ones(shape=(src_ids.shape), dtype=np.int64)
)
else:
src_ids = np.array([])
# broadcast shape to compute the etype_id, and global_eid's later.
cur_tids = _broadcast_shape(
src_ids, rank, world_size, num_parts, False, None
)
edge_typecounts[etype_name] = cur_tids[-1][1]
edge_tids[etype_name] = cur_tids
for local_part_id in range(num_parts):
if map_partid_rank(local_part_id, world_size) == rank:
if len(cur_tids) > local_part_id:
edge_datadict[constants.GLOBAL_TYPE_EID].append(
np.arange(
cur_tids[local_part_id][0],
cur_tids[local_part_id][1],
dtype=np.int64,
)
)
# edge_tids[etype_name] = [(cur_tids[local_part_id][0], cur_tids[local_part_id][1])]
assert len(edge_datadict[constants.GLOBAL_SRC_ID]) == len(
edge_datadict[constants.GLOBAL_TYPE_EID]
), f"Error while reading edges from the disk, local_part_id = {local_part_id}, num_parts = {num_parts}, world_size = {world_size} cur_tids = {cur_tids}"
# stitch together to create the final data on the local machine
for col in [
constants.GLOBAL_SRC_ID,
constants.GLOBAL_DST_ID,
constants.GLOBAL_TYPE_EID,
constants.ETYPE_ID,
]:
if len(edge_datadict[col]) > 0:
edge_datadict[col] = np.concatenate(edge_datadict[col])
if len(edge_datadict[constants.GLOBAL_SRC_ID]) > 0:
assert (
edge_datadict[constants.GLOBAL_SRC_ID].shape
== edge_datadict[constants.GLOBAL_DST_ID].shape
)
assert (
edge_datadict[constants.GLOBAL_DST_ID].shape
== edge_datadict[constants.GLOBAL_TYPE_EID].shape
)
assert (
edge_datadict[constants.GLOBAL_TYPE_EID].shape
== edge_datadict[constants.ETYPE_ID].shape
)
logging.debug(
f"[Rank: {rank}] Done reading edge_file: {len(edge_datadict)}, {edge_datadict[constants.GLOBAL_SRC_ID].shape}"
)
else:
assert edge_datadict[constants.GLOBAL_SRC_ID] == []
assert edge_datadict[constants.GLOBAL_DST_ID] == []
assert edge_datadict[constants.GLOBAL_TYPE_EID] == []
edge_datadict[constants.GLOBAL_SRC_ID] = np.array([], dtype=np.int64)
edge_datadict[constants.GLOBAL_DST_ID] = np.array([], dtype=np.int64)
edge_datadict[constants.GLOBAL_TYPE_EID] = np.array([], dtype=np.int64)
edge_datadict[constants.ETYPE_ID] = np.array([], dtype=np.int64)
logging.debug(f"Rank: {rank} edge_feat_tids: {edge_feature_tids}")
return (
node_features,
node_feature_tids,
edge_datadict,
edge_typecounts,
edge_tids,
edge_features,
edge_feature_tids,
)