Docs • Install • Tutorials • Contribute • Blog • Discord

Xircuits is a Jupyterlab-based extension that enables visual, low-code, training workflows. It allows anyone to easily create executable python code in seconds.

Installation

We recommend installing xircuits in a virtual environment.

$ pip install xircuits[full]

If you would like to install just the core functions, use:

$ pip install xircuits

Launch

$ xircuits

Download Examples

$ xircuits-examples

Development

Prerequisites

Xircuits requires nodejs and yarn to build. The test nvm version is 14.15.3. You may also want to set yarn globally accessible by:

npm install --global yarn

Build

git clone https://github.com/XpressAI/xircuits

Make and activate python env. The tested python versions are 3.9.6

python -m venv venv
venv/Scripts/activate

Download python packages.

pip install -r requirements.txt

Run the following commands to install the package in local editable mode and install xircuits into the JupyterLab environment.

# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Enable the server extension
jupyter server extension enable xircuits

Running

Start up xircuits using:

xircuits

Xircuits will open automatically in the browser.

If additional arguments required, launch xircuits using:

jupyter lab 

Rebuild

Rebuild Xircuits after making changes.

# Rebuild Typescript source after making changes
jlpm build
# Rebuild Xircuits after making any changes
jupyter lab build

Rebuild (Automatically)

You can watch the source directory and run Xircuits in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tab
jlpm run watch
# Run Xircuits in watch mode in one terminal tab
jupyter lab --watch

Preview

Machine Learning

PySpark

AutoML