k3-node 1.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- k3_node/__init__.py +122 -0
- k3_node/applications/__init__.py +17 -0
- k3_node/applications/bio/__init__.py +21 -0
- k3_node/applications/chemistry/__init__.py +155 -0
- k3_node/applications/materials/__init__.py +127 -0
- k3_node/applications/materials/basis.py +449 -0
- k3_node/applications/materials/chgnet.py +360 -0
- k3_node/applications/materials/core.py +351 -0
- k3_node/applications/materials/grace.py +246 -0
- k3_node/applications/materials/io.py +230 -0
- k3_node/applications/materials/m3gnet.py +462 -0
- k3_node/applications/materials/megnet.py +395 -0
- k3_node/applications/materials/qet.py +220 -0
- k3_node/applications/materials/readout.py +235 -0
- k3_node/applications/materials/so3net.py +234 -0
- k3_node/applications/materials/tensornet.py +381 -0
- k3_node/applications/materials/test_materials.py +167 -0
- k3_node/applications/materials/wrappers.py +95 -0
- k3_node/data/__init__.py +47 -0
- k3_node/data/batch.py +102 -0
- k3_node/data/collate.py +282 -0
- k3_node/data/data.py +532 -0
- k3_node/data/database.py +154 -0
- k3_node/data/dataset.py +182 -0
- k3_node/data/download.py +49 -0
- k3_node/data/extract.py +45 -0
- k3_node/data/feature_store.py +70 -0
- k3_node/data/graph_store.py +92 -0
- k3_node/data/hetero_data.py +374 -0
- k3_node/data/hypergraph_data.py +59 -0
- k3_node/data/in_memory_dataset.py +177 -0
- k3_node/data/makedirs.py +7 -0
- k3_node/data/on_disk_dataset.py +77 -0
- k3_node/data/separate.py +115 -0
- k3_node/data/storage.py +593 -0
- k3_node/data/temporal.py +154 -0
- k3_node/data/test_batch.py +67 -0
- k3_node/data/test_data.py +68 -0
- k3_node/data/test_dataset_and_stores.py +111 -0
- k3_node/data/test_hetero_data.py +33 -0
- k3_node/data/test_temporal_and_hyper.py +32 -0
- k3_node/data/view.py +43 -0
- k3_node/datasets/__init__.py +88 -0
- k3_node/datasets/actor.py +101 -0
- k3_node/datasets/airports.py +84 -0
- k3_node/datasets/amazon.py +66 -0
- k3_node/datasets/ba2motif_dataset.py +73 -0
- k3_node/datasets/ba_shapes.py +81 -0
- k3_node/datasets/bitcoin_otc.py +77 -0
- k3_node/datasets/citation_full.py +81 -0
- k3_node/datasets/coauthor.py +66 -0
- k3_node/datasets/dblp.py +106 -0
- k3_node/datasets/digits.py +63 -0
- k3_node/datasets/email_eu_core.py +60 -0
- k3_node/datasets/entities.py +158 -0
- k3_node/datasets/explainer_dataset.py +101 -0
- k3_node/datasets/facebook.py +51 -0
- k3_node/datasets/fake.py +256 -0
- k3_node/datasets/freebase.py +90 -0
- k3_node/datasets/geometric_shapes.py +69 -0
- k3_node/datasets/github.py +51 -0
- k3_node/datasets/graph_generator/__init__.py +6 -0
- k3_node/datasets/graph_generator/ba_graph.py +20 -0
- k3_node/datasets/graph_generator/base.py +29 -0
- k3_node/datasets/graph_generator/er_graph.py +21 -0
- k3_node/datasets/icews.py +58 -0
- k3_node/datasets/imdb.py +96 -0
- k3_node/datasets/jodie.py +56 -0
- k3_node/datasets/karate.py +56 -0
- k3_node/datasets/lastfm_asia.py +51 -0
- k3_node/datasets/mesh_correspondence.py +50 -0
- k3_node/datasets/molecule_net.py +148 -0
- k3_node/datasets/motif_generator/__init__.py +7 -0
- k3_node/datasets/motif_generator/base.py +29 -0
- k3_node/datasets/motif_generator/custom.py +17 -0
- k3_node/datasets/motif_generator/cycle.py +25 -0
- k3_node/datasets/motif_generator/house.py +27 -0
- k3_node/datasets/movielens.py +55 -0
- k3_node/datasets/planetoid.py +137 -0
- k3_node/datasets/polblogs.py +63 -0
- k3_node/datasets/ppi.py +189 -0
- k3_node/datasets/qm7.py +65 -0
- k3_node/datasets/qm9.py +132 -0
- k3_node/datasets/reddit.py +121 -0
- k3_node/datasets/sbm_dataset.py +165 -0
- k3_node/datasets/seal.py +74 -0
- k3_node/datasets/shape_scenes.py +92 -0
- k3_node/datasets/test_datasets.py +322 -0
- k3_node/datasets/tu_dataset.py +131 -0
- k3_node/datasets/twitch.py +66 -0
- k3_node/datasets/webkb.py +102 -0
- k3_node/datasets/wikics.py +85 -0
- k3_node/datasets/word_net.py +184 -0
- k3_node/etl/__init__.py +37 -0
- k3_node/etl/encoders.py +248 -0
- k3_node/etl/graph_builders.py +270 -0
- k3_node/etl/relational_to_graph.py +201 -0
- k3_node/etl/table_to_graph.py +244 -0
- k3_node/etl/test_etl.py +318 -0
- k3_node/export/__init__.py +15 -0
- k3_node/export/cross_backend.py +172 -0
- k3_node/export/onnx_exporter.py +190 -0
- k3_node/export/runtime.py +254 -0
- k3_node/export/tensorrt_exporter.py +201 -0
- k3_node/export/test_export.py +337 -0
- k3_node/export/tflite_exporter.py +112 -0
- k3_node/hub/__init__.py +29 -0
- k3_node/hub/dataset_hub.py +242 -0
- k3_node/hub/hub_mixin.py +599 -0
- k3_node/hub/model_card.py +133 -0
- k3_node/hub/test_hub.py +419 -0
- k3_node/io/__init__.py +22 -0
- k3_node/io/fs.py +117 -0
- k3_node/io/npz.py +45 -0
- k3_node/io/off.py +29 -0
- k3_node/io/planetoid.py +98 -0
- k3_node/io/tu.py +137 -0
- k3_node/io/txt_array.py +58 -0
- k3_node/layers/__init__.py +14 -0
- k3_node/layers/aggr/__init__.py +70 -0
- k3_node/layers/aggr/attention.py +77 -0
- k3_node/layers/aggr/base.py +403 -0
- k3_node/layers/aggr/basic.py +412 -0
- k3_node/layers/aggr/deep_sets.py +65 -0
- k3_node/layers/aggr/deepsets.py +29 -0
- k3_node/layers/aggr/equilibrium.py +107 -0
- k3_node/layers/aggr/fused.py +43 -0
- k3_node/layers/aggr/gmt.py +89 -0
- k3_node/layers/aggr/gru.py +58 -0
- k3_node/layers/aggr/lcm.py +143 -0
- k3_node/layers/aggr/lstm.py +58 -0
- k3_node/layers/aggr/mlp.py +75 -0
- k3_node/layers/aggr/multi.py +154 -0
- k3_node/layers/aggr/patch_transformer.py +137 -0
- k3_node/layers/aggr/quantile.py +125 -0
- k3_node/layers/aggr/resolver.py +68 -0
- k3_node/layers/aggr/scaler.py +133 -0
- k3_node/layers/aggr/set2set.py +87 -0
- k3_node/layers/aggr/set_transformer.py +107 -0
- k3_node/layers/aggr/sort.py +68 -0
- k3_node/layers/aggr/test_aggr.py +337 -0
- k3_node/layers/aggr/utils.py +210 -0
- k3_node/layers/aggr/variance_preserving.py +54 -0
- k3_node/layers/attention/__init__.py +5 -0
- k3_node/layers/attention/pair_attention.py +448 -0
- k3_node/layers/attention/performer.py +187 -0
- k3_node/layers/attention/polynormer.py +160 -0
- k3_node/layers/attention/qformer.py +143 -0
- k3_node/layers/attention/sgformer.py +106 -0
- k3_node/layers/attention/test_attention.py +68 -0
- k3_node/layers/attention/test_pair_attention.py +91 -0
- k3_node/layers/conv/__init__.py +149 -0
- k3_node/layers/conv/agnn_conv.py +120 -0
- k3_node/layers/conv/antisymmetric_conv.py +94 -0
- k3_node/layers/conv/appnp.py +105 -0
- k3_node/layers/conv/appnp_conv.py +157 -0
- k3_node/layers/conv/arma_conv.py +231 -0
- k3_node/layers/conv/cg_conv.py +92 -0
- k3_node/layers/conv/cheb_conv.py +137 -0
- k3_node/layers/conv/cluster_gcn_conv.py +102 -0
- k3_node/layers/conv/conv.py +100 -0
- k3_node/layers/conv/crystal_conv.py +140 -0
- k3_node/layers/conv/cugraph.py +84 -0
- k3_node/layers/conv/diffusion_conv.py +144 -0
- k3_node/layers/conv/dir_gnn_conv.py +93 -0
- k3_node/layers/conv/dna_conv.py +192 -0
- k3_node/layers/conv/edge_conv.py +107 -0
- k3_node/layers/conv/eg_conv.py +155 -0
- k3_node/layers/conv/fa_conv.py +107 -0
- k3_node/layers/conv/feast_conv.py +126 -0
- k3_node/layers/conv/film_conv.py +143 -0
- k3_node/layers/conv/gat_conv.py +244 -0
- k3_node/layers/conv/gated_graph_conv.py +136 -0
- k3_node/layers/conv/gatv2_conv.py +205 -0
- k3_node/layers/conv/gcn.py +144 -0
- k3_node/layers/conv/gcn2_conv.py +126 -0
- k3_node/layers/conv/gcn_conv.py +135 -0
- k3_node/layers/conv/gen_conv.py +163 -0
- k3_node/layers/conv/general_conv.py +218 -0
- k3_node/layers/conv/gin_conv.py +218 -0
- k3_node/layers/conv/gmm_conv.py +172 -0
- k3_node/layers/conv/gps_conv.py +153 -0
- k3_node/layers/conv/graph_attention.py +262 -0
- k3_node/layers/conv/graph_conv.py +84 -0
- k3_node/layers/conv/gravnet_conv.py +93 -0
- k3_node/layers/conv/han_conv.py +175 -0
- k3_node/layers/conv/heat_conv.py +131 -0
- k3_node/layers/conv/hetero_conv.py +128 -0
- k3_node/layers/conv/hgt_conv.py +218 -0
- k3_node/layers/conv/hypergraph_conv.py +182 -0
- k3_node/layers/conv/le_conv.py +81 -0
- k3_node/layers/conv/lg_conv.py +58 -0
- k3_node/layers/conv/meshcnn_conv.py +84 -0
- k3_node/layers/conv/message_passing.py +451 -0
- k3_node/layers/conv/mf_conv.py +95 -0
- k3_node/layers/conv/mixhop_conv.py +108 -0
- k3_node/layers/conv/nn_conv.py +110 -0
- k3_node/layers/conv/pan_conv.py +100 -0
- k3_node/layers/conv/pdn_conv.py +109 -0
- k3_node/layers/conv/pna_conv.py +177 -0
- k3_node/layers/conv/point_conv.py +101 -0
- k3_node/layers/conv/point_gnn_conv.py +90 -0
- k3_node/layers/conv/point_transformer_conv.py +132 -0
- k3_node/layers/conv/ppf_conv.py +135 -0
- k3_node/layers/conv/ppnp.py +89 -0
- k3_node/layers/conv/res_gated_graph_conv.py +126 -0
- k3_node/layers/conv/rgat_conv.py +251 -0
- k3_node/layers/conv/rgcn_conv.py +321 -0
- k3_node/layers/conv/sage_conv.py +154 -0
- k3_node/layers/conv/sg_conv.py +96 -0
- k3_node/layers/conv/signed_conv.py +100 -0
- k3_node/layers/conv/simple_conv.py +75 -0
- k3_node/layers/conv/spline_conv.py +182 -0
- k3_node/layers/conv/ssg_conv.py +101 -0
- k3_node/layers/conv/supergat_conv.py +195 -0
- k3_node/layers/conv/tag_conv.py +98 -0
- k3_node/layers/conv/test_backend_consistency.py +164 -0
- k3_node/layers/conv/test_conv.py +176 -0
- k3_node/layers/conv/test_conv_pyg.py +566 -0
- k3_node/layers/conv/transformer_conv.py +168 -0
- k3_node/layers/conv/utils.py +403 -0
- k3_node/layers/conv/wl_conv.py +151 -0
- k3_node/layers/conv/x_conv.py +187 -0
- k3_node/layers/dense/__init__.py +40 -0
- k3_node/layers/dense/dense_gat_conv.py +149 -0
- k3_node/layers/dense/dense_gcn_conv.py +117 -0
- k3_node/layers/dense/dense_gin_conv.py +88 -0
- k3_node/layers/dense/dense_graph_conv.py +95 -0
- k3_node/layers/dense/dense_sage_conv.py +85 -0
- k3_node/layers/dense/diff_pool.py +76 -0
- k3_node/layers/dense/dmon_pool.py +223 -0
- k3_node/layers/dense/linear.py +327 -0
- k3_node/layers/dense/mincut_pool.py +92 -0
- k3_node/layers/dense/test_dense.py +377 -0
- k3_node/layers/functional/__init__.py +13 -0
- k3_node/layers/functional/bro.py +49 -0
- k3_node/layers/functional/edge_dropout.py +55 -0
- k3_node/layers/functional/gini.py +44 -0
- k3_node/layers/functional/test_functional.py +34 -0
- k3_node/layers/kge/__init__.py +17 -0
- k3_node/layers/kge/base.py +255 -0
- k3_node/layers/kge/complex.py +98 -0
- k3_node/layers/kge/distmult.py +79 -0
- k3_node/layers/kge/loader.py +50 -0
- k3_node/layers/kge/rotate.py +103 -0
- k3_node/layers/kge/test_kge.py +76 -0
- k3_node/layers/kge/transe.py +96 -0
- k3_node/layers/norm/__init__.py +23 -0
- k3_node/layers/norm/batch_norm.py +328 -0
- k3_node/layers/norm/diff_group_norm.py +141 -0
- k3_node/layers/norm/graph_norm.py +105 -0
- k3_node/layers/norm/graph_size_norm.py +57 -0
- k3_node/layers/norm/instance_norm.py +163 -0
- k3_node/layers/norm/layer_norm.py +245 -0
- k3_node/layers/norm/mean_subtraction_norm.py +57 -0
- k3_node/layers/norm/msg_norm.py +58 -0
- k3_node/layers/norm/pair_norm.py +94 -0
- k3_node/layers/norm/test_norm.py +275 -0
- k3_node/layers/pool/__init__.py +83 -0
- k3_node/layers/pool/approx_knn.py +101 -0
- k3_node/layers/pool/asap.py +173 -0
- k3_node/layers/pool/avg_pool.py +165 -0
- k3_node/layers/pool/cluster_pool.py +168 -0
- k3_node/layers/pool/connect/__init__.py +10 -0
- k3_node/layers/pool/connect/base.py +103 -0
- k3_node/layers/pool/connect/filter_edges.py +113 -0
- k3_node/layers/pool/consecutive.py +30 -0
- k3_node/layers/pool/decimation.py +48 -0
- k3_node/layers/pool/edge_pool.py +189 -0
- k3_node/layers/pool/glob.py +139 -0
- k3_node/layers/pool/graclus.py +66 -0
- k3_node/layers/pool/knn.py +253 -0
- k3_node/layers/pool/max_pool.py +159 -0
- k3_node/layers/pool/mem_pool.py +145 -0
- k3_node/layers/pool/pan_pool.py +144 -0
- k3_node/layers/pool/point_cloud.py +212 -0
- k3_node/layers/pool/pool.py +119 -0
- k3_node/layers/pool/sag_pool.py +174 -0
- k3_node/layers/pool/select/__init__.py +10 -0
- k3_node/layers/pool/select/base.py +112 -0
- k3_node/layers/pool/select/topk.py +206 -0
- k3_node/layers/pool/test_pool.py +456 -0
- k3_node/layers/pool/topk_pool.py +103 -0
- k3_node/layers/pool/voxel_grid.py +70 -0
- k3_node/layers/unpool/__init__.py +9 -0
- k3_node/layers/unpool/knn_interpolate.py +57 -0
- k3_node/layers/unpool/test_unpool.py +31 -0
- k3_node/loader/__init__.py +62 -0
- k3_node/loader/base.py +69 -0
- k3_node/loader/cache.py +68 -0
- k3_node/loader/cluster.py +127 -0
- k3_node/loader/data_list_loader.py +45 -0
- k3_node/loader/dataloader.py +117 -0
- k3_node/loader/dense_data_loader.py +62 -0
- k3_node/loader/dynamic_batch_sampler.py +93 -0
- k3_node/loader/graph_saint.py +188 -0
- k3_node/loader/hgt_loader.py +90 -0
- k3_node/loader/imbalanced_sampler.py +87 -0
- k3_node/loader/keras_dataset.py +334 -0
- k3_node/loader/link_loader.py +179 -0
- k3_node/loader/link_neighbor_loader.py +202 -0
- k3_node/loader/mixin.py +190 -0
- k3_node/loader/neighbor_loader.py +159 -0
- k3_node/loader/neighbor_sampler.py +167 -0
- k3_node/loader/node_loader.py +185 -0
- k3_node/loader/prefetch.py +115 -0
- k3_node/loader/random_node_loader.py +89 -0
- k3_node/loader/sampler_utils.py +499 -0
- k3_node/loader/shadow.py +115 -0
- k3_node/loader/temporal_dataloader.py +98 -0
- k3_node/loader/test_dataloader.py +113 -0
- k3_node/loader/test_keras_dataset.py +221 -0
- k3_node/loader/test_neighbor_loader.py +122 -0
- k3_node/loader/test_sampler_utils.py +82 -0
- k3_node/loader/test_samplers.py +96 -0
- k3_node/loader/test_subgraph_loaders.py +89 -0
- k3_node/loader/utils.py +232 -0
- k3_node/loader/zip_loader.py +88 -0
- k3_node/metrics.py +94 -0
- k3_node/models/__init__.py +424 -0
- k3_node/models/attentive_fp.py +232 -0
- k3_node/models/attract_repel.py +108 -0
- k3_node/models/autoencoder.py +318 -0
- k3_node/models/basic_gnn.py +443 -0
- k3_node/models/bio/__init__.py +4 -0
- k3_node/models/captum.py +52 -0
- k3_node/models/chemistry/__init__.py +4 -0
- k3_node/models/correct_and_smooth.py +146 -0
- k3_node/models/deep_graph_infomax.py +113 -0
- k3_node/models/deepgcn.py +121 -0
- k3_node/models/dimenet.py +737 -0
- k3_node/models/dimenet_utils.py +153 -0
- k3_node/models/gnnff.py +263 -0
- k3_node/models/gps_model.py +1122 -0
- k3_node/models/gpse.py +638 -0
- k3_node/models/graph_unet.py +199 -0
- k3_node/models/graphmae2.py +954 -0
- k3_node/models/graphormer.py +1258 -0
- k3_node/models/graphormer_3d.py +868 -0
- k3_node/models/grover.py +1066 -0
- k3_node/models/jumping_knowledge.py +200 -0
- k3_node/models/label_prop.py +110 -0
- k3_node/models/lightgcn.py +171 -0
- k3_node/models/linkx.py +181 -0
- k3_node/models/lpformer.py +404 -0
- k3_node/models/mask_label.py +114 -0
- k3_node/models/materials/__init__.py +33 -0
- k3_node/models/meta.py +133 -0
- k3_node/models/metapath2vec.py +234 -0
- k3_node/models/mlp.py +264 -0
- k3_node/models/mole_bert.py +379 -0
- k3_node/models/neural_fingerprint.py +95 -0
- k3_node/models/node2vec.py +213 -0
- k3_node/models/pmlp.py +157 -0
- k3_node/models/polynormer.py +229 -0
- k3_node/models/rect.py +93 -0
- k3_node/models/renet.py +221 -0
- k3_node/models/rev_gnn.py +128 -0
- k3_node/models/schnet.py +484 -0
- k3_node/models/sgformer.py +195 -0
- k3_node/models/signed_gcn.py +185 -0
- k3_node/models/test_attentive_fp.py +32 -0
- k3_node/models/test_attract_repel.py +33 -0
- k3_node/models/test_autoencoder.py +119 -0
- k3_node/models/test_basic_gnn.py +102 -0
- k3_node/models/test_correct_and_smooth.py +40 -0
- k3_node/models/test_deep_graph_infomax.py +68 -0
- k3_node/models/test_deepgcn.py +21 -0
- k3_node/models/test_dimenet.py +86 -0
- k3_node/models/test_domain_apis.py +138 -0
- k3_node/models/test_gnnff.py +24 -0
- k3_node/models/test_gps_model.py +271 -0
- k3_node/models/test_gpse.py +34 -0
- k3_node/models/test_graph_unet.py +26 -0
- k3_node/models/test_graphmae2.py +226 -0
- k3_node/models/test_graphormer.py +233 -0
- k3_node/models/test_graphormer3d.py +163 -0
- k3_node/models/test_grover.py +287 -0
- k3_node/models/test_jumping_knowledge.py +129 -0
- k3_node/models/test_label_prop.py +37 -0
- k3_node/models/test_lightgcn.py +38 -0
- k3_node/models/test_linkx.py +31 -0
- k3_node/models/test_lpformer.py +22 -0
- k3_node/models/test_mask_label.py +90 -0
- k3_node/models/test_meta.py +159 -0
- k3_node/models/test_metapath2vec.py +45 -0
- k3_node/models/test_mlp.py +62 -0
- k3_node/models/test_mole_bert.py +164 -0
- k3_node/models/test_neural_fingerprint.py +13 -0
- k3_node/models/test_node2vec.py +57 -0
- k3_node/models/test_pmlp.py +81 -0
- k3_node/models/test_polynormer.py +104 -0
- k3_node/models/test_rect.py +23 -0
- k3_node/models/test_renet.py +32 -0
- k3_node/models/test_rev_gnn.py +24 -0
- k3_node/models/test_schnet.py +43 -0
- k3_node/models/test_sgformer.py +48 -0
- k3_node/models/test_signed_gcn.py +28 -0
- k3_node/models/test_tgn.py +77 -0
- k3_node/models/test_unimol.py +179 -0
- k3_node/models/test_unimol2.py +114 -0
- k3_node/models/test_unimol_plus.py +131 -0
- k3_node/models/test_visnet.py +44 -0
- k3_node/models/tgn.py +382 -0
- k3_node/models/unimol.py +1156 -0
- k3_node/models/unimol2.py +616 -0
- k3_node/models/unimol_docking_v2.py +301 -0
- k3_node/models/unimol_plus.py +456 -0
- k3_node/models/utils.py +97 -0
- k3_node/models/visnet.py +759 -0
- k3_node/ops/__init__.py +4 -0
- k3_node/ops/conv.py +56 -0
- k3_node/ops/creation.py +43 -0
- k3_node/ops/graph.py +27 -0
- k3_node/ops/host.py +41 -0
- k3_node/ops/matmul.py +49 -0
- k3_node/ops/numpy.py +24 -0
- k3_node/ops/segment.py +54 -0
- k3_node/ops/sparse.py +51 -0
- k3_node/rag/__init__.py +49 -0
- k3_node/rag/encoders.py +312 -0
- k3_node/rag/pipeline.py +192 -0
- k3_node/rag/projector.py +184 -0
- k3_node/rag/subgraph.py +270 -0
- k3_node/rag/test_rag.py +347 -0
- k3_node/rag/verbalizer.py +162 -0
- k3_node/tasks/__init__.py +19 -0
- k3_node/tasks/backbone_resolver.py +125 -0
- k3_node/tasks/base.py +67 -0
- k3_node/tasks/graph_classification.py +270 -0
- k3_node/tasks/graph_regression.py +228 -0
- k3_node/tasks/link_prediction.py +306 -0
- k3_node/tasks/node_classification.py +194 -0
- k3_node/tasks/node_regression.py +138 -0
- k3_node/tasks/test_tasks.py +319 -0
- k3_node/test_docstring_examples.py +106 -0
- k3_node/test_training_forwarding.py +116 -0
- k3_node/training.py +115 -0
- k3_node/transforms/__init__.py +166 -0
- k3_node/transforms/base_transform.py +32 -0
- k3_node/transforms/compose.py +58 -0
- k3_node/transforms/general.py +676 -0
- k3_node/transforms/graph.py +1070 -0
- k3_node/transforms/spatial.py +797 -0
- k3_node/transforms/test_random_link_split.py +45 -0
- k3_node/transforms/test_spatial_transforms.py +65 -0
- k3_node/transforms/test_transforms.py +253 -0
- k3_node/transforms/utils.py +102 -0
- k3_node/utils/__init__.py +5 -0
- k3_node/utils/backend_import.py +12 -0
- k3_node/utils/graph.py +286 -0
- k3_node/utils/keras.py +94 -0
- k3_node/utils/random.py +103 -0
- k3_node/utils/smiles.py +235 -0
- k3_node-1.0.0.dist-info/METADATA +284 -0
- k3_node-1.0.0.dist-info/RECORD +459 -0
- k3_node-1.0.0.dist-info/WHEEL +5 -0
- k3_node-1.0.0.dist-info/licenses/LICENSE +21 -0
- k3_node-1.0.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,395 @@
|
|
|
1
|
+
"""Multi-backend Keras 3 implementation of MEGNet."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from typing import Sequence, Optional, Union, Tuple, Dict, Any
|
|
6
|
+
import keras
|
|
7
|
+
from keras import layers, ops
|
|
8
|
+
import numpy as np
|
|
9
|
+
|
|
10
|
+
from .core import MLP, EmbeddingBlock, SoftPlus2, get_activation, scatter_mean, infer_num_graphs
|
|
11
|
+
from .basis import BondExpansion, compute_pair_vector_and_distance
|
|
12
|
+
from .readout import Set2SetReadOut, EdgeSet2Set
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
class MEGNetGraphConv(layers.Layer):
|
|
16
|
+
"""MEGNet graph convolution layer: edge -> node -> state updates.
|
|
17
|
+
|
|
18
|
+
Example:
|
|
19
|
+
```python
|
|
20
|
+
import numpy as np
|
|
21
|
+
from k3_node.models import MEGNetGraphConv
|
|
22
|
+
|
|
23
|
+
edge_index = np.array([[0, 1, 1, 2, 2, 3, 3, 0], [1, 0, 2, 1, 3, 2, 0, 3]]) # 4 atoms, 8 bonds
|
|
24
|
+
node_feat = np.random.rand(4, 16).astype("float32")
|
|
25
|
+
edge_feat = np.random.rand(8, 16).astype("float32")
|
|
26
|
+
state_feat = np.random.rand(1, 16).astype("float32") # one global state per structure
|
|
27
|
+
batch, edge_batch = np.zeros(4, dtype="int32"), np.zeros(8, dtype="int32")
|
|
28
|
+
|
|
29
|
+
conv = MEGNetGraphConv(edge_dims=[64, 32, 16], node_dims=[48, 32, 16], state_dims=[48, 32, 16])
|
|
30
|
+
edge_out, node_out, state_out = conv(edge_index, edge_feat, node_feat, state_feat, batch=batch,
|
|
31
|
+
edge_batch=edge_batch, num_nodes=4, num_graphs=1)
|
|
32
|
+
print(tuple(edge_out.shape), tuple(node_out.shape), tuple(state_out.shape)) # (8, 16) (4, 16) (1, 16)
|
|
33
|
+
```
|
|
34
|
+
"""
|
|
35
|
+
|
|
36
|
+
def __init__(
|
|
37
|
+
self,
|
|
38
|
+
edge_dims: Sequence[int],
|
|
39
|
+
node_dims: Sequence[int],
|
|
40
|
+
state_dims: Sequence[int],
|
|
41
|
+
activation: str = "softplus2",
|
|
42
|
+
**kwargs,
|
|
43
|
+
):
|
|
44
|
+
super().__init__(**kwargs)
|
|
45
|
+
self.edge_func = MLP(edge_dims, activation=activation, activate_last=True)
|
|
46
|
+
self.node_func = MLP(node_dims, activation=activation, activate_last=True)
|
|
47
|
+
self.state_func = MLP(state_dims, activation=activation, activate_last=True)
|
|
48
|
+
|
|
49
|
+
def call(
|
|
50
|
+
self,
|
|
51
|
+
edge_index,
|
|
52
|
+
edge_feat,
|
|
53
|
+
node_feat,
|
|
54
|
+
state_feat,
|
|
55
|
+
batch=None,
|
|
56
|
+
edge_batch=None,
|
|
57
|
+
num_nodes: Optional[int] = None,
|
|
58
|
+
num_graphs: Optional[int] = None,
|
|
59
|
+
):
|
|
60
|
+
n_nodes = ops.shape(node_feat)[0]
|
|
61
|
+
n_states = ops.shape(state_feat)[0]
|
|
62
|
+
src = ops.clip(ops.cast(edge_index[0], "int32"), 0, ops.maximum(n_nodes - 1, 0))
|
|
63
|
+
dst = ops.clip(ops.cast(edge_index[1], "int32"), 0, ops.maximum(n_nodes - 1, 0))
|
|
64
|
+
|
|
65
|
+
# Broadcast state to nodes and edges
|
|
66
|
+
if batch is not None:
|
|
67
|
+
b_node = ops.clip(ops.cast(batch, "int32"), 0, ops.maximum(n_states - 1, 0))
|
|
68
|
+
u_node = ops.take(state_feat, b_node, axis=0)
|
|
69
|
+
else:
|
|
70
|
+
num_n = ops.shape(node_feat)[0]
|
|
71
|
+
u_node = ops.broadcast_to(state_feat, (num_n, ops.shape(state_feat)[-1]))
|
|
72
|
+
|
|
73
|
+
if edge_batch is not None:
|
|
74
|
+
b_edge = ops.clip(ops.cast(edge_batch, "int32"), 0, ops.maximum(n_states - 1, 0))
|
|
75
|
+
u_edge = ops.take(state_feat, b_edge, axis=0)
|
|
76
|
+
else:
|
|
77
|
+
num_e = ops.shape(edge_feat)[0]
|
|
78
|
+
u_edge = ops.broadcast_to(state_feat, (num_e, ops.shape(state_feat)[-1]))
|
|
79
|
+
|
|
80
|
+
# 1. Edge update: concat(vi, vj, eij, u)
|
|
81
|
+
vi = ops.take(node_feat, src, axis=0)
|
|
82
|
+
vj = ops.take(node_feat, dst, axis=0)
|
|
83
|
+
edge_inputs = ops.concatenate([vi, vj, edge_feat, u_edge], axis=-1)
|
|
84
|
+
edge_feat_new = self.edge_func(edge_inputs)
|
|
85
|
+
|
|
86
|
+
# 2. Node update: concat(vi, mean(eij), u)
|
|
87
|
+
ve = scatter_mean(edge_feat_new, src, num_segments=num_nodes)
|
|
88
|
+
node_inputs = ops.concatenate([node_feat, ve, u_node], axis=-1)
|
|
89
|
+
node_feat_new = self.node_func(node_inputs)
|
|
90
|
+
|
|
91
|
+
# 3. State update: concat(u, mean(e), mean(v))
|
|
92
|
+
n_graphs = ops.shape(state_feat)[0]
|
|
93
|
+
if edge_batch is not None:
|
|
94
|
+
u_e_mean = scatter_mean(edge_feat_new, edge_batch, num_segments=n_graphs)
|
|
95
|
+
else:
|
|
96
|
+
u_e_mean = ops.mean(edge_feat_new, axis=0, keepdims=True)
|
|
97
|
+
|
|
98
|
+
if batch is not None:
|
|
99
|
+
u_v_mean = scatter_mean(node_feat_new, batch, num_segments=n_graphs)
|
|
100
|
+
else:
|
|
101
|
+
u_v_mean = ops.mean(node_feat_new, axis=0, keepdims=True)
|
|
102
|
+
|
|
103
|
+
state_inputs = ops.concatenate([state_feat, u_e_mean, u_v_mean], axis=-1)
|
|
104
|
+
state_feat_new = self.state_func(state_inputs)
|
|
105
|
+
|
|
106
|
+
return edge_feat_new, node_feat_new, state_feat_new
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
class MEGNetBlock(layers.Layer):
|
|
110
|
+
"""MEGNet block: pre-MLPs, graph convolution, skip connections.
|
|
111
|
+
|
|
112
|
+
Example:
|
|
113
|
+
```python
|
|
114
|
+
import numpy as np
|
|
115
|
+
from k3_node.models import MEGNetBlock
|
|
116
|
+
|
|
117
|
+
edge_index = np.array([[0, 1, 1, 2, 2, 3, 3, 0], [1, 0, 2, 1, 3, 2, 0, 3]]) # 4 atoms, 8 bonds
|
|
118
|
+
node_feat = np.random.rand(4, 16).astype("float32")
|
|
119
|
+
edge_feat = np.random.rand(8, 16).astype("float32")
|
|
120
|
+
state_feat = np.random.rand(1, 16).astype("float32") # one global state per structure
|
|
121
|
+
batch, edge_batch = np.zeros(4, dtype="int32"), np.zeros(8, dtype="int32")
|
|
122
|
+
|
|
123
|
+
block = MEGNetBlock(dims=[16, 32, 16], conv_hiddens=[32, 16])
|
|
124
|
+
edge_out, node_out, state_out = block(edge_index, edge_feat, node_feat, state_feat, batch=batch,
|
|
125
|
+
edge_batch=edge_batch, num_nodes=4, num_graphs=1)
|
|
126
|
+
print(tuple(edge_out.shape), tuple(node_out.shape), tuple(state_out.shape)) # (8, 16) (4, 16) (1, 16)
|
|
127
|
+
```
|
|
128
|
+
"""
|
|
129
|
+
|
|
130
|
+
def __init__(
|
|
131
|
+
self,
|
|
132
|
+
dims: Sequence[int],
|
|
133
|
+
conv_hiddens: Sequence[int],
|
|
134
|
+
activation: str = "softplus2",
|
|
135
|
+
dropout: float = 0.0,
|
|
136
|
+
skip: bool = True,
|
|
137
|
+
**kwargs,
|
|
138
|
+
):
|
|
139
|
+
super().__init__(**kwargs)
|
|
140
|
+
self.skip = skip
|
|
141
|
+
self.dims = list(dims)
|
|
142
|
+
self.has_dense = len(self.dims) > 1
|
|
143
|
+
conv_dim = self.dims[-1]
|
|
144
|
+
out_dim = conv_hiddens[-1]
|
|
145
|
+
|
|
146
|
+
if self.has_dense:
|
|
147
|
+
self.edge_func = MLP(self.dims, activation=activation, activate_last=True)
|
|
148
|
+
self.node_func = MLP(self.dims, activation=activation, activate_last=True)
|
|
149
|
+
self.state_func = MLP(self.dims, activation=activation, activate_last=True)
|
|
150
|
+
else:
|
|
151
|
+
self.edge_func = lambda x: x
|
|
152
|
+
self.node_func = lambda x: x
|
|
153
|
+
self.state_func = lambda x: x
|
|
154
|
+
|
|
155
|
+
edge_in = 2 * conv_dim + conv_dim + conv_dim
|
|
156
|
+
node_in = out_dim + conv_dim + conv_dim
|
|
157
|
+
state_in = out_dim + out_dim + conv_dim
|
|
158
|
+
|
|
159
|
+
self.conv = MEGNetGraphConv(
|
|
160
|
+
edge_dims=[edge_in, *conv_hiddens],
|
|
161
|
+
node_dims=[node_in, *conv_hiddens],
|
|
162
|
+
state_dims=[state_in, *conv_hiddens],
|
|
163
|
+
activation=activation,
|
|
164
|
+
)
|
|
165
|
+
self.dropout = layers.Dropout(dropout) if dropout > 0.0 else None
|
|
166
|
+
|
|
167
|
+
def call(
|
|
168
|
+
self,
|
|
169
|
+
edge_index,
|
|
170
|
+
edge_feat,
|
|
171
|
+
node_feat,
|
|
172
|
+
state_feat,
|
|
173
|
+
batch=None,
|
|
174
|
+
edge_batch=None,
|
|
175
|
+
num_nodes: Optional[int] = None,
|
|
176
|
+
num_graphs: Optional[int] = None,
|
|
177
|
+
training=None,
|
|
178
|
+
):
|
|
179
|
+
in_edge, in_node, in_state = edge_feat, node_feat, state_feat
|
|
180
|
+
|
|
181
|
+
edge_feat = self.edge_func(edge_feat)
|
|
182
|
+
node_feat = self.node_func(node_feat)
|
|
183
|
+
state_feat = self.state_func(state_feat)
|
|
184
|
+
|
|
185
|
+
edge_feat, node_feat, state_feat = self.conv(
|
|
186
|
+
edge_index, edge_feat, node_feat, state_feat,
|
|
187
|
+
batch=batch, edge_batch=edge_batch, num_nodes=num_nodes, num_graphs=num_graphs
|
|
188
|
+
)
|
|
189
|
+
|
|
190
|
+
if self.dropout is not None:
|
|
191
|
+
edge_feat = self.dropout(edge_feat, training=training)
|
|
192
|
+
node_feat = self.dropout(node_feat, training=training)
|
|
193
|
+
state_feat = self.dropout(state_feat, training=training)
|
|
194
|
+
|
|
195
|
+
if self.skip:
|
|
196
|
+
edge_feat = edge_feat + in_edge
|
|
197
|
+
node_feat = node_feat + in_node
|
|
198
|
+
state_feat = state_feat + in_state
|
|
199
|
+
|
|
200
|
+
return edge_feat, node_feat, state_feat
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
class MEGNet(keras.Model):
|
|
204
|
+
"""MEGNet materials graph network supporting TensorFlow, PyTorch, and JAX.
|
|
205
|
+
|
|
206
|
+
Example:
|
|
207
|
+
```python
|
|
208
|
+
import numpy as np
|
|
209
|
+
from k3_node.models import MEGNet
|
|
210
|
+
|
|
211
|
+
# A 4-atom structure: positions, bonds (listed in both directions) and atomic numbers
|
|
212
|
+
structure = {
|
|
213
|
+
"pos": np.array([[0.0, 0.0, 0.0], [1.0, 0.5, 0.0], [0.5, 1.2, 0.8], [1.5, 1.5, 1.0]], dtype="float32"),
|
|
214
|
+
"edge_index": np.array([[0, 1, 1, 2, 2, 3, 3, 0], [1, 0, 2, 1, 3, 2, 0, 3]]),
|
|
215
|
+
"line_edge_index": np.array([[0, 1, 2, 3], [1, 2, 3, 0]]), # bond pairs forming angles
|
|
216
|
+
"node_type": np.array([6, 8, 1, 6]), # atomic numbers
|
|
217
|
+
"batch": np.zeros(4, dtype="int32"), # all atoms belong to structure 0
|
|
218
|
+
"state_attr": np.zeros((1, 2), dtype="float32"), # global state features
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
model = MEGNet(dim_node_embedding=16, dim_edge_embedding=20, dim_state_embedding=2, nblocks=2,
|
|
222
|
+
hidden_layer_sizes_input=(32, 16), hidden_layer_sizes_conv=(32, 16),
|
|
223
|
+
hidden_layer_sizes_output=(16,))
|
|
224
|
+
energy = model(structure) # predicted property (e.g. energy) of the structure
|
|
225
|
+
print(tuple(energy.shape)) # (1,)
|
|
226
|
+
```
|
|
227
|
+
"""
|
|
228
|
+
|
|
229
|
+
def __init__(
|
|
230
|
+
self,
|
|
231
|
+
dim_node_embedding: int = 16,
|
|
232
|
+
dim_edge_embedding: int = 100,
|
|
233
|
+
dim_state_embedding: int = 2,
|
|
234
|
+
ntypes_state: Optional[int] = None,
|
|
235
|
+
nblocks: int = 3,
|
|
236
|
+
hidden_layer_sizes_input: Sequence[int] = (64, 32),
|
|
237
|
+
hidden_layer_sizes_conv: Sequence[int] = (64, 64, 32),
|
|
238
|
+
hidden_layer_sizes_output: Sequence[int] = (32, 16),
|
|
239
|
+
nlayers_set2set: int = 1,
|
|
240
|
+
niters_set2set: int = 2,
|
|
241
|
+
activation_type: str = "softplus2",
|
|
242
|
+
is_classification: bool = False,
|
|
243
|
+
include_state: bool = True,
|
|
244
|
+
dropout: float = 0.0,
|
|
245
|
+
cutoff: float = 4.0,
|
|
246
|
+
gauss_width: float = 0.5,
|
|
247
|
+
ntypes_node: int = 95,
|
|
248
|
+
**kwargs,
|
|
249
|
+
):
|
|
250
|
+
super().__init__(**kwargs)
|
|
251
|
+
self.cutoff = cutoff
|
|
252
|
+
self.is_classification = is_classification
|
|
253
|
+
self.include_state = include_state
|
|
254
|
+
|
|
255
|
+
self.bond_expansion = BondExpansion(
|
|
256
|
+
rbf_type="Gaussian",
|
|
257
|
+
initial=0.0,
|
|
258
|
+
final=cutoff + 1.0,
|
|
259
|
+
num_centers=dim_edge_embedding,
|
|
260
|
+
width=gauss_width,
|
|
261
|
+
)
|
|
262
|
+
|
|
263
|
+
node_dims = [dim_node_embedding, *hidden_layer_sizes_input]
|
|
264
|
+
edge_dims = [dim_edge_embedding, *hidden_layer_sizes_input]
|
|
265
|
+
state_dims = [dim_state_embedding, *hidden_layer_sizes_input]
|
|
266
|
+
|
|
267
|
+
self.embedding = EmbeddingBlock(
|
|
268
|
+
degree_rbf=dim_edge_embedding,
|
|
269
|
+
dim_node_embedding=dim_node_embedding,
|
|
270
|
+
ntypes_node=ntypes_node,
|
|
271
|
+
ntypes_state=ntypes_state,
|
|
272
|
+
include_state=include_state,
|
|
273
|
+
dim_state_embedding=dim_state_embedding,
|
|
274
|
+
activation=activation_type,
|
|
275
|
+
)
|
|
276
|
+
|
|
277
|
+
self.edge_encoder = MLP(edge_dims, activation=activation_type, activate_last=True)
|
|
278
|
+
self.node_encoder = MLP(node_dims, activation=activation_type, activate_last=True)
|
|
279
|
+
self.state_encoder = MLP(state_dims, activation=activation_type, activate_last=True)
|
|
280
|
+
|
|
281
|
+
dim_blocks_in = hidden_layer_sizes_input[-1]
|
|
282
|
+
dim_blocks_out = hidden_layer_sizes_conv[-1]
|
|
283
|
+
|
|
284
|
+
self.blocks = []
|
|
285
|
+
for i in range(nblocks):
|
|
286
|
+
dims = [dim_blocks_in] if i == 0 else [dim_blocks_out, *hidden_layer_sizes_input]
|
|
287
|
+
self.blocks.append(
|
|
288
|
+
MEGNetBlock(
|
|
289
|
+
dims=dims,
|
|
290
|
+
conv_hiddens=hidden_layer_sizes_conv,
|
|
291
|
+
activation=activation_type,
|
|
292
|
+
dropout=dropout,
|
|
293
|
+
skip=True,
|
|
294
|
+
)
|
|
295
|
+
)
|
|
296
|
+
|
|
297
|
+
self.node_s2s = Set2SetReadOut(dim_blocks_out, processing_steps=niters_set2set, num_layers=nlayers_set2set)
|
|
298
|
+
self.edge_s2s = EdgeSet2Set(dim_blocks_out, n_iters=niters_set2set, n_layers=nlayers_set2set)
|
|
299
|
+
|
|
300
|
+
self.output_proj = MLP(
|
|
301
|
+
dims=[2 * 2 * dim_blocks_out + dim_blocks_out, *hidden_layer_sizes_output, 1],
|
|
302
|
+
activation=activation_type,
|
|
303
|
+
activate_last=False,
|
|
304
|
+
)
|
|
305
|
+
|
|
306
|
+
def _unpack_inputs(self, inputs):
|
|
307
|
+
if isinstance(inputs, dict):
|
|
308
|
+
pos = inputs.get("pos")
|
|
309
|
+
edge_index = inputs.get("edge_index")
|
|
310
|
+
node_type = inputs.get("node_type", inputs.get("z"))
|
|
311
|
+
state_attr = inputs.get("state_attr", None)
|
|
312
|
+
pbc_offshift = inputs.get("pbc_offshift", None)
|
|
313
|
+
batch = inputs.get("batch", None)
|
|
314
|
+
num_graphs = inputs.get("num_graphs", None)
|
|
315
|
+
return pos, edge_index, node_type, state_attr, pbc_offshift, batch, num_graphs
|
|
316
|
+
elif isinstance(inputs, (tuple, list)):
|
|
317
|
+
pos = inputs[0]
|
|
318
|
+
edge_index = inputs[1]
|
|
319
|
+
node_type = inputs[2]
|
|
320
|
+
state_attr = inputs[3] if len(inputs) > 3 else None
|
|
321
|
+
pbc_offshift = inputs[4] if len(inputs) > 4 else None
|
|
322
|
+
batch = inputs[5] if len(inputs) > 5 else None
|
|
323
|
+
num_graphs = inputs[6] if len(inputs) > 6 else None
|
|
324
|
+
return pos, edge_index, node_type, state_attr, pbc_offshift, batch, num_graphs
|
|
325
|
+
return inputs, None, None, None, None, None, None
|
|
326
|
+
|
|
327
|
+
def call(self, inputs, edge_index=None, node_type=None, state_attr=None, pbc_offshift=None, batch=None, num_graphs=None, training=None):
|
|
328
|
+
if edge_index is None:
|
|
329
|
+
(
|
|
330
|
+
pos,
|
|
331
|
+
edge_index,
|
|
332
|
+
node_type_in,
|
|
333
|
+
state_attr_in,
|
|
334
|
+
pbc_offshift_in,
|
|
335
|
+
batch_in,
|
|
336
|
+
num_graphs_in,
|
|
337
|
+
) = self._unpack_inputs(inputs)
|
|
338
|
+
if node_type is None:
|
|
339
|
+
node_type = node_type_in
|
|
340
|
+
if state_attr is None:
|
|
341
|
+
state_attr = state_attr_in
|
|
342
|
+
if pbc_offshift is None:
|
|
343
|
+
pbc_offshift = pbc_offshift_in
|
|
344
|
+
if batch is None:
|
|
345
|
+
batch = batch_in
|
|
346
|
+
if num_graphs is None:
|
|
347
|
+
num_graphs = num_graphs_in
|
|
348
|
+
else:
|
|
349
|
+
pos = inputs
|
|
350
|
+
|
|
351
|
+
num_nodes = ops.shape(pos)[0]
|
|
352
|
+
if batch is None:
|
|
353
|
+
batch = ops.zeros((num_nodes,), dtype="int32")
|
|
354
|
+
else:
|
|
355
|
+
batch = ops.cast(batch, "int32")
|
|
356
|
+
n_graphs = infer_num_graphs(batch=batch, num_graphs=num_graphs, state_attr=state_attr)
|
|
357
|
+
|
|
358
|
+
src = ops.cast(edge_index[0], "int32")
|
|
359
|
+
src_safe = ops.clip(src, 0, ops.maximum(ops.shape(batch)[0] - 1, 0))
|
|
360
|
+
edge_batch = ops.take(batch, src_safe, axis=0)
|
|
361
|
+
|
|
362
|
+
# 1. Expand pairwise distances
|
|
363
|
+
_, bond_dist = compute_pair_vector_and_distance(pos, edge_index, pbc_offshift)
|
|
364
|
+
edge_attr = self.bond_expansion(bond_dist)
|
|
365
|
+
|
|
366
|
+
# 2. State attributes
|
|
367
|
+
if state_attr is None:
|
|
368
|
+
state_attr = ops.zeros((n_graphs, 2), dtype="float32")
|
|
369
|
+
|
|
370
|
+
# 3. Embeddings & encoders
|
|
371
|
+
node_feat, edge_feat, state_feat = self.embedding(node_type, edge_attr, state_attr)
|
|
372
|
+
edge_feat = self.edge_encoder(edge_feat)
|
|
373
|
+
node_feat = self.node_encoder(node_feat)
|
|
374
|
+
state_feat = self.state_encoder(state_feat)
|
|
375
|
+
|
|
376
|
+
# 4. Convolution blocks
|
|
377
|
+
for block in self.blocks:
|
|
378
|
+
edge_feat, node_feat, state_feat = block(
|
|
379
|
+
edge_index, edge_feat, node_feat, state_feat,
|
|
380
|
+
batch=batch, edge_batch=edge_batch, num_nodes=num_nodes, num_graphs=n_graphs,
|
|
381
|
+
training=training,
|
|
382
|
+
)
|
|
383
|
+
|
|
384
|
+
# 5. Readout pooling
|
|
385
|
+
node_vec = self.node_s2s(node_feat, batch=batch, num_graphs=n_graphs)
|
|
386
|
+
edge_vec = self.edge_s2s(edge_feat, edge_batch=edge_batch, num_graphs=n_graphs)
|
|
387
|
+
state_vec = ops.reshape(state_feat, (n_graphs, -1))
|
|
388
|
+
|
|
389
|
+
vec = ops.concatenate([node_vec, edge_vec, state_vec], axis=-1)
|
|
390
|
+
output = self.output_proj(vec)
|
|
391
|
+
if self.is_classification:
|
|
392
|
+
output = ops.sigmoid(output)
|
|
393
|
+
|
|
394
|
+
return ops.squeeze(output, axis=-1)
|
|
395
|
+
|
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
"""Multi-backend Keras 3 implementation of QET (Charge-Equilibration TensorNet)."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import math
|
|
6
|
+
from typing import Sequence, Optional, Union, Tuple, Dict, Any, Literal
|
|
7
|
+
import keras
|
|
8
|
+
from keras import layers, ops
|
|
9
|
+
import numpy as np
|
|
10
|
+
|
|
11
|
+
from .core import MLP, scatter_add, infer_num_graphs
|
|
12
|
+
from .basis import compute_pair_vector_and_distance, polynomial_cutoff
|
|
13
|
+
from .tensornet import TensorNet
|
|
14
|
+
from .readout import ReduceReadOut
|
|
15
|
+
from k3_node.ops.segment import segment_sum
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class LinearQeq(layers.Layer):
|
|
19
|
+
"""Closed-form charge-equilibration solver via Lagrange multipliers.
|
|
20
|
+
|
|
21
|
+
Example:
|
|
22
|
+
```python
|
|
23
|
+
import numpy as np
|
|
24
|
+
from k3_node.models import LinearQeq
|
|
25
|
+
|
|
26
|
+
chi = np.random.rand(4).astype("float32") # electronegativities
|
|
27
|
+
hardness = np.random.rand(4).astype("float32") + 1.0
|
|
28
|
+
batch = np.zeros(4, dtype="int32")
|
|
29
|
+
charges = LinearQeq()(chi, hardness, batch=batch, num_graphs=1) # charges summing to the total charge
|
|
30
|
+
print(tuple(charges.shape)) # (4,)
|
|
31
|
+
```
|
|
32
|
+
"""
|
|
33
|
+
|
|
34
|
+
def __init__(self, **kwargs):
|
|
35
|
+
super().__init__(**kwargs)
|
|
36
|
+
self._eps = 1e-12
|
|
37
|
+
|
|
38
|
+
def call(self, chi, hardness, batch=None, total_charge=None, num_graphs=None):
|
|
39
|
+
num_nodes = ops.shape(chi)[0]
|
|
40
|
+
if batch is None:
|
|
41
|
+
batch = ops.zeros((num_nodes,), dtype="int32")
|
|
42
|
+
else:
|
|
43
|
+
batch = ops.cast(batch, "int32")
|
|
44
|
+
n_graphs = infer_num_graphs(batch=batch, num_graphs=num_graphs)
|
|
45
|
+
|
|
46
|
+
if total_charge is None:
|
|
47
|
+
Q = ops.zeros((n_graphs,), dtype=chi.dtype)
|
|
48
|
+
else:
|
|
49
|
+
Q = ops.cast(total_charge, chi.dtype)
|
|
50
|
+
if len(ops.shape(Q)) == 0:
|
|
51
|
+
Q = ops.broadcast_to(Q, (n_graphs,))
|
|
52
|
+
|
|
53
|
+
inv_eta = 1.0 / ops.maximum(hardness, 1e-6)
|
|
54
|
+
chi_inv_eta = chi * inv_eta
|
|
55
|
+
|
|
56
|
+
batch_clipped = ops.clip(batch, 0, ops.maximum(n_graphs - 1, 0))
|
|
57
|
+
sum_inv_eta = segment_sum(inv_eta, batch_clipped, num_segments=n_graphs)
|
|
58
|
+
sum_chi_inv_eta = segment_sum(chi_inv_eta, batch_clipped, num_segments=n_graphs)
|
|
59
|
+
|
|
60
|
+
denom = ops.maximum(sum_inv_eta, self._eps)
|
|
61
|
+
lambda_val = (Q + sum_chi_inv_eta) / denom
|
|
62
|
+
lambda_per_node = ops.take(lambda_val, batch_clipped, axis=0)
|
|
63
|
+
|
|
64
|
+
q_star = -chi_inv_eta + inv_eta * lambda_per_node
|
|
65
|
+
return q_star
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
class ElectrostaticPotential(layers.Layer):
|
|
69
|
+
"""Gaussian-smeared Coulomb electrostatic potential calculation.
|
|
70
|
+
|
|
71
|
+
Example:
|
|
72
|
+
```python
|
|
73
|
+
import numpy as np
|
|
74
|
+
from k3_node.models import ElectrostaticPotential
|
|
75
|
+
|
|
76
|
+
edge_index = np.array([[0, 1, 1, 2, 2, 3, 3, 0], [1, 0, 2, 1, 3, 2, 0, 3]])
|
|
77
|
+
charge = np.array([0.2, -0.4, 0.1, 0.1], dtype="float32")
|
|
78
|
+
sigma = np.ones(4, dtype="float32") # Gaussian charge widths
|
|
79
|
+
bond_dists = np.random.rand(8).astype("float32") * 3.0
|
|
80
|
+
potential = ElectrostaticPotential(cutoff=5.0)
|
|
81
|
+
print(tuple(potential(edge_index, charge, sigma, bond_dists, num_nodes=4).shape)) # (4,)
|
|
82
|
+
```
|
|
83
|
+
"""
|
|
84
|
+
|
|
85
|
+
def __init__(self, cutoff: float = 5.0, **kwargs):
|
|
86
|
+
super().__init__(**kwargs)
|
|
87
|
+
self.cutoff = cutoff
|
|
88
|
+
self._inv_sqrt2 = float(1.0 / math.sqrt(2.0))
|
|
89
|
+
|
|
90
|
+
def call(self, edge_index, charge, sigma, bond_dists, num_nodes: Optional[int] = None):
|
|
91
|
+
src = ops.cast(edge_index[0], "int32")
|
|
92
|
+
dst = ops.cast(edge_index[1], "int32")
|
|
93
|
+
|
|
94
|
+
num_c = ops.shape(charge)[0]
|
|
95
|
+
src_c = ops.clip(src, 0, ops.maximum(num_c - 1, 0))
|
|
96
|
+
dst_c = ops.clip(dst, 0, ops.maximum(num_c - 1, 0))
|
|
97
|
+
|
|
98
|
+
q_j = ops.take(charge, dst_c, axis=0)
|
|
99
|
+
s_i = ops.take(sigma, src_c, axis=0)
|
|
100
|
+
s_j = ops.take(sigma, dst_c, axis=0)
|
|
101
|
+
|
|
102
|
+
gamma_ij = ops.sqrt(ops.maximum(s_i ** 2 + s_j ** 2, 1e-8))
|
|
103
|
+
d_safe = ops.maximum(bond_dists, 1e-7)
|
|
104
|
+
arg = (d_safe * self._inv_sqrt2) / gamma_ij
|
|
105
|
+
erf_val = ops.erf(arg)
|
|
106
|
+
f_cut = polynomial_cutoff(bond_dists, self.cutoff, exponent=3)
|
|
107
|
+
|
|
108
|
+
v_ij = (q_j / d_safe) * erf_val * f_cut
|
|
109
|
+
return scatter_add(v_ij, src_c, num_segments=num_nodes)
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
class QET(TensorNet):
|
|
113
|
+
"""Charge-Equilibration TensorNet (QET) model.
|
|
114
|
+
|
|
115
|
+
Example:
|
|
116
|
+
```python
|
|
117
|
+
import numpy as np
|
|
118
|
+
from k3_node.models import QET
|
|
119
|
+
|
|
120
|
+
# A 4-atom structure: positions, bonds (listed in both directions) and atomic numbers
|
|
121
|
+
structure = {
|
|
122
|
+
"pos": np.array([[0.0, 0.0, 0.0], [1.0, 0.5, 0.0], [0.5, 1.2, 0.8], [1.5, 1.5, 1.0]], dtype="float32"),
|
|
123
|
+
"edge_index": np.array([[0, 1, 1, 2, 2, 3, 3, 0], [1, 0, 2, 1, 3, 2, 0, 3]]),
|
|
124
|
+
"line_edge_index": np.array([[0, 1, 2, 3], [1, 2, 3, 0]]), # bond pairs forming angles
|
|
125
|
+
"node_type": np.array([6, 8, 1, 6]), # atomic numbers
|
|
126
|
+
"batch": np.zeros(4, dtype="int32"), # all atoms belong to structure 0
|
|
127
|
+
"state_attr": np.zeros((1, 2), dtype="float32"), # global state features
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
model = QET(units=16, nblocks=2, num_rbf=16)
|
|
131
|
+
energy = model(structure) # predicted property (e.g. energy) of the structure
|
|
132
|
+
print(tuple(energy.shape)) # (1,)
|
|
133
|
+
```
|
|
134
|
+
"""
|
|
135
|
+
|
|
136
|
+
def __init__(
|
|
137
|
+
self,
|
|
138
|
+
units: int = 64,
|
|
139
|
+
nblocks: int = 2,
|
|
140
|
+
num_rbf: int = 32,
|
|
141
|
+
cutoff: float = 5.0,
|
|
142
|
+
ntypes_node: int = 95,
|
|
143
|
+
activation_type: str = "swish",
|
|
144
|
+
**kwargs,
|
|
145
|
+
):
|
|
146
|
+
super().__init__(
|
|
147
|
+
units=units,
|
|
148
|
+
nblocks=nblocks,
|
|
149
|
+
num_rbf=num_rbf,
|
|
150
|
+
cutoff=cutoff,
|
|
151
|
+
ntypes_node=ntypes_node,
|
|
152
|
+
activation_type=activation_type,
|
|
153
|
+
**kwargs,
|
|
154
|
+
)
|
|
155
|
+
self.qeq_solver = LinearQeq()
|
|
156
|
+
self.elec_pot = ElectrostaticPotential(cutoff=cutoff)
|
|
157
|
+
|
|
158
|
+
self.chi_head = MLP([units, 32, 1], activation=activation_type, activate_last=False)
|
|
159
|
+
self.hardness_head = MLP([units, 32, 1], activation=activation_type, activate_last=False)
|
|
160
|
+
self.sigma_head = MLP([units, 32, 1], activation=activation_type, activate_last=False)
|
|
161
|
+
|
|
162
|
+
self.energy_head = MLP([units + 2, units, 1], activation=activation_type, activate_last=False)
|
|
163
|
+
self.qet_pool = ReduceReadOut(op="sum")
|
|
164
|
+
|
|
165
|
+
def call(self, inputs, edge_index=None, node_type=None, pbc_offshift=None, batch=None, total_charge=None, num_graphs=None, state_attr=None):
|
|
166
|
+
if edge_index is None:
|
|
167
|
+
(
|
|
168
|
+
pos,
|
|
169
|
+
edge_index,
|
|
170
|
+
node_type_in,
|
|
171
|
+
pbc_offshift_in,
|
|
172
|
+
batch_in,
|
|
173
|
+
num_graphs_in,
|
|
174
|
+
state_attr_in,
|
|
175
|
+
) = self._unpack_inputs(inputs)
|
|
176
|
+
if node_type is None:
|
|
177
|
+
node_type = node_type_in
|
|
178
|
+
if pbc_offshift is None:
|
|
179
|
+
pbc_offshift = pbc_offshift_in
|
|
180
|
+
if batch is None:
|
|
181
|
+
batch = batch_in
|
|
182
|
+
if num_graphs is None:
|
|
183
|
+
num_graphs = num_graphs_in
|
|
184
|
+
if state_attr is None:
|
|
185
|
+
state_attr = state_attr_in
|
|
186
|
+
else:
|
|
187
|
+
pos = inputs
|
|
188
|
+
|
|
189
|
+
num_nodes = ops.shape(pos)[0]
|
|
190
|
+
if batch is None:
|
|
191
|
+
batch = ops.zeros((num_nodes,), dtype="int32")
|
|
192
|
+
else:
|
|
193
|
+
batch = ops.cast(batch, "int32")
|
|
194
|
+
n_graphs = infer_num_graphs(batch=batch, num_graphs=num_graphs, state_attr=state_attr)
|
|
195
|
+
|
|
196
|
+
vec, bond_dists = compute_pair_vector_and_distance(pos, edge_index, pbc_offshift)
|
|
197
|
+
edge_attr = self.bond_expansion(bond_dists)
|
|
198
|
+
|
|
199
|
+
X = self.embedding(node_type, edge_index, edge_attr, bond_dists, vec)
|
|
200
|
+
for interaction in self.interactions:
|
|
201
|
+
X = interaction(edge_index, bond_dists, edge_attr, X)
|
|
202
|
+
|
|
203
|
+
from .core import decompose_tensor, tensor_norm
|
|
204
|
+
scalars, skew, traceless = decompose_tensor(X)
|
|
205
|
+
norms = ops.concatenate([tensor_norm(scalars), tensor_norm(skew), tensor_norm(traceless)], axis=-1)
|
|
206
|
+
node_feats = self.node_proj(self.out_norm(norms))
|
|
207
|
+
|
|
208
|
+
chi = ops.squeeze(self.chi_head(node_feats), axis=-1)
|
|
209
|
+
hardness = ops.softplus(ops.squeeze(self.hardness_head(node_feats), axis=-1)) + 0.1
|
|
210
|
+
sigma = ops.softplus(ops.squeeze(self.sigma_head(node_feats), axis=-1)) + 0.1
|
|
211
|
+
|
|
212
|
+
charges = self.qeq_solver(chi, hardness, batch=batch, total_charge=total_charge, num_graphs=n_graphs)
|
|
213
|
+
v_elec = self.elec_pot(edge_index, charges, sigma, bond_dists, num_nodes=num_nodes)
|
|
214
|
+
|
|
215
|
+
combined = ops.concatenate([node_feats, ops.expand_dims(charges, axis=-1), ops.expand_dims(v_elec, axis=-1)], axis=-1)
|
|
216
|
+
e_atom = self.energy_head(combined)
|
|
217
|
+
total_energy = self.qet_pool(e_atom, batch=batch, num_graphs=n_graphs)
|
|
218
|
+
|
|
219
|
+
return ops.squeeze(total_energy, axis=-1)
|
|
220
|
+
|