-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a937a1d
commit e2280e3
Showing
1 changed file
with
26 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |