Options
All
  • Public
  • Public/Protected
  • All
Menu

Module cugraph/src

Index

Functions

hypergraph

  • hypergraph<T>(values: DataFrame<T>, __namedParameters?: HypergraphProps<T>): HypergraphReturn
  • Creates a hypergraph out of the given dataframe, returning the graph components as dataframes.

    The transform reveals relationships between the rows and unique values. This transform is useful for lists of events, samples, relationships, and other structured high-dimensional data. The transform creates a node for every row, and turns a row's column entries into node attributes. Every unique value within a column is also turned into a node.

    Edges are added to connect a row's nodes to each of its column nodes. Nodes are given the attribute specified by nodeType that corresponds to the originating column name, or if a row eventId.

    Consider a list of events. Each row represents a distinct event, and each column some metadata about an event. If multiple events have common metadata, they will be transitively connected through those metadata values. Conversely, if an event has unique metadata, the unique metadata will turn into nodes that only have connections to the event node. For best results, set eventId to a row's unique ID, skip to all non-categorical columns (or columns to all categorical columns), and categories to group columns with the same kinds of values.

    Type parameters

    Parameters

    • values: DataFrame<T>
    • __namedParameters: HypergraphProps<T> = {}

    Returns HypergraphReturn

hypergraphDirect

  • hypergraphDirect<T>(values: DataFrame<T>, __namedParameters?: HypergraphDirectProps<any>): HypergraphReturn
  • Creates a hypergraph out of the given dataframe, returning the graph components as dataframes.

    The transform reveals relationships between the rows and unique values. This transform is useful for lists of events, samples, relationships, and other structured high-dimensional data. The transform creates a node for every row, and turns a row's column entries into node attributes. Every unique value within a column is also turned into a node.

    Edges are added to connect a row's nodes to one another. Nodes are given the attribute specified by nodeType that corresponds to the originating column name, or if a row eventId.

    Consider a list of events. Each row represents a distinct event, and each column some metadata about an event. If multiple events have common metadata, they will be transitively connected through those metadata values. Conversely, if an event has unique metadata, the unique metadata will turn into nodes that only have connections to the event node. For best results, set eventId to a row's unique ID, skip to all non-categorical columns (or columns to all categorical columns), and categories to group columns with the same kinds of values.

    Type parameters

    Parameters

    • values: DataFrame<T>
    • __namedParameters: HypergraphDirectProps<any> = {}

    Returns HypergraphReturn

renumberEdges

renumberNodes