helios.layouts.forceatlas2gpu

ForceAtlas2 cuGraph

ForceAtlas2 layout algorithm through IPC using cuGraph.

Classes

class helios.layouts.forceatlas2gpu.ForceAtlas2(edges, network_draw, weights=None, lin_log_mode=False, edge_weight_influence=1.0, jitter_tolerance=1.0, barnes_hut_optimize=True, barnes_hut_theta=1.0, scaling_ratio=2.0, strong_gravity_mode=False, gravity=1.0)[source]

Performs the ForceAtlas2 algorithm using the cugraph lib.

The ForceAtlas will be called inside of a different process which comunicates with this object through the SharedMemory

Notes

Python 3.8+ is required to use this

Parameters

  • edges (ndarray) –

  • network_draw (NetworkDraw) –

  • weights (array, optional) – edge weights

  • lin_log_mode (bool, default False) –

  • edge_weight_influence (float, default 1.0) –

  • jitter_tolerance (float, default 1.0) –

  • barnes_hut_optimize (bool, default True) –

  • barnes_hut_theta (float, default 1.0) –

  • scaling_ratio (float, default 2.0) –

  • strong_gravity_mode (bool, default False) –

  • gravity (float, default 1.0) –

class helios.layouts.forceatlas2gpu.ForceAtlas2ServerCalc(edges_buffer_name, positions_buffer_name, info_buffer_name, weights_buffer_name=None, snapshots_buffer_name=None, num_snapshots=0, lin_log_mode=False, edge_weight_influence=1.0, jitter_tolerance=1.0, barnes_hut_optimize=True, barnes_hut_theta=1.0, scaling_ratio=2.0, strong_gravity_mode=False, gravity=1.0)[source]

This Obj. reads the network information stored in a shared memory resource and execute the ForceAtlas2 layout algorithm

Parameters

  • edges_buffer_name (str) – The name of the shared memory buffer where the edges are stored

  • positions_buffer_name (str) – The name of the shared memory buffer where the positions are stored.

  • info_buffer_name (str) –

  • weights_buffer_name (str, optional) –

  • snapshots_buffer_name (str, optional) –

  • num_snapshots (int, optional) –

  • lin_log_mode (bool, default False) –

  • edge_weight_influence (float, default 1.0) –

  • jitter_tolerance (float, default 1.0) –

  • barnes_hut_optimize (bool, default True) –

  • barnes_hut_theta (float, default 1.0) –

  • scaling_ratio (float, default 2.0) –

  • strong_gravity_mode (bool, default False) –

  • gravity (float, default 1.0) –