mirror of
https://github.com/dmlc/dgl.git
synced 2026-06-05 19:54:25 +08:00
93ac29ce34
* upd * upd * upd * lint * fix * fix test * fix * fix * upd * upd * upd * upd * upd * upd * upd * upd * upd * upd * upd tutorial * upd * upd * fix kg * upd doc organization * refresh test * upd * refactor doc * fix lint Co-authored-by: Minjie Wang <minjie.wang@nyu.edu>
170 lines
3.4 KiB
ReStructuredText
170 lines
3.4 KiB
ReStructuredText
.. _apigraph:
|
|
|
|
dgl.DGLGraph
|
|
=========================================
|
|
|
|
.. currentmodule:: dgl
|
|
.. autoclass:: DGLGraph
|
|
|
|
Adding nodes and edges
|
|
----------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLGraph.add_nodes
|
|
DGLGraph.add_edge
|
|
DGLGraph.add_edges
|
|
DGLGraph.clear
|
|
|
|
Querying graph structure
|
|
------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLGraph.number_of_nodes
|
|
DGLGraph.number_of_edges
|
|
DGLGraph.__len__
|
|
DGLGraph.is_multigraph
|
|
DGLGraph.has_node
|
|
DGLGraph.has_nodes
|
|
DGLGraph.__contains__
|
|
DGLGraph.has_edge_between
|
|
DGLGraph.has_edges_between
|
|
DGLGraph.predecessors
|
|
DGLGraph.successors
|
|
DGLGraph.edge_id
|
|
DGLGraph.edge_ids
|
|
DGLGraph.find_edges
|
|
DGLGraph.in_edges
|
|
DGLGraph.out_edges
|
|
DGLGraph.all_edges
|
|
DGLGraph.in_degree
|
|
DGLGraph.in_degrees
|
|
DGLGraph.out_degree
|
|
DGLGraph.out_degrees
|
|
|
|
Querying batch summary
|
|
----------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLGraph.batch_size
|
|
DGLGraph.batch_num_nodes
|
|
DGLGraph.batch_num_edges
|
|
|
|
Querying sub-graph/parent-graph belonging information
|
|
-----------------------------------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLGraph.parent
|
|
|
|
Removing nodes and edges
|
|
------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLGraph.remove_nodes
|
|
DGLGraph.remove_edges
|
|
|
|
Transforming graph
|
|
------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLGraph.subgraph
|
|
DGLGraph.subgraphs
|
|
DGLGraph.edge_subgraph
|
|
DGLGraph.line_graph
|
|
DGLGraph.reverse
|
|
DGLGraph.readonly
|
|
DGLGraph.flatten
|
|
DGLGraph.detach_parent
|
|
|
|
Converting from/to other format
|
|
-------------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLGraph.to_networkx
|
|
DGLGraph.from_networkx
|
|
DGLGraph.from_scipy_sparse_matrix
|
|
DGLGraph.adjacency_matrix
|
|
DGLGraph.adjacency_matrix_scipy
|
|
DGLGraph.incidence_matrix
|
|
|
|
Using Node/edge features
|
|
------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLGraph.nodes
|
|
DGLGraph.edges
|
|
DGLGraph.ndata
|
|
DGLGraph.edata
|
|
DGLGraph.node_attr_schemes
|
|
DGLGraph.edge_attr_schemes
|
|
DGLGraph.set_n_initializer
|
|
DGLGraph.set_e_initializer
|
|
DGLGraph.local_var
|
|
DGLGraph.local_scope
|
|
|
|
Computing with DGLGraph
|
|
-----------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLGraph.register_message_func
|
|
DGLGraph.register_reduce_func
|
|
DGLGraph.register_apply_node_func
|
|
DGLGraph.register_apply_edge_func
|
|
DGLGraph.apply_nodes
|
|
DGLGraph.apply_edges
|
|
DGLGraph.group_apply_edges
|
|
DGLGraph.send
|
|
DGLGraph.recv
|
|
DGLGraph.send_and_recv
|
|
DGLGraph.pull
|
|
DGLGraph.push
|
|
DGLGraph.update_all
|
|
DGLGraph.prop_nodes
|
|
DGLGraph.prop_edges
|
|
DGLGraph.filter_nodes
|
|
DGLGraph.filter_edges
|
|
DGLGraph.to
|
|
|
|
Batch and Unbatch
|
|
-------------------
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
batch
|
|
unbatch
|
|
|
|
Mapping between subgraph and parent graph
|
|
-----------------------------------------
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLGraph.parent_nid
|
|
DGLGraph.parent_eid
|
|
DGLGraph.map_to_subgraph_nid
|
|
|
|
Synchronize features between subgraph and parent graph
|
|
------------------------------------------------------
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
DGLGraph.copy_from_parent
|
|
DGLGraph.copy_to_parent
|