1.0.0
Get Started
Installation
Install from PyPI
Install from Source
With Optional Dependencies
Verify Installation
Introduction
What is Attributed Graph Clustering?
The ECO Framework
Supported Algorithms
Design Philosophy
Quick Example
Next Steps
Tutorials
Quickstart Tutorial
Installation
Basic Clustering Example
Configuration-Driven Workflow
Comparing Multiple Methods
Scaling to Large Graphs
Understanding Evaluation Metrics
Next Steps
Understanding the ECO Framework
The Three Pillars
Encoder Module
Cluster Head Module
Optimization Strategy
Composing ECO Components
ECO Taxonomy of Methods
Conclusion
Next Steps
Creating Custom Cluster Heads
Overview
The BaseClusterHead Interface
Example 1: Implementing a Simple Distance-Based Cluster Head
Example 2: Integrating with the DMoN Model
Example 3: Creating a Graph-Aware Cluster Head
Example 4: Using Custom Cluster Head in Training
Comparing with Existing Implementations
Key Takeaways
Next Steps
Scaling to Massive Graphs
The Scalability Challenge
PyAGC’s Scalability Solutions
Mini-Batch Training
Inference Optimization
Memory Management
Specialized Support for Large Graphs
Practical Example: Scaling to Reddit
Performance Comparison
Best Practices
Troubleshooting
Advanced Techniques
Real-World Case Studies
Summary and Recommendations
API Reference
pyagc.clusters
Base Class
Differentiable Cluster Heads
Discrete Cluster Heads
GPU-Accelerated KMeans
pyagc.data
Dataset Loading
Benchmark Datasets
Example Usage
GraphLand Industrial Datasets
See Also
pyagc.encoders
Tuned GNN Models
Factory Function
Tabular & Tabular-Graph Encoders
PyG Backbone Re-exports
Graph Transformers
pyagc.metrics
Label-Based Metrics
Structural Metrics
pyagc.models
Base Classes
Traditional Methods
Non-Parametric Methods
Deep Decoupled Methods
Deep Joint Methods
pyagc.transforms
GSSL Transform
Random Drop Edge
Random Mask Feature
pyagc.utils
Checkpoint Management
Configuration & Logging
Reproducibility
Mathematical Utilities
pyagc
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
_
__init__() (BaseClusterHead method)
(CheckpointManager method)
(DECClusterHead method)
(DinkClusterHead method)
(DMoNClusterHead method)
(GSSLTransform method)
(INCClusterHead method)
(KMeansClusterHead method)
(MinCutClusterHead method)
(MultiStageCheckpointManager method)
(NeuromapClusterHead method)
(Polynormer method)
(RandomDropEdge method)
(RandomMaskFeat method)
(SBMClusterHead method)
(SBMMatchClusterHead method)
(SGFormer method)
(TabularEncoder method)
(TabularGraphEncoder method)
(TorchKMeans method)
(TritonKMeans method)
(TunedEdgeCNN method)
(TunedGAT method)
(TunedGCN method)
(TunedGIN method)
(TunedGNN method)
(TunedGraphSAGE method)
(TunedPNA method)
A
ARGA (class in pyagc.models)
B
BaseClusterHead (class in pyagc.clusters)
,
[1]
BaseModel (class in pyagc.models)
build_flow() (NeuromapClusterHead method)
,
[1]
C
CCASSG (class in pyagc.models)
CheckpointManager (class in pyagc.utils)
cluster() (BaseClusterHead method)
,
[1]
(DECClusterHead method)
,
[1]
(DinkClusterHead method)
,
[1]
(DMoNClusterHead method)
,
[1]
(INCClusterHead method)
,
[1]
(KMeansClusterHead method)
,
[1]
(MinCutClusterHead method)
,
[1]
(NeuromapClusterHead method)
,
[1]
(SBMClusterHead method)
,
[1]
(SBMMatchClusterHead method)
,
[1]
ClusteringModel (class in pyagc.models)
components (LossOutput attribute)
compute_cluster_center() (INCClusterHead method)
,
[1]
conductance() (in module pyagc.metrics)
,
[1]
create_tuned_gnn() (in module pyagc.encoders)
,
[1]
D
DAEGC (class in pyagc.models)
DECClusterHead (class in pyagc.clusters)
,
[1]
decode() (DAEGC method)
(GAE method)
deep_update_dict() (in module pyagc.utils)
,
[1]
DGI (class in pyagc.models)
DinkClusterHead (class in pyagc.clusters)
,
[1]
DinkNet (class in pyagc.models)
discriminate() (DGI method)
discriminator_loss() (ARGA method)
DMoN (class in pyagc.models)
DMoNClusterHead (class in pyagc.clusters)
,
[1]
download() (GraphLandTensorFrameDataset method)
E
embed() (BaseModel method)
(CCASSG method)
(DAEGC method)
(DGI method)
(DinkNet method)
(DMoN method)
(GAE method)
(GBT method)
(GCSBM method)
(MAGI method)
(MinCut method)
(NAFS method)
(Neuromap method)
(Node2Vec method)
(NS4GC method)
(S2CAG method)
(S3GC method)
(SAGSC method)
(SGC method)
(SSGC method)
encode_graph() (TabularGraphEncoder method)
encode_tabular() (TabularGraphEncoder method)
F
filter_kwargs() (in module pyagc.utils)
,
[1]
fit() (TritonKMeans method)
,
[1]
fit_predict() (KMeansClusterHead method)
,
[1]
(TorchKMeans method)
,
[1]
(TritonKMeans method)
,
[1]
fit_transform() (TritonKMeans method)
,
[1]
forward() (BaseClusterHead method)
,
[1]
(CCASSG method)
(ClusteringModel method)
(DAEGC method)
(DECClusterHead method)
,
[1]
(DGI method)
(DinkClusterHead method)
,
[1]
(DinkNet method)
(DMoN method)
(DMoNClusterHead method)
,
[1]
(GAE method)
(GBT method)
(GCSBM method)
(GSSLTransform method)
(INCClusterHead method)
,
[1]
(KMeansClusterHead method)
,
[1]
(MinCut method)
(MinCutClusterHead method)
,
[1]
(NAFS method)
(Neuromap method)
(NeuromapClusterHead method)
,
[1]
(NS4GC method)
(Polynormer method)
(RandomDropEdge method)
(RandomMaskFeat method)
(S2CAG method)
(SAGSC method)
(SBMClusterHead method)
,
[1]
(SBMMatchClusterHead method)
,
[1]
(SGC method)
(SGFormer method)
(SSGC method)
(TabularEncoder method)
(TabularGraphEncoder method)
(TunedGNN method)
forward0() (NeuromapClusterHead method)
,
[1]
G
GAE (class in pyagc.models)
GBT (class in pyagc.models)
GCSBM (class in pyagc.models)
get_dataset() (in module pyagc.data)
get_logger() (in module pyagc.utils)
,
[1]
get_tabular_graphland_dataset() (in module pyagc.data)
get_training_config() (in module pyagc.utils)
,
[1]
gradient_normalize() (INCClusterHead method)
,
[1]
GRAPHLAND_DATASETS (GraphLandTensorFrameDataset attribute)
GraphLandTensorFrameDataset (class in pyagc.data)
GSSLTransform (class in pyagc.transforms)
H
has_checkpoint() (CheckpointManager method)
(MultiStageCheckpointManager method)
I
INCClusterHead (class in pyagc.clusters)
,
[1]
infer_batch() (BaseModel method)
(ClusteringModel method)
infer_full() (BaseModel method)
(ClusteringModel method)
inference() (TunedGNN method)
inference_per_layer() (TunedGNN method)
init_conv() (TunedEdgeCNN method)
(TunedGAT method)
(TunedGCN method)
(TunedGIN method)
(TunedGNN method)
(TunedGraphSAGE method)
(TunedPNA method)
initialize() (TorchKMeans method)
,
[1]
initialize_cluster_centers() (ClusteringModel method)
K
KMeansClusterHead (class in pyagc.clusters)
,
[1]
L
label_metrics() (in module pyagc.metrics)
,
[1]
load_checkpoint() (CheckpointManager method)
(MultiStageCheckpointManager method)
loader() (Node2Vec method)
(S3GC method)
log_string() (LossOutput method)
loss() (ARGA method)
(CCASSG method)
(DAEGC method)
(DGI method)
(DinkNet method)
(DMoN method)
(GAE method)
(GBT method)
(GCSBM method)
(MAGI method)
(MinCut method)
(Neuromap method)
(Node2Vec method)
(NS4GC method)
(S3GC method)
(TrainableModel method)
loss_batch() (ARGA method)
(CCASSG method)
(DAEGC method)
(DGI method)
(DinkNet method)
(DMoN method)
(GAE method)
(GBT method)
(GCSBM method)
(MAGI method)
(MinCut method)
(Neuromap method)
(NS4GC method)
(TrainableModel method)
LossOutput (class in pyagc.models)
M
MAGI (class in pyagc.models)
message() (SGC method)
(SSGC method)
message_and_aggregate() (SGC method)
(SSGC method)
MinCut (class in pyagc.models)
MinCutClusterHead (class in pyagc.clusters)
,
[1]
modularity() (in module pyagc.metrics)
,
[1]
MultiStageCheckpointManager (class in pyagc.utils)
N
NAFS (class in pyagc.models)
neg_sample() (Node2Vec method)
(S3GC method)
Neuromap (class in pyagc.models)
NeuromapClusterHead (class in pyagc.clusters)
,
[1]
Node2Vec (class in pyagc.models)
normalize_cluster_centers() (INCClusterHead method)
,
[1]
NS4GC (class in pyagc.models)
O
off_diagonal() (in module pyagc.utils)
,
[1]
P
pairwise_squared_distance() (in module pyagc.utils)
,
[1]
Polynormer (class in pyagc.encoders)
pos_sample() (Node2Vec method)
(S3GC method)
predict (BaseClusterHead property)
,
[1]
predict() (TorchKMeans method)
,
[1]
(TritonKMeans method)
,
[1]
pretrain_loss() (DAEGC method)
(DinkNet method)
process() (GraphLandTensorFrameDataset method)
processed_dir (GraphLandTensorFrameDataset property)
processed_file_names (GraphLandTensorFrameDataset property)
R
RandomDropEdge (class in pyagc.transforms)
RandomMaskFeat (class in pyagc.transforms)
raw_dir (GraphLandTensorFrameDataset property)
raw_file_names (GraphLandTensorFrameDataset property)
recon_loss() (DAEGC method)
(GAE method)
reg_loss() (ARGA method)
reset_cluster_centers() (DECClusterHead method)
,
[1]
(DinkClusterHead method)
,
[1]
(DMoNClusterHead method)
,
[1]
(INCClusterHead method)
,
[1]
(MinCutClusterHead method)
,
[1]
(NeuromapClusterHead method)
,
[1]
(SBMClusterHead method)
,
[1]
(SBMMatchClusterHead method)
,
[1]
reset_parameters() (ARGA method)
(BaseModel method)
(CCASSG method)
(DAEGC method)
(DGI method)
(DinkNet method)
(DMoN method)
(GAE method)
(GBT method)
(GCSBM method)
(MAGI method)
(MinCut method)
(Neuromap method)
(Node2Vec method)
(NS4GC method)
(Polynormer method)
(S3GC method)
(SGC method)
(SGFormer method)
(SSGC method)
(TabularEncoder method)
(TabularGraphEncoder method)
(TunedGNN method)
S
S2CAG (class in pyagc.models)
S3GC (class in pyagc.models)
SAGSC (class in pyagc.models)
sample() (Node2Vec method)
(S3GC method)
save_checkpoint() (CheckpointManager method)
(MultiStageCheckpointManager method)
SBMClusterHead (class in pyagc.clusters)
,
[1]
SBMMatchClusterHead (class in pyagc.clusters)
,
[1]
set_logger() (TrainableModel method)
set_precomputed_features() (S3GC method)
set_seed() (in module pyagc.utils)
,
[1]
SGC (class in pyagc.models)
SGFormer (class in pyagc.encoders)
SSGC (class in pyagc.models)
structure_metrics() (in module pyagc.metrics)
,
[1]
supports_edge_attr (TunedEdgeCNN attribute)
(TunedGAT attribute)
(TunedGCN attribute)
(TunedGIN attribute)
(TunedGNN attribute)
(TunedGraphSAGE attribute)
(TunedPNA attribute)
supports_edge_weight (TunedEdgeCNN attribute)
(TunedGAT attribute)
(TunedGCN attribute)
(TunedGIN attribute)
(TunedGNN attribute)
(TunedGraphSAGE attribute)
(TunedPNA attribute)
supports_norm_batch (TunedEdgeCNN attribute)
(TunedGAT attribute)
(TunedGCN attribute)
(TunedGIN attribute)
(TunedGNN attribute)
(TunedGraphSAGE attribute)
(TunedPNA attribute)
T
TabularEncoder (class in pyagc.encoders)
TabularGraphEncoder (class in pyagc.encoders)
to() (Node2Vec method)
TorchKMeans (class in pyagc.clusters)
,
[1]
total (LossOutput attribute)
train_batch() (TrainableModel method)
train_discriminator() (ARGA method)
train_encoder() (ARGA method)
train_epoch() (Node2Vec method)
(S3GC method)
train_full() (TrainableModel method)
TrainableModel (class in pyagc.models)
training (BaseClusterHead attribute)
(DECClusterHead attribute)
(DinkClusterHead attribute)
(DMoNClusterHead attribute)
(INCClusterHead attribute)
(KMeansClusterHead attribute)
(MinCutClusterHead attribute)
(NeuromapClusterHead attribute)
(SBMClusterHead attribute)
(SBMMatchClusterHead attribute)
transform() (TritonKMeans method)
,
[1]
TritonKMeans (class in pyagc.clusters)
,
[1]
TunedEdgeCNN (class in pyagc.encoders)
TunedGAT (class in pyagc.encoders)
TunedGCN (class in pyagc.encoders)
TunedGIN (class in pyagc.encoders)
TunedGNN (class in pyagc.encoders)
TunedGraphSAGE (class in pyagc.encoders)
TunedPNA (class in pyagc.encoders)