Skip to content

Commit

Permalink
Update topo_api.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
bichengying committed Nov 6, 2020
1 parent a937a1d commit e2280e3
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion docs/topo_api.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
Topology Related Utility Functions
==================================

We provide several popular static and dynamic topologies.

* Static Topology
* ExponentialGraph, ExponentialTwoGraph
* SymmetricExponentialGraph
* MeshGrid2DGraph
* StarGraph, RingGraph
* FullyConnectedGraph

* Dynamic Topology
* GetDynamicSendRecvRanks
* GetExp2DynamicSendRecvMachineRanks
* GetInnerOuterRingDynamicSendRecvRanks
* GetInnerOuterExpo2DynamicSendRecvRanks

* Utility Function
* IsRegularGraph
* IsTopologyEquivalent
* GetSendWeights, GetRecvWeights

You can also write your own topology strategy as long as your static topology function returns
a `networkx.DiGraph <https://networkx.org/documentation/stable/reference/classes/digraph.html>`_
object and dynamic topology function (generator more accurately) yields
a list of send neighbor and receive neighbor ranks in each call.

.. automodule:: bluefog.common.topology_util
:members:
:exclude-members: List, Tuple, Dict, Iterator, isPowerOf

0 comments on commit e2280e3

Please sign in to comment.