Code Monkey home page Code Monkey logo

stickyland's Introduction

StickyLand

Github Actions Status Binder pypi license arxiv badge DOI:10.1145/3491101.3519653

Break the linear presentation of Jupyter Notebooks with sticky cells!

๐Ÿ“บ Demo Video ๐Ÿ“– Paper: "StickyLand: Breaking the Linear Presentation of Computational Notebooks"

Live Demo

You can try StickyLand directly in your browser without installing anything:

Binder

Install

First, you need to install JupyterLab. Then you can install StickyLand with pip:

pip install stickyland

Features

feature-gif

Show details
Drag and drop to create sticky cellsCreate sticky code and markdown from scratch
drag-cell.mp4
create-cell.mp4
Automatically execute sticky cellsUse floating cells to create interactive dashboards
auto-run.mp4
dashboard.mp4

With multiple floating cells, users can create a fully-fledged interactive dashboard. For example, a machine learning engineer can build an ML Error Analysis Dashboard (shown below) through simple drag-and-drop.

The ML Error Analysis Dashboard consists of: (A) markdown text describing the dashboard, (B) input field to specify a feature to diagnose, (C) auto-run chart showing the distribution of the specified feature, (D) second input field to further specify the range within the feature to diagnose, (E) auto-run table displaying all samples that meet the criteria, (F) auto-run visualization explaining how the ML model makes decision on these samples, (G) interactive tool allowing the ML engineer to fix the ML model by editing its parameters based on their error analysis.

Development

You will need NodeJS to build the extension package. The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab_stickyland directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Citation

@inproceedings{wangStickyLandBreakingLinear2022,
  title = {{{StickyLand}}: {{Breaking}} the {{Linear Presentation}} of {{Computational Notebooks}}},
  shorttitle = {{{StickyLand}}},
  booktitle = {Extended {{Abstracts}} of the 2022 {{CHI Conference}} on {{Human Factors}} in {{Computing Systems}}},
  author = {Wang, Zijie J. and Dai, Katie and Edwards, W. Keith},
  year = {2022},
  publisher = {{ACM}}
}

License

The software is available under the BSD-3-Clause License.

Contact

If you have any questions, feel free to open an issue or contact Jay Wang.

stickyland's People

Contributors

xiaohk avatar kdai7 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.