Files
2026-07-13 13:35:51 +08:00

786 lines
23 KiB
Python

import json
import logging
import os
from itertools import cycle
import constants
import dgl
import numpy as np
import psutil
import pyarrow
import torch
from dgl.distributed.partition import _dump_part_config
from pyarrow import csv
DATA_TYPE_ID = {
data_type: id
for id, data_type in enumerate(
[
torch.float32,
torch.float64,
torch.float16,
torch.uint8,
torch.int8,
torch.int16,
torch.int32,
torch.int64,
torch.bool,
]
)
}
REV_DATA_TYPE_ID = {id: data_type for data_type, id in DATA_TYPE_ID.items()}
def read_ntype_partition_files(schema_map, input_dir):
"""
Utility method to read the partition id mapping for each node.
For each node type, there will be an file, in the input directory argument
containing the partition id mapping for a given nodeid.
Parameters:
-----------
schema_map : dictionary
dictionary created by reading the input metadata json file
input_dir : string
directory in which the node-id to partition-id mappings files are
located for each of the node types in the input graph
Returns:
--------
numpy array :
array of integers representing mapped partition-ids for a given node-id.
The line number, in these files, are used as the type_node_id in each of
the files. The index into this array will be the homogenized node-id and
value will be the partition-id for that node-id (index). Please note that
the partition-ids of each node-type are stacked together vertically and
in this way heterogenous node-ids are converted to homogenous node-ids.
"""
assert os.path.isdir(input_dir)
# iterate over the node types and extract the partition id mappings
part_ids = []
ntype_names = schema_map[constants.STR_NODE_TYPE]
for ntype in ntype_names:
df = csv.read_csv(
os.path.join(input_dir, "{}.txt".format(ntype)),
read_options=pyarrow.csv.ReadOptions(
autogenerate_column_names=True
),
parse_options=pyarrow.csv.ParseOptions(delimiter=" "),
)
ntype_partids = df["f0"].to_numpy()
part_ids.append(ntype_partids)
return np.concatenate(part_ids)
def read_json(json_file):
"""
Utility method to read a json file schema
Parameters:
-----------
json_file : string
file name for the json schema
Returns:
--------
dictionary, as serialized in the json_file
"""
with open(json_file) as schema:
val = json.load(schema)
return val
def get_etype_featnames(etype_name, schema_map):
"""Retrieves edge feature names for a given edge_type
Parameters:
-----------
eype_name : string
a string specifying a edge_type name
schema : dictionary
metadata json object as a dictionary, which is read from the input
metadata file from the input dataset
Returns:
--------
list :
a list of feature names for a given edge_type
"""
edge_data = schema_map[constants.STR_EDGE_DATA]
feats = edge_data.get(etype_name, {})
return [feat for feat in feats]
def get_ntype_featnames(ntype_name, schema_map):
"""
Retrieves node feature names for a given node_type
Parameters:
-----------
ntype_name : string
a string specifying a node_type name
schema : dictionary
metadata json object as a dictionary, which is read from the input
metadata file from the input dataset
Returns:
--------
list :
a list of feature names for a given node_type
"""
node_data = schema_map[constants.STR_NODE_DATA]
feats = node_data.get(ntype_name, {})
return [feat for feat in feats]
def get_edge_types(schema_map):
"""Utility method to extract edge_typename -> edge_type mappings
as defined by the input schema
Parameters:
-----------
schema_map : dictionary
Input schema from which the edge_typename -> edge_typeid
dictionary is created.
Returns:
--------
dictionary
with keys as edge type names and values as ids (integers)
list
list of etype name strings
dictionary
with keys as etype ids (integers) and values as edge type names
"""
etypes = schema_map[constants.STR_EDGE_TYPE]
etype_etypeid_map = {e: i for i, e in enumerate(etypes)}
etypeid_etype_map = {i: e for i, e in enumerate(etypes)}
return etype_etypeid_map, etypes, etypeid_etype_map
def get_node_types(schema_map):
"""
Utility method to extract node_typename -> node_type mappings
as defined by the input schema
Parameters:
-----------
schema_map : dictionary
Input schema from which the node_typename -> node_type
dictionary is created.
Returns:
--------
dictionary
with keys as node type names and values as ids (integers)
list
list of ntype name strings
dictionary
with keys as ntype ids (integers) and values as node type names
"""
ntypes = schema_map[constants.STR_NODE_TYPE]
ntype_ntypeid_map = {e: i for i, e in enumerate(ntypes)}
ntypeid_ntype_map = {i: e for i, e in enumerate(ntypes)}
return ntype_ntypeid_map, ntypes, ntypeid_ntype_map
def get_gid_offsets(typenames, typecounts):
"""
Builds a map where the key-value pairs are typnames and respective
global-id offsets.
Parameters:
-----------
typenames : list of strings
a list of strings which can be either node typenames or edge typenames
typecounts : list of integers
a list of integers indicating the total number of nodes/edges for its
typeid which is the index in this list
Returns:
--------
dictionary :
a dictionary where keys are node_type names and values are
global_nid range, which is a tuple.
"""
assert len(typenames) == len(
typecounts
), f"No. of typenames does not match with its type counts names = {typenames}, counts = {typecounts}"
counts = []
for name in typenames:
counts.append(typecounts[name])
starts = np.cumsum([0] + counts[:-1])
ends = np.cumsum(counts)
gid_offsets = {}
for idx, name in enumerate(typenames):
gid_offsets[name] = [starts[idx], ends[idx]]
return gid_offsets
"""
starts = np.cumsum([0] + type_counts[:-1])
ends = np.cumsum(type_counts)
gid_offsets = {}
for idx, name in enumerate(typenames):
gid_offsets[name] = [start[idx], ends[idx]]
return gid_offsets
"""
def get_gnid_range_map(node_tids):
"""
Retrieves auxiliary dictionaries from the metadata json object
Parameters:
-----------
node_tids: dictionary
This dictionary contains the information about nodes for each node_type.
Typically this information contains p-entries, where each entry has a file-name,
starting and ending type_node_ids for the nodes in this file. Keys in this dictionary
are the node_type and value is a list of lists. Each individual entry in this list has
three items: file-name, starting type_nid and ending type_nid
Returns:
--------
dictionary :
a dictionary where keys are node_type names and values are global_nid range, which is a tuple.
"""
ntypes_gid_range = {}
offset = 0
for k, v in node_tids.items():
ntypes_gid_range[k] = [offset + int(v[0][0]), offset + int(v[-1][1])]
offset += int(v[-1][1])
return ntypes_gid_range
def write_metadata_json(
input_list, output_dir, graph_name, world_size, num_parts
):
"""
Merge json schema's from each of the rank's on rank-0.
This utility function, to be used on rank-0, to create aggregated json file.
Parameters:
-----------
metadata_list : list of json (dictionaries)
a list of json dictionaries to merge on rank-0
output_dir : string
output directory path in which results are stored (as a json file)
graph-name : string
a string specifying the graph name
"""
# Preprocess the input_list, a list of dictionaries
# each dictionary will contain num_parts/world_size metadata json
# which correspond to local partitions on the respective ranks.
metadata_list = []
for local_part_id in range(num_parts // world_size):
for idx in range(world_size):
metadata_list.append(
input_list[idx][
"local-part-id-" + str(local_part_id * world_size + idx)
]
)
# Initialize global metadata
graph_metadata = {}
# Merge global_edge_ids from each json object in the input list
edge_map = {}
x = metadata_list[0]["edge_map"]
for k in x:
edge_map[k] = []
for idx in range(len(metadata_list)):
edge_map[k].append(
[
int(metadata_list[idx]["edge_map"][k][0][0]),
int(metadata_list[idx]["edge_map"][k][0][1]),
]
)
graph_metadata["edge_map"] = edge_map
graph_metadata["etypes"] = metadata_list[0]["etypes"]
graph_metadata["graph_name"] = metadata_list[0]["graph_name"]
graph_metadata["halo_hops"] = metadata_list[0]["halo_hops"]
# Merge global_nodeids from each of json object in the input list
node_map = {}
x = metadata_list[0]["node_map"]
for k in x:
node_map[k] = []
for idx in range(len(metadata_list)):
node_map[k].append(
[
int(metadata_list[idx]["node_map"][k][0][0]),
int(metadata_list[idx]["node_map"][k][0][1]),
]
)
graph_metadata["node_map"] = node_map
graph_metadata["ntypes"] = metadata_list[0]["ntypes"]
graph_metadata["num_edges"] = int(
sum([metadata_list[i]["num_edges"] for i in range(len(metadata_list))])
)
graph_metadata["num_nodes"] = int(
sum([metadata_list[i]["num_nodes"] for i in range(len(metadata_list))])
)
graph_metadata["num_parts"] = metadata_list[0]["num_parts"]
graph_metadata["part_method"] = metadata_list[0]["part_method"]
for i in range(len(metadata_list)):
graph_metadata["part-{}".format(i)] = metadata_list[i][
"part-{}".format(i)
]
_dump_part_config(f"{output_dir}/metadata.json", graph_metadata)
def augment_edge_data(
edge_data, lookup_service, edge_tids, rank, world_size, num_parts
):
"""
Add partition-id (rank which owns an edge) column to the edge_data.
Parameters:
-----------
edge_data : numpy ndarray
Edge information as read from the xxx_edges.txt file
lookup_service : instance of class DistLookupService
Distributed lookup service used to map global-nids to respective partition-ids and▒
shuffle-global-nids
edge_tids: dictionary
dictionary where keys are canonical edge types and values are list of tuples
which indicate the range of edges assigned to each of the partitions
rank : integer
rank of the current process
world_size : integer
total no. of process participating in the communication primitives
num_parts : integer
total no. of partitions requested for the input graph
Returns:
--------
dictionary :
dictionary with keys as column names and values as numpy arrays and this information is
loaded from input dataset files. In addition to this we include additional columns which
aid this pipelines computation, like constants.OWNER_PROCESS
"""
# add global_nids to the node_data
etype_offset = {}
offset = 0
for etype_name, tid_range in edge_tids.items():
etype_offset[etype_name] = offset + int(tid_range[0][0])
offset += int(tid_range[-1][1])
global_eids = []
for etype_name, tid_range in edge_tids.items():
for idx in range(num_parts):
if map_partid_rank(idx, world_size) == rank:
if len(tid_range) > idx:
global_eid_start = etype_offset[etype_name]
begin = global_eid_start + int(tid_range[idx][0])
end = global_eid_start + int(tid_range[idx][1])
global_eids.append(np.arange(begin, end, dtype=np.int64))
global_eids = (
np.concatenate(global_eids)
if len(global_eids) > 0
else np.array([], dtype=np.int64)
)
assert global_eids.shape[0] == edge_data[constants.ETYPE_ID].shape[0]
edge_data[constants.GLOBAL_EID] = global_eids
return edge_data
def read_edges_file(edge_file, edge_data_dict):
"""
Utility function to read xxx_edges.txt file
Parameters:
-----------
edge_file : string
Graph file for edges in the input graph
Returns:
--------
dictionary
edge data as read from xxx_edges.txt file and columns are stored
in a dictionary with key-value pairs as column-names and column-data.
"""
if edge_file == "" or edge_file == None:
return None
# Read the file from here.
# <global_src_id> <global_dst_id> <type_eid> <etype> <attributes>
# global_src_id -- global idx for the source node ... line # in the graph_nodes.txt
# global_dst_id -- global idx for the destination id node ... line # in the graph_nodes.txt
edge_data_df = csv.read_csv(
edge_file,
read_options=pyarrow.csv.ReadOptions(autogenerate_column_names=True),
parse_options=pyarrow.csv.ParseOptions(delimiter=" "),
)
edge_data_dict = {}
edge_data_dict[constants.GLOBAL_SRC_ID] = edge_data_df["f0"].to_numpy()
edge_data_dict[constants.GLOBAL_DST_ID] = edge_data_df["f1"].to_numpy()
edge_data_dict[constants.GLOBAL_TYPE_EID] = edge_data_df["f2"].to_numpy()
edge_data_dict[constants.ETYPE_ID] = edge_data_df["f3"].to_numpy()
return edge_data_dict
def read_node_features_file(nodes_features_file):
"""
Utility function to load tensors from a file
Parameters:
-----------
nodes_features_file : string
Features file for nodes in the graph
Returns:
--------
dictionary
mappings between ntype and list of features
"""
node_features = dgl.data.utils.load_tensors(nodes_features_file, False)
return node_features
def read_edge_features_file(edge_features_file):
"""
Utility function to load tensors from a file
Parameters:
-----------
edge_features_file : string
Features file for edges in the graph
Returns:
--------
dictionary
mappings between etype and list of features
"""
edge_features = dgl.data.utils.load_tensors(edge_features_file, True)
return edge_features
def write_node_features(node_features, node_file):
"""
Utility function to serialize node_features in node_file file
Parameters:
-----------
node_features : dictionary
dictionary storing ntype <-> list of features
node_file : string
File in which the node information is serialized
"""
dgl.data.utils.save_tensors(node_file, node_features)
def write_edge_features(edge_features, edge_file):
"""
Utility function to serialize edge_features in edge_file file
Parameters:
-----------
edge_features : dictionary
dictionary storing etype <-> list of features
edge_file : string
File in which the edge information is serialized
"""
dgl.data.utils.save_tensors(edge_file, edge_features)
def write_graph_graghbolt(graph_file, graph_obj):
"""
Utility function to serialize FusedCSCSamplingGraph
Parameters:
-----------
graph_obj : FusedCSCSamplingGraph
FusedCSCSamplingGraph, as created in convert_partition.py, which is to be serialized
graph_file : string
File name in which graph object is serialized
"""
torch.save(graph_obj, graph_file)
def write_graph_dgl(graph_file, graph_obj, formats, sort_etypes):
"""
Utility function to serialize graph dgl objects
Parameters:
-----------
graph_obj : dgl graph object
graph dgl object, as created in convert_partition.py, which is to be serialized
graph_file : string
File name in which graph object is serialized
formats : str or list[str]
Save graph in specified formats.
sort_etypes : bool
Whether to sort etypes in csc/csr.
"""
dgl.distributed.partition.process_partitions(
graph_obj, formats, sort_etypes
)
dgl.save_graphs(graph_file, [graph_obj], formats=formats)
def _write_graph(
part_dir, graph_obj, formats=None, sort_etypes=None, use_graphbolt=False
):
if use_graphbolt:
write_graph_graghbolt(
os.path.join(part_dir, "fused_csc_sampling_graph.pt"), graph_obj
)
else:
write_graph_dgl(
os.path.join(part_dir, "graph.dgl"), graph_obj, formats, sort_etypes
)
def write_dgl_objects(
graph_obj,
node_features,
edge_features,
output_dir,
part_id,
orig_nids,
orig_eids,
formats,
sort_etypes,
use_graphbolt,
):
"""
Wrapper function to write graph, node/edge feature, original node/edge IDs.
Parameters:
-----------
graph_obj : dgl object
graph dgl object as created in convert_partition.py file
node_features : dgl object
Tensor data for node features
edge_features : dgl object
Tensor data for edge features
output_dir : string
location where the output files will be located
part_id : int
integer indicating the partition-id
orig_nids : dict
original node IDs
orig_eids : dict
original edge IDs
formats : str or list[str]
Save graph in formats.
sort_etypes : bool
Whether to sort etypes in csc/csr.
use_graphbolt : bool
Whether to use graphbolt or not.
"""
part_dir = output_dir + "/part" + str(part_id)
os.makedirs(part_dir, exist_ok=True)
_write_graph(
part_dir,
graph_obj,
formats=formats,
sort_etypes=sort_etypes,
use_graphbolt=use_graphbolt,
)
if node_features != None:
write_node_features(
node_features, os.path.join(part_dir, "node_feat.dgl")
)
if edge_features != None:
write_edge_features(
edge_features, os.path.join(part_dir, "edge_feat.dgl")
)
if orig_nids is not None:
orig_nids_file = os.path.join(part_dir, "orig_nids.dgl")
dgl.data.utils.save_tensors(orig_nids_file, orig_nids)
if orig_eids is not None:
orig_eids_file = os.path.join(part_dir, "orig_eids.dgl")
dgl.data.utils.save_tensors(orig_eids_file, orig_eids)
def get_idranges(names, counts, num_chunks=None):
"""
counts will be a list of numbers of a dictionary.
Length is less than or equal to the num_parts variable.
Parameters:
-----------
names : list of strings
which are either node-types or edge-types
counts : list of integers
which are total no. of nodes or edges for a give node
or edge type
num_chunks : int, optional
specifying the no. of chunks
Returns:
--------
dictionary
dictionary where the keys are node-/edge-type names and values are
list of tuples where each tuple indicates the range of values for
corresponding type-ids.
dictionary
dictionary where the keys are node-/edge-type names and value is a tuple.
This tuple indicates the global-ids for the associated node-/edge-type.
"""
gnid_start = 0
gnid_end = gnid_start
tid_dict = {}
gid_dict = {}
for idx, typename in enumerate(names):
gnid_end += counts[typename]
tid_dict[typename] = [[0, counts[typename]]]
gid_dict[typename] = np.array([gnid_start, gnid_end]).reshape([1, 2])
gnid_start = gnid_end
return tid_dict, gid_dict
def get_ntype_counts_map(ntypes, ntype_counts):
"""
Return a dictionary with key, value pairs as node type names and no. of
nodes of a particular type in the input graph.
Parameters:
-----------
ntypes : list of strings
where each string is a node-type name
ntype_counts : list of integers
where each integer is the total no. of nodes for that, idx, node type
Returns:
--------
dictinary :
a dictionary where node-type names are keys and values are total no.
of nodes for a given node-type name (which is also the key)
"""
return dict(zip(ntypes, ntype_counts))
def memory_snapshot(tag, rank):
"""
Utility function to take a snapshot of the usage of system resources
at a given point of time.
Parameters:
-----------
tag : string
string provided by the user for bookmarking purposes
rank : integer
process id of the participating process
"""
GB = 1024 * 1024 * 1024
MB = 1024 * 1024
KB = 1024
peak = dgl.partition.get_peak_mem() * KB
mem = psutil.virtual_memory()
avail = mem.available / MB
used = mem.used / MB
total = mem.total / MB
mem_string = f"{total:.0f} (MB) total, {peak:.0f} (MB) peak, {used:.0f} (MB) used, {avail:.0f} (MB) avail"
logging.debug(f"[Rank: {rank} MEMORY_SNAPSHOT] {mem_string} - {tag}")
def map_partid_rank(partid, world_size):
"""Auxiliary function to map a given partition id to one of the rank in the
MPI_WORLD processes. The range of partition ids is assumed to equal or a
multiple of the total size of MPI_WORLD. In this implementation, we use
a cyclical mapping procedure to convert partition ids to ranks.
Parameters:
-----------
partid : int
partition id, as read from node id to partition id mappings.
Returns:
--------
int :
rank of the process, which will be responsible for the given partition
id.
"""
return partid % world_size
def generate_read_list(num_files, world_size):
"""
Generate the file IDs to read for each rank
using sequential assignment.
Parameters:
-----------
num_files : int
Total number of files.
world_size : int
World size of group.
Returns:
--------
read_list : np.array
Array of target file IDs to read. Each worker is expected
to read the list of file indexes in its rank's index in the list.
e.g. rank 0 reads the file indexed in read_list[0], rank 1 the
ones in read_list[1] etc.
Examples
--------
>>> tools.distpartitionning.utils.generate_read_list(10, 4)
[array([0, 1, 2]), array([3, 4, 5]), array([6, 7]), array([8, 9])]
"""
return np.array_split(np.arange(num_files), world_size)
def generate_roundrobin_read_list(num_files, world_size):
"""
Generate the file IDs to read for each rank
using round robin assignment.
Parameters:
-----------
num_files : int
Total number of files.
world_size : int
World size of group.
Returns:
--------
read_list : np.array
Array of target file IDs to read. Each worker is expected
to read the list of file indexes in its rank's index in the list.
e.g. rank 0 reads the indexed in read_list[0], rank 1 the
ones in read_list[1] etc.
Examples
--------
>>> tools.distpartitionning.utils.generate_roundrobin_read_list(10, 4)
[[0, 4, 8], [1, 5, 9], [2, 6], [3, 7]]
"""
assignment_lists = [[] for _ in range(world_size)]
for rank, part_idx in zip(cycle(range(world_size)), range(num_files)):
assignment_lists[rank].append(part_idx)
return assignment_lists