Graph#
- class raphtory.Graph#
Bases:
GraphView
A temporal graph.
Methods:
add_constant_properties
(properties)Adds static properties to the graph.
add_edge
(timestamp, src, dst[, properties, ...])Adds a new edge with the given source and destination nodes and properties to the graph.
add_node
(timestamp, id[, properties])Adds a new node with the given id and properties to the graph.
add_property
(timestamp, properties)Adds properties to the graph.
after
(start)Create a view of the graph including all events after start (exclusive).
at
(time)Create a view of the graph including all events at time.
before
(end)Create a view of the graph including all events before end (exclusive).
bincode
()Get bincode encoded graph
Number of edges in the graph
Number of nodes in the graph
Number of edges in the graph
Create a view including all the edges in the default layer
edge
(src, dst)Gets the edge with the specified source and destination nodes
expanding
(step)Creates a WindowSet with the given step size using an expanding window.
has_edge
(src, dst[, layer])Returns true if the graph contains the specified edge
has_node
(id)Returns true if the graph contains the specified node
index
()Indexes all node and edge properties.
layer
(name)Create a view including all the edges in the layers names
layers
(names)Create a view including all the edges in the layers names
load_edge_props_from_pandas
(df, src, dst[, ...])Load edge properties from a Pandas DataFrame.
load_edges_from_pandas
(df, src, dst, time[, ...])Load edges from a Pandas DataFrame into the graph.
load_from_file
(path)Loads a graph from the given path.
load_from_pandas
(edge_df, edge_src, ...[, ...])Load a graph from a Pandas DataFrame.
load_node_props_from_pandas
(df, id[, ...])Load node properties from a Pandas DataFrame.
load_nodes_from_pandas
(df, id, time[, ...])Load nodes from a Pandas DataFrame into the graph.
Returns a 'materialized' clone of the graph view - i.e. a new graph with a copy of the data seen within the view instead of just a mask over the original graph.
node
(id)Gets the node with the specified id
rolling
(window[, step])Creates a WindowSet with the given window size and optional step using a rolling window.
save_to_file
(path)Saves the graph to the given path.
subgraph
(nodes)Returns a subgraph given a set of nodes
update_constant_properties
(properties)Updates static properties to the graph.
vectorise
(embedding[, cache, ...])Create a VectorisedGraph from the current graph
window
([start, end])Create a view of the graph including all events between start (inclusive) and end (exclusive)
Attributes:
DateTime of earliest activity in the graph
Timestamp of earliest activity in the graph
Gets all edges in the graph
Gets the latest time that this graph is valid.
Gets the latest datetime that this graph is valid
DateTime of latest activity in the graph
Timestamp of latest activity in the graph
Gets the nodes in the graph
Get all graph properties
Gets the start time for rolling and expanding windows for this graph
Gets the earliest datetime that this graph is valid
Return all the layer ids in the graph
Get the window size (difference between start and end) for this graph
- add_constant_properties(properties)#
Adds static properties to the graph.
- Parameters:
properties (dict) – The static properties of the graph.
- Returns:
None
- add_edge(timestamp, src, dst, properties=None, layer=None)#
Adds a new edge with the given source and destination nodes and properties to the graph.
- Parameters:
timestamp (int, str, or datetime(utc)) – The timestamp of the edge.
src (str or int) – The id of the source node.
dst (str or int) – The id of the destination node.
properties (dict) – The properties of the edge, as a dict of string and properties (optional).
layer (str) – The layer of the edge (optional).
- Returns:
None
- add_node(timestamp, id, properties=None)#
Adds a new node with the given id and properties to the graph.
- Parameters:
timestamp (int, str, or datetime(utc)) – The timestamp of the node.
id (str or int) – The id of the node.
properties (dict) – The properties of the node (optional).
- Returns:
None
- add_property(timestamp, properties)#
Adds properties to the graph.
- Parameters:
timestamp (int, str, or datetime(utc)) – The timestamp of the temporal property.
properties (dict) – The temporal properties of the graph.
- Returns:
None
- after(start)#
Create a view of the graph including all events after start (exclusive).
- Parameters:
start – The start time of the window.
- Returns:
A graph object.
- at(time)#
Create a view of the graph including all events at time.
- Parameters:
time – The time of the window.
- Returns:
A graph object.
- before(end)#
Create a view of the graph including all events before end (exclusive).
- Parameters:
end – The end time of the window.
- Returns:
A graph object.
- bincode()#
Get bincode encoded graph
- count_edges()#
Number of edges in the graph
- Returns:
the number of edges in the graph
- count_nodes()#
Number of nodes in the graph
- Returns:
the number of nodes in the graph
- count_temporal_edges()#
Number of edges in the graph
- Returns:
the number of temporal edges in the graph
- default_layer()#
Create a view including all the edges in the default layer
- Returns:
a view including all the edges in the default layer
- earliest_date_time#
DateTime of earliest activity in the graph
- Returns:
the datetime of the earliest activity in the graph
- earliest_time#
Timestamp of earliest activity in the graph
- Returns:
the timestamp of the earliest activity in the graph
- edge(src, dst)#
Gets the edge with the specified source and destination nodes
- Parameters:
src (str or int) – the source node id
dst (str or int) – the destination node id
- Returns:
the edge with the specified source and destination nodes, or None if the edge does not exist
- edges#
Gets all edges in the graph
- Returns:
the edges in the graph
- end#
Gets the latest time that this graph is valid.
- Returns:
The latest time that this graph is valid or None if the graph is valid for all times.
- end_date_time#
Gets the latest datetime that this graph is valid
- Returns:
The latest datetime that this graph is valid or None if the graph is valid for all times.
- expanding(step)#
Creates a WindowSet with the given step size using an expanding window.
An expanding window is a window that grows by step size at each iteration.
- Parameters:
step (int) – The step size of the window.
- Returns:
A WindowSet object.
- has_edge(src, dst, layer=None)#
Returns true if the graph contains the specified edge
- Parameters:
src (str or int) – the source node id
dst (str or int) – the destination node id
layer (str) – the edge layer (optional)
- Returns:
true if the graph contains the specified edge, false otherwise
- has_node(id)#
Returns true if the graph contains the specified node
- Parameters:
id (str or int) – the node id
- Returns:
true if the graph contains the specified node, false otherwise
- index()#
Indexes all node and edge properties. Returns a GraphIndex which allows the user to search the edges and nodes of the graph via tantivity fuzzy matching queries. Note this is currently immutable and will not update if the graph changes. This is to be improved in a future release.
- Returns:
GraphIndex - Returns a GraphIndex
- latest_date_time#
DateTime of latest activity in the graph
- Returns:
the datetime of the latest activity in the graph
- latest_time#
Timestamp of latest activity in the graph
- Returns:
the timestamp of the latest activity in the graph
- layer(name)#
Create a view including all the edges in the layers names
- Parameters:
name (str) – the name of the layers to include
- Returns:
a view including all the edges in the layers names
- layers(names)#
Create a view including all the edges in the layers names
- Parameters:
name (str) – the name of the layers to include
- Returns:
a view including all the edges in the layers names
- load_edge_props_from_pandas(df, src, dst, const_props=None, shared_const_props=None, layer=None, layer_in_df=True)#
Load edge properties from a Pandas DataFrame.
- Parameters:
df (Dataframe) – The Pandas DataFrame containing edge information.
src (str) – The column name for the source node.
dst (str) – The column name for the destination node.
const_props (List<str>) – List of constant edge property column names. Defaults to None. (optional)
shared_const_props (dict) – A dictionary of constant properties that will be added to every edge. Defaults to None. (optional)
layer (str) – Layer name. Defaults to None. (optional)
layer_in_df (bool) – Whether the layer name should be used to look up the values in a column of the data frame or if it should be used directly as the layer for all edges (optional) defaults to True.
- Returns:
Result of the operation.
- Return type:
Result<(), GraphError>
- load_edges_from_pandas(df, src, dst, time, props=None, const_props=None, shared_const_props=None, layer=None, layer_in_df=True)#
Load edges from a Pandas DataFrame into the graph.
- Parameters:
df (Dataframe) – The Pandas DataFrame containing the edges.
src (str) – The column name for the source node ids.
dst (str) – The column name for the destination node ids.
time (str) – The column name for the update timestamps.
props (List<str>) – List of edge property column names. Defaults to None. (optional)
const_props (List<str>) – List of constant edge property column names. Defaults to None. (optional)
shared_const_props (dict) – A dictionary of constant properties that will be added to every edge. Defaults to None. (optional)
edge_layer (str) – The edge layer name (optional) Defaults to None.
layer_in_df (bool) – Whether the layer name should be used to look up the values in a column of the dateframe or if it should be used directly as the layer for all edges (optional) defaults to True.
- Returns:
Result of the operation.
- Return type:
Result<(), GraphError>
- static load_from_file(path)#
Loads a graph from the given path.
- Parameters:
path (str) – The path to the graph.
- Returns:
The loaded graph.
- Return type:
- static load_from_pandas(edge_df, edge_src, edge_dst, edge_time, edge_props=None, edge_const_props=None, edge_shared_const_props=None, edge_layer=None, layer_in_df=True, node_df=None, node_id=None, node_time=None, node_props=None, node_const_props=None, node_shared_const_props=None)#
Load a graph from a Pandas DataFrame.
- Parameters:
edge_df (pandas.DataFrame) – The DataFrame containing the edges.
edge_src (str) – The column name for the source node ids.
edge_dst (str) – The column name for the destination node ids.
edge_time (str) – The column name for the timestamps.
edge_props (list) – The column names for the temporal properties (optional) Defaults to None.
edge_const_props (list) – The column names for the constant properties (optional) Defaults to None.
edge_shared_const_props (dict) – A dictionary of constant properties that will be added to every edge (optional) Defaults to None.
edge_layer (str) – The edge layer name (optional) Defaults to None.
layer_in_df (bool) – Whether the layer name should be used to look up the values in a column of the edge_df or if it should be used directly as the layer for all edges (optional) defaults to True.
node_df (pandas.DataFrame) – The DataFrame containing the nodes (optional) Defaults to None.
node_id (str) – The column name for the node ids (optional) Defaults to None.
node_time (str) – The column name for the node timestamps (optional) Defaults to None.
node_props (list) – The column names for the node temporal properties (optional) Defaults to None.
node_const_props (list) – The column names for the node constant properties (optional) Defaults to None.
node_shared_const_props (dict) – A dictionary of constant properties that will be added to every node (optional) Defaults to None.
- Returns:
The loaded Graph object.
- Return type:
- load_node_props_from_pandas(df, id, const_props=None, shared_const_props=None)#
Load node properties from a Pandas DataFrame.
- Parameters:
df (Dataframe) – The Pandas DataFrame containing node information.
id (str) – The column name for the node IDs.
const_props (List<str>) – List of constant node property column names. Defaults to None. (optional)
shared_const_props (<HashMap<String, Prop>>) – A dictionary of constant properties that will be added to every node. Defaults to None. (optional)
- Returns:
Result of the operation.
- Return type:
Result<(), GraphError>
- load_nodes_from_pandas(df, id, time, props=None, const_props=None, shared_const_props=None)#
Load nodes from a Pandas DataFrame into the graph.
- Parameters:
df (pandas.DataFrame) – The Pandas DataFrame containing the nodes.
id (str) – The column name for the node IDs.
time (str) – The column name for the timestamps.
props (List<str>) – List of node property column names. Defaults to None. (optional)
const_props (List<str>) – List of constant node property column names. Defaults to None. (optional)
shared_const_props (Dictionary/Hashmap of properties) – A dictionary of constant properties that will be added to every node. Defaults to None. (optional)
- Returns:
Result of the operation.
- Return type:
Result<(), GraphError>
- materialize()#
Returns a ‘materialized’ clone of the graph view - i.e. a new graph with a copy of the data seen within the view instead of just a mask over the original graph
- Returns:
GraphView - Returns a graph clone
- node(id)#
Gets the node with the specified id
- Parameters:
id (str or int) – the node id
- Returns:
the node with the specified id, or None if the node does not exist
- nodes#
Gets the nodes in the graph
- Returns:
the nodes in the graph
- properties#
Get all graph properties
- Returns:
HashMap<String, Prop> - Properties paired with their names
- rolling(window, step=None)#
Creates a WindowSet with the given window size and optional step using a rolling window.
A rolling window is a window that moves forward by step size at each iteration.
- Parameters:
window – The size of the window.
step – The step size of the window. Defaults to the window size.
- Returns:
A WindowSet object.
- save_to_file(path)#
Saves the graph to the given path.
- Parameters:
path (str) – The path to the graph.
Returns: None
- start#
Gets the start time for rolling and expanding windows for this graph
- Returns:
The earliest time that this graph is valid or None if the graph is valid for all times.
- start_date_time#
Gets the earliest datetime that this graph is valid
- Returns:
The earliest datetime that this graph is valid or None if the graph is valid for all times.
- subgraph(nodes)#
Returns a subgraph given a set of nodes
- Parameters:
nodes (*) – set of nodes
- Returns:
GraphView - Returns the subgraph
- unique_layers#
Return all the layer ids in the graph
- update_constant_properties(properties)#
Updates static properties to the graph.
- Parameters:
properties (dict) – The static properties of the graph.
- Returns:
None
- vectorise(embedding, cache=None, overwrite_cache=False, node_document=None, edge_document=None, verbose=False)#
Create a VectorisedGraph from the current graph
- Parameters:
embedding (Callable[[list], list]) – the embedding function to translate documents to embeddings
cache (str) – the file to be used as a cache to avoid calling the embedding function (optional)
overwrite_cache (bool) – whether or not to overwrite the cache if there are new embeddings (optional)
node_document (str) – the property name to be used as document for nodes (optional)
edge_document (str) – the property name to be used as document for edges (optional)
verbose (bool) – whether or not to print logs reporting the progress
- Returns:
A VectorisedGraph with all the documents/embeddings computed and with an initial empty selection
- window(start=None, end=None)#
Create a view of the graph including all events between start (inclusive) and end (exclusive)
- Parameters:
start – The start time of the window. Defaults to the start time of the graph.
end – The end time of the window. Defaults to the end time of the graph.
Returns: r A graph object.
- window_size#
Get the window size (difference between start and end) for this graph
- class raphtory.GraphWithDeletions#
Bases:
GraphView
A temporal graph that allows edges and nodes to be deleted.
Methods:
add_constant_properties
(properties)Adds static properties to the graph.
add_edge
(timestamp, src, dst[, properties, ...])Adds a new edge with the given source and destination nodes and properties to the graph.
add_node
(timestamp, id[, properties])Adds a new node with the given id and properties to the graph.
add_property
(timestamp, properties)Adds properties to the graph.
after
(start)Create a view of the graph including all events after start (exclusive).
at
(time)Create a view of the graph including all events at time.
before
(end)Create a view of the graph including all events before end (exclusive).
bincode
()Get bincode encoded graph
Number of edges in the graph
Number of nodes in the graph
Number of edges in the graph
Create a view including all the edges in the default layer
delete_edge
(timestamp, src, dst[, layer])Deletes an edge given the timestamp, src and dst nodes and layer (optional)
edge
(src, dst)Gets the edge with the specified source and destination nodes
expanding
(step)Creates a WindowSet with the given step size using an expanding window.
has_edge
(src, dst[, layer])Returns true if the graph contains the specified edge
has_node
(id)Returns true if the graph contains the specified node
index
()Indexes all node and edge properties.
layer
(name)Create a view including all the edges in the layers names
layers
(names)Create a view including all the edges in the layers names
load_from_file
(path)Loads a graph from the given path.
Returns a 'materialized' clone of the graph view - i.e. a new graph with a copy of the data seen within the view instead of just a mask over the original graph.
node
(id)Gets the node with the specified id
rolling
(window[, step])Creates a WindowSet with the given window size and optional step using a rolling window.
save_to_file
(path)Saves the graph to the given path.
subgraph
(nodes)Returns a subgraph given a set of nodes
update_constant_properties
(properties)Updates static properties to the graph.
vectorise
(embedding[, cache, ...])Create a VectorisedGraph from the current graph
window
([start, end])Create a view of the graph including all events between start (inclusive) and end (exclusive)
Attributes:
DateTime of earliest activity in the graph
Timestamp of earliest activity in the graph
Gets all edges in the graph
Gets the latest time that this graph is valid.
Gets the latest datetime that this graph is valid
DateTime of latest activity in the graph
Timestamp of latest activity in the graph
Gets the nodes in the graph
Get all graph properties
Gets the start time for rolling and expanding windows for this graph
Gets the earliest datetime that this graph is valid
Return all the layer ids in the graph
Get the window size (difference between start and end) for this graph
- add_constant_properties(properties)#
Adds static properties to the graph.
- Parameters:
properties (dict) – The static properties of the graph.
- Returns:
None
- add_edge(timestamp, src, dst, properties=None, layer=None)#
Adds a new edge with the given source and destination nodes and properties to the graph.
- Parameters:
timestamp (int) – The timestamp of the edge.
src (str or int) – The id of the source node.
dst (str or int) – The id of the destination node.
properties (dict) – The properties of the edge, as a dict of string and properties
layer (str) – The layer of the edge.
- Returns:
None
- add_node(timestamp, id, properties=None)#
Adds a new node with the given id and properties to the graph.
- Parameters:
timestamp (int, str, or datetime(utc)) – The timestamp of the node.
id (str or int) – The id of the node.
properties (dict) – The properties of the node.
- Returns:
None
- add_property(timestamp, properties)#
Adds properties to the graph.
- Parameters:
timestamp (int, str, or datetime(utc)) – The timestamp of the temporal property.
properties (dict) – The temporal properties of the graph.
- Returns:
None
- after(start)#
Create a view of the graph including all events after start (exclusive).
- Parameters:
start – The start time of the window.
- Returns:
A graph object.
- at(time)#
Create a view of the graph including all events at time.
- Parameters:
time – The time of the window.
- Returns:
A graph object.
- before(end)#
Create a view of the graph including all events before end (exclusive).
- Parameters:
end – The end time of the window.
- Returns:
A graph object.
- bincode()#
Get bincode encoded graph
- count_edges()#
Number of edges in the graph
- Returns:
the number of edges in the graph
- count_nodes()#
Number of nodes in the graph
- Returns:
the number of nodes in the graph
- count_temporal_edges()#
Number of edges in the graph
- Returns:
the number of temporal edges in the graph
- default_layer()#
Create a view including all the edges in the default layer
- Returns:
a view including all the edges in the default layer
- delete_edge(timestamp, src, dst, layer=None)#
Deletes an edge given the timestamp, src and dst nodes and layer (optional)
- Parameters:
timestamp (int) – The timestamp of the edge.
src (str or int) – The id of the source node.
dst (str or int) – The id of the destination node.
layer (str) – The layer of the edge. (optional)
- Returns:
None or a GraphError if the edge could not be deleted
- earliest_date_time#
DateTime of earliest activity in the graph
- Returns:
the datetime of the earliest activity in the graph
- earliest_time#
Timestamp of earliest activity in the graph
- Returns:
the timestamp of the earliest activity in the graph
- edge(src, dst)#
Gets the edge with the specified source and destination nodes
- Parameters:
src (str or int) – the source node id
dst (str or int) – the destination node id
- Returns:
the edge with the specified source and destination nodes, or None if the edge does not exist
- edges#
Gets all edges in the graph
- Returns:
the edges in the graph
- end#
Gets the latest time that this graph is valid.
- Returns:
The latest time that this graph is valid or None if the graph is valid for all times.
- end_date_time#
Gets the latest datetime that this graph is valid
- Returns:
The latest datetime that this graph is valid or None if the graph is valid for all times.
- expanding(step)#
Creates a WindowSet with the given step size using an expanding window.
An expanding window is a window that grows by step size at each iteration.
- Parameters:
step (int) – The step size of the window.
- Returns:
A WindowSet object.
- has_edge(src, dst, layer=None)#
Returns true if the graph contains the specified edge
- Parameters:
src (str or int) – the source node id
dst (str or int) – the destination node id
layer (str) – the edge layer (optional)
- Returns:
true if the graph contains the specified edge, false otherwise
- has_node(id)#
Returns true if the graph contains the specified node
- Parameters:
id (str or int) – the node id
- Returns:
true if the graph contains the specified node, false otherwise
- index()#
Indexes all node and edge properties. Returns a GraphIndex which allows the user to search the edges and nodes of the graph via tantivity fuzzy matching queries. Note this is currently immutable and will not update if the graph changes. This is to be improved in a future release.
- Returns:
GraphIndex - Returns a GraphIndex
- latest_date_time#
DateTime of latest activity in the graph
- Returns:
the datetime of the latest activity in the graph
- latest_time#
Timestamp of latest activity in the graph
- Returns:
the timestamp of the latest activity in the graph
- layer(name)#
Create a view including all the edges in the layers names
- Parameters:
name (str) – the name of the layers to include
- Returns:
a view including all the edges in the layers names
- layers(names)#
Create a view including all the edges in the layers names
- Parameters:
name (str) – the name of the layers to include
- Returns:
a view including all the edges in the layers names
- static load_from_file(path)#
Loads a graph from the given path.
- Parameters:
path (str) – The path to the graph.
- Returns:
The loaded graph.
- Return type:
- materialize()#
Returns a ‘materialized’ clone of the graph view - i.e. a new graph with a copy of the data seen within the view instead of just a mask over the original graph
- Returns:
GraphView - Returns a graph clone
- node(id)#
Gets the node with the specified id
- Parameters:
id (str or int) – the node id
- Returns:
the node with the specified id, or None if the node does not exist
- nodes#
Gets the nodes in the graph
- Returns:
the nodes in the graph
- properties#
Get all graph properties
- Returns:
HashMap<String, Prop> - Properties paired with their names
- rolling(window, step=None)#
Creates a WindowSet with the given window size and optional step using a rolling window.
A rolling window is a window that moves forward by step size at each iteration.
- Parameters:
window – The size of the window.
step – The step size of the window. Defaults to the window size.
- Returns:
A WindowSet object.
- save_to_file(path)#
Saves the graph to the given path.
- Parameters:
path (str) – The path to the graph.
Returns: None
- start#
Gets the start time for rolling and expanding windows for this graph
- Returns:
The earliest time that this graph is valid or None if the graph is valid for all times.
- start_date_time#
Gets the earliest datetime that this graph is valid
- Returns:
The earliest datetime that this graph is valid or None if the graph is valid for all times.
- subgraph(nodes)#
Returns a subgraph given a set of nodes
- Parameters:
nodes (*) – set of nodes
- Returns:
GraphView - Returns the subgraph
- unique_layers#
Return all the layer ids in the graph
- update_constant_properties(properties)#
Updates static properties to the graph.
- Parameters:
properties (dict) – The static properties of the graph.
- Returns:
None
- vectorise(embedding, cache=None, overwrite_cache=False, node_document=None, edge_document=None, verbose=False)#
Create a VectorisedGraph from the current graph
- Parameters:
embedding (Callable[[list], list]) – the embedding function to translate documents to embeddings
cache (str) – the file to be used as a cache to avoid calling the embedding function (optional)
overwrite_cache (bool) – whether or not to overwrite the cache if there are new embeddings (optional)
node_document (str) – the property name to be used as document for nodes (optional)
edge_document (str) – the property name to be used as document for edges (optional)
verbose (bool) – whether or not to print logs reporting the progress
- Returns:
A VectorisedGraph with all the documents/embeddings computed and with an initial empty selection
- window(start=None, end=None)#
Create a view of the graph including all events between start (inclusive) and end (exclusive)
- Parameters:
start – The start time of the window. Defaults to the start time of the graph.
end – The end time of the window. Defaults to the end time of the graph.
Returns: r A graph object.
- window_size#
Get the window size (difference between start and end) for this graph