mirror of
https://github.com/dmlc/dgl.git
synced 2026-06-06 20:04:24 +08:00
c2e61ce10b
* upd * simplify * further simplify * lint * doc * upd * upd * upd * upd * upd * upd * upd * lint * rename format * upd * lint * upd * upd * upd * udp * debug * upd * upd * upd * upd * upd * 无可厚非吧 * 中三边肥 * 你一定要喊吗 * lint * upd * upd * upd * upd * upd * upd * upd * Update unit_graph.h Co-authored-by: Zihao Ye <yzh119@192.168.0.110> Co-authored-by: Minjie Wang <wmjlyjemaine@gmail.com> Co-authored-by: Quan (Andy) Gan <coin2028@hotmail.com>
141 lines
3.2 KiB
ReStructuredText
141 lines
3.2 KiB
ReStructuredText
.. _apiheterograph:
|
|
|
|
dgl.DGLHeteroGraph
|
|
=====================================================
|
|
|
|
.. currentmodule:: dgl
|
|
.. autoclass:: DGLHeteroGraph
|
|
|
|
Conversion to and from heterogeneous graphs
|
|
-----------------------------------------
|
|
|
|
.. automodule:: dgl.convert
|
|
.. currentmodule:: dgl
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
graph
|
|
bipartite
|
|
hetero_from_relations
|
|
heterograph
|
|
to_hetero
|
|
to_homo
|
|
to_networkx
|
|
DGLHeteroGraph.adjacency_matrix
|
|
DGLHeteroGraph.incidence_matrix
|
|
|
|
Querying metagraph structure
|
|
----------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLHeteroGraph.ntypes
|
|
DGLHeteroGraph.etypes
|
|
DGLHeteroGraph.canonical_etypes
|
|
DGLHeteroGraph.metagraph
|
|
DGLHeteroGraph.to_canonical_etype
|
|
DGLHeteroGraph.get_ntype_id
|
|
DGLHeteroGraph.get_etype_id
|
|
|
|
Querying graph structure
|
|
------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLHeteroGraph.number_of_nodes
|
|
DGLHeteroGraph.number_of_edges
|
|
DGLHeteroGraph.is_multigraph
|
|
DGLHeteroGraph.is_readonly
|
|
DGLHeteroGraph.has_node
|
|
DGLHeteroGraph.has_nodes
|
|
DGLHeteroGraph.has_edge_between
|
|
DGLHeteroGraph.has_edges_between
|
|
DGLHeteroGraph.predecessors
|
|
DGLHeteroGraph.successors
|
|
DGLHeteroGraph.edge_id
|
|
DGLHeteroGraph.edge_ids
|
|
DGLHeteroGraph.find_edges
|
|
DGLHeteroGraph.in_edges
|
|
DGLHeteroGraph.out_edges
|
|
DGLHeteroGraph.all_edges
|
|
DGLHeteroGraph.in_degree
|
|
DGLHeteroGraph.in_degrees
|
|
DGLHeteroGraph.out_degree
|
|
DGLHeteroGraph.out_degrees
|
|
|
|
Querying and manipulating sparse format
|
|
---------------------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLHeteroGraph.format_in_use
|
|
DGLHeteroGraph.restrict_format
|
|
DGLHeteroGraph.to_format
|
|
|
|
Querying and manipulating index data type
|
|
-----------------------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLHeteroGraph.idtype
|
|
DGLHeteroGraph.long
|
|
DGLHeteroGraph.int
|
|
|
|
Using Node/edge features
|
|
------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLHeteroGraph.nodes
|
|
DGLHeteroGraph.ndata
|
|
DGLHeteroGraph.edges
|
|
DGLHeteroGraph.edata
|
|
DGLHeteroGraph.node_attr_schemes
|
|
DGLHeteroGraph.edge_attr_schemes
|
|
DGLHeteroGraph.set_n_initializer
|
|
DGLHeteroGraph.set_e_initializer
|
|
DGLHeteroGraph.local_var
|
|
DGLHeteroGraph.local_scope
|
|
|
|
Transforming graph
|
|
------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLHeteroGraph.subgraph
|
|
DGLHeteroGraph.edge_subgraph
|
|
DGLHeteroGraph.node_type_subgraph
|
|
DGLHeteroGraph.edge_type_subgraph
|
|
|
|
Computing with DGLHeteroGraph
|
|
-----------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLHeteroGraph.apply_nodes
|
|
DGLHeteroGraph.apply_edges
|
|
DGLHeteroGraph.group_apply_edges
|
|
DGLHeteroGraph.send
|
|
DGLHeteroGraph.recv
|
|
DGLHeteroGraph.multi_recv
|
|
DGLHeteroGraph.send_and_recv
|
|
DGLHeteroGraph.multi_send_and_recv
|
|
DGLHeteroGraph.pull
|
|
DGLHeteroGraph.multi_pull
|
|
DGLHeteroGraph.push
|
|
DGLHeteroGraph.update_all
|
|
DGLHeteroGraph.multi_update_all
|
|
DGLHeteroGraph.prop_nodes
|
|
DGLHeteroGraph.prop_edges
|
|
DGLHeteroGraph.filter_nodes
|
|
DGLHeteroGraph.filter_edges
|
|
DGLHeteroGraph.to
|