lynxkite / README.md
darabos's picture
Plugin loading.
83b1026
|
raw
history blame
1.43 kB

LynxKite 2024

This is an experimental rewrite of LynxKite. It is not compatible with the original LynxKite. The primary goals of this rewrite are:

  • Target GPU clusters instead of Hadoop clusters. We use Python instead of Scala, RAPIDS instead of Apache Spark.
  • More extensible backend. Make it easy to add new LynxKite boxes. Make it easy to use our frontend for other purposes, configuring and executing other pipelines.

Structure

  • lynxkite-core: Core types and utilities. Depend on this lightweight package if you are writing LynxKite plugins.
  • lynxkite-app: The LynxKite web application. Install some plugins then run this to use LynxKite.
  • lynxkite-graph-analytics: Graph analytics plugin. The classical LynxKite experience!
  • lynxkite-pillow: A simple example plugin.
  • lynxkite-lynxscribe: A plugin for building and running LynxScribe applications.

Development

Install everything like this:

uv venv
source .venv/bin/activate
uv pip install -e lynxkite-core/ lynxkite-app/ lynxkite-graph-analytics/ lynxkite-lynxscribe/ lynxkite-pillow-example/

This also builds the frontend, hopefully very quickly. To run it:

cd lynxkite-app # just because the "data" directory with the examples is here
LYNXKITE_RELOAD=1 lynxkite

If you also want to make changes to the frontend with hot reloading:

cd lynxkite-app/web
npm run dev