Skip to content

Latest commit

 

History

History
145 lines (125 loc) · 6.95 KB

README.md

File metadata and controls

145 lines (125 loc) · 6.95 KB
Raw

Logo

Graphbook

GitHub License GitHub Actions Workflow Status Docker Pulls PyPI Downloads PyPI - Version

Discord

The Framework for AI-driven Data Pipelines
Report bug · Request feature

Overview • Status • Getting Started • Examples • Collaboration

Overview

Graphbook is a framework for building efficient, interactive DAG-structured AI data pipelines or workflows composed of nodes written in Python. Graphbook provides common ML processing features such as multiprocessing IO and automatic batching for PyTorch tensors, and it features a web-based UI to assemble, monitor, and execute data processing workflows. It can be used to prepare training data for custom ML models, experiment with custom trained or off-the-shelf models, and to build ML-based ETL applications. Custom nodes can be built in Python, and Graphbook will behave like a framework and call lifecycle methods on those nodes.

Huggingface Pipeline Demo

Build, run, monitor!

Applications

  • Clean and curate custom large scale datasets
  • Demo ML apps on Huggingface Spaces
  • Build and deliver customizable no-code or hybrid low-code ML apps and services
  • Quickly experiment with different ML models and adjust hyperparameters
  • Maximize GPU utilization and parallelize IO during inference and training

Status

Graphbook is in a very early stage of development, so expect minor bugs and rapid design changes through the coming releases. If you would like to report a bug or request a feature, please feel free to do so. We aim to make Graphbook serve our users in the best way possible.

Current Features

  • ​​Graph-based visual editor to experiment and create complex ML workflows
  • Caches outputs and only re-executes parts of the workflow that changes between executions
  • UI monitoring components for logs and outputs per node
  • Custom buildable nodes with Python via OOP and functional patterns
  • Automatic batching for Pytorch tensors
  • Multiprocessing I/O to and from disk and network
  • Customizable multiprocessing functions
  • Ability to execute entire graphs, or individual subgraphs/nodes
  • Ability to execute singular batches of data
  • Ability to pause graph execution
  • Basic nodes for filtering, loading, and saving outputs
  • Node grouping and subflows
  • Autosaving and shareable serialized workflow files
  • Registers node code changes without needing a restart
  • Monitorable system CPU and GPU resource usage
  • Monitorable worker queue sizes for optimal worker scaling
  • Human-in-the-loop prompting for interactivity and manual control during DAG execution
  • Can switch to threaded processing per client session for demoing apps to multiple simulataneous users
  • (BETA) Third Party Plugins *

* We plan on adding documentation for the community to build plugins, but for now, an example can be seen at example_plugin and graphbook-huggingface

Planned Features

  • A graphbook run command to execute workflows in a CLI
  • All-code workflows, so users never have to leave their IDE
  • Remote subgraphs for scaling workflows on other Graphbook services
  • And many optimizations for large data processing workloads

Supported OS

The following operating systems are supported in order of most to least recommended:

  • Linux
  • Mac
  • Windows (not recommended) *

* There may be issues with running Graphbook on Windows. With limited resources, we can only focus testing and development on Linux.

Getting Started

Install from PyPI

  1. pip install graphbook
  2. graphbook
  3. Visit http://localhost:8005

Install with Docker

  1. Pull and run the downloaded image 
    docker run --rm -p 8005:8005 -v $PWD/workflows:/app/workflows rsamf/graphbook:latest
  2. Visit http://localhost:8005

Recommended Plugins

Visit the docs to learn more on how to create custom nodes and workflows with Graphbook.

Examples

We continually post examples of workflows and custom nodes in our examples repo.

Collaboration

Graphbook is in active development and very much welcomes contributors. This is a guide on how to run Graphbook in development mode. If you are simply using Graphbook, view the Getting Started section.

Run Graphbook in Development Mode

You can use any other virtual environment solution, but it is highly adviced to use poetry since our dependencies are specified in poetry's format.

  1. Clone the repo and cd graphbook
  2. poetry install --with dev
  3. poetry shell
  4. python -m graphbook.main
  5. cd web
  6. deno install
  7. deno run dev
  8. In your browser, navigate to localhost:5173, and in the settings, change your Graph Server Host to localhost:8005.