Files
dgl/docs/source/api/python/dgl.distributed.rst
Da Zheng 9da1629c9d [Distributed] Some small fixes on doc (#2049)
* quick fix.

* update sparse optimizer.

* fix.

* fix
2020-08-18 21:13:19 -07:00

93 lines
1.8 KiB
ReStructuredText

.. _api-distributed:
dgl.distributed
=================================
.. automodule:: dgl.distributed
Initialization
---------------
.. autosummary::
:toctree: ../../generated/
initialize
Distributed Graph
-----------------
.. autoclass:: DistGraph
:members: ndata, edata, idtype, device, ntypes, etypes, number_of_nodes, number_of_edges, node_attr_schemes, edge_attr_schemes, rank, find_edges, get_partition_book, barrier, local_partition, num_nodes, num_edges
Distributed Tensor
------------------
.. autoclass:: DistTensor
:members: part_policy, shape, dtype, name
Distributed Embedding
---------------------
.. autoclass:: DistEmbedding
.. autoclass:: SparseAdagrad
:members: step
Distributed workload split
--------------------------
.. autosummary::
:toctree: ../../generated/
node_split
edge_split
Distributed Sampling
--------------------
Distributed DataLoader
``````````````````````
.. currentmodule:: dgl.distributed.dist_dataloader
.. autoclass:: DistDataLoader
Distributed Neighbor Sampling
`````````````````````````````
.. currentmodule:: dgl.distributed.graph_services
.. autosummary::
:toctree: ../../generated/
sample_neighbors
find_edges
in_subgraph
Partition
---------
Graph partition book
````````````````````
.. currentmodule:: dgl.distributed.graph_partition_book
.. autoclass:: GraphPartitionBook
:members: shared_memory, num_partitions, metadata, nid2partid, eid2partid, partid2nids, partid2eids, nid2localnid, eid2localeid, partid
.. autoclass:: PartitionPolicy
:members: policy_str, part_id, partition_book, to_local, to_partid, get_part_size, get_size
Split and Load Graphs
`````````````````````
.. currentmodule:: dgl.distributed.partition
.. autosummary::
:toctree: ../../generated/
load_partition
load_partition_book
partition_graph