/elyra

Elyra extends JupyterLab Notebooks with an AI centric approach.

Primary LanguagePythonApache License 2.0Apache-2.0

PyPI version Downloads Documentation Status GitHub Gitter Binder

Elyra

Elyra is a set of AI-centric extensions to JupyterLab Notebooks.

Elyra currently includes:

  • Notebook Pipelines visual editor
  • Ability to run a notebook as a batch job
  • Hybrid runtime support
  • Python script execution capabilities within the editor
  • Reusable Code Snippets
  • Notebook versioning based on git integration
  • Notebook navigation using auto-generated Table of Contents
  • Reusable configuration for runtimes

Elyra

The Elyra Getting Started Guide includes more details on these features.

Try Elyra

You can try out some of Elyra features using the My Binder service.

Click on the link below to try Elyra, on a sandbox environment, without having to install anything.

Binder

Installation

Elyra can be installed via PyPi:

Prerequisites :

Optional :

JupyterLab support

  • JupyterLab 1.x is supported on Elyra 0.10.0 and below

via PyPi:

pip install elyra && jupyter lab build
  • JupyterLab 2.x is supported on Elyra 0.11.0-rc0 and above

via PyPi:

pip install --upgrade --pre elyra && jupyter lab build

Note: Ubuntu and CentOS users may need to use pip3 install elyra

Verify Installation

jupyter serverextension list

Should output:

config dir: /usr/local/etc/jupyter
    elyra  enabled
    - Validating...
      elyra v1.0.0-rc.1 OK
    jupyterlab  enabled
    - Validating...
      jupyterlab 2.1.5 OK
    jupyterlab_git  enabled
    - Validating...
      jupyterlab_git 0.20.0 OK
    nbdime  enabled
    - Validating...
      nbdime 2.0.0 OK
jupyter labextension list

Should output:

Known labextensions:
   app dir: /.../share/jupyter/lab
        @elyra/code-snippet-extension v1.0.0-rc.1  enabled  OK*
        @elyra/metadata-editor-extension v1.0.0-rc.1  enabled  OK*
        @elyra/pipeline-editor-extension v1.0.0-rc.1  enabled  OK*
        @elyra/python-editor-extension v1.0.0-rc.1  enabled  OK*
        @elyra/theme-extension v1.0.0-rc.1  enabled  OK*
        @jupyterlab/git v0.20.0  enabled  OK
        @jupyterlab/toc v4.0.0  enabled  OK
        nbdime-jupyterlab v2.0.0  enabled  OK

NOTE: If you don't see the Elyra server extension enabled, you may need to explicitly enable it with jupyter serverextension enable elyra

Configuring Runtimes for Pipeline execution

The Elyra Pipeline editor delegates execution of pipelines to remote runtimes. Configure these external runtimes as documented in Runtime Configuration.

Starting Elyra

After verifying Elyra has been installed, start Elyra with:

jupyter lab

Contributing to Elyra

If you are interested in helping make Elyra better, we encourage you to take a look at our Contributing page,
Development Workflow documentation, and invite you to attend our weekly dev community meetings.

Weekly Dev Community Meeting

Join us weekly to discuss Elyra development topics. Everyone is welcome and participation is optional.

When: Thursdays at 9AM Pacific

Where: Webex

What: Meeting Notes