Skip to main content

Implements the Computational Hypergraph Discovery algorithm

Project description

Computational Hypergraph Discovery: A Gaussian process framework for connecting the dots

License: Apache 2.0 Python 3.11.4 GitHub Repo

This is the source code for the paper "Computational Hypergraph Discovery: A Gaussian process framework for connecting the dots".

Please see the companion blog post for a gentle introduction to the method and the code. See the repo here for full documentation and examples.

Installation

The code is written in Python 3 and requires the following packages:

  • matplotlib
  • NumPy
  • scipy
  • scikit-learn
  • networkx

You can install using pip:

pip install ComputationalHypergraphDiscovery

Quick start

Graph discovery takes very little time. The following code runs the method on the example dataset provided in the repo. The dataset is a 2D array of shape (n_samples, n_features) where each row is a sample and each column is a feature. After fitting the model, the graph is stored in the GraphDiscovery object, specifically its graph G attribute. The graph is a networkx object, which can be easily plotted using .plot_graph().

You can find the Sachs dataset in the repo, at this link.

import ComputationalHypergraphDiscovery as CHD
import pandas as pd
df=pd.read_csv('https://raw.githubusercontent.com/TheoBourdais/ComputationalHypergraphDiscovery/main/examples/SachsData.csv')
df=df.sample(n=500,random_state=1) #subsample to run example quickly
kernels=CHD.Modes.LinearMode()+CHD.Modes.QuadraticMode()
graph_discovery = CHD.GraphDiscovery.from_dataframe(df,mode_kernels=kernels)
graph_discovery.fit()
graph_discovery.plot_graph()

Available modifications of the base algorithm

The code gives an easy-to-use interface to manipulate the graph discovery method. It is designed to be modular and flexible. The main changes you can make are

  • Kernels and modes: You can decide what type of function will be used to link the nodes. The code provides a set of kernels, but you can easily add your own. The interface is designed to resemble the scikit-learn API, and you can use any kernel from scikit-learn.
  • Decision logics: In order to identify the edges of the graph, we need to decide whether certain connections are significant. The code provides indicators (like the level of noise), and the user specifies how to interpret them. The code provides a set of decision logic, but you can define your own.
  • Clustering: If a set of nodes is highly dependent, it is possible to merge them into a cluster of nodes. This gives greater readability and prevents the graph discovery method from missing other connections.
  • Possible edges: If you know that specific nodes cannot be connected, you can specify it to the algorithm. By default, all edges are possible.

Full documentation is available here.

Acknowledgements

Copyright 2023 by the California Institute of Technology. ALL RIGHTS RESERVED. United States Government Sponsorship acknowledged. This software may be subject to U.S. export control laws. By accepting this software, the user agrees to comply with all applicable U.S. export laws and regulations. User has the responsibility to obtain export licenses, or other export authority as may be required before exporting such information to foreign countries or providing access to foreign persons.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

computationalhypergraphdiscovery-1.1.0.tar.gz (29.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file computationalhypergraphdiscovery-1.1.0.tar.gz.

File metadata

File hashes

Hashes for computationalhypergraphdiscovery-1.1.0.tar.gz
Algorithm Hash digest
SHA256 0e2356e76458aa18acc9e0514a2b0dc846f741b16f6f67588ad29e2f27d2519b
MD5 e35b43f0567ae1809495bf9d6ac56c0a
BLAKE2b-256 59173455d27de53ea5d40be248b1186f75a59aea695a7e8a9200df725e4dec30

See more details on using hashes here.

File details

Details for the file ComputationalHypergraphDiscovery-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ComputationalHypergraphDiscovery-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 73c8cfd2ed3a09a0dc85d30219d0c57e3b27eb0576520430cf6717705256ad94
MD5 5a9eb7219fb77943f2abd97f1431d827
BLAKE2b-256 073b4d337a3404d6e93bf512584d84a7ba2d244109220875a064d8338cd3caf8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page