Elyra

Elyra 是一组以 AI 为中心的 JupyterLab Notebook 扩展。

Elyra 目前包含以下功能：

• 可视化工作流编辑器
• 将 Notebook、Python 或 R 脚本作为批处理作业运行的能力
• 可重用代码片段
• AI 助手集成，用于在 Notebook 单元格中提供 AI 驱动的代码辅助。配置详情请参阅 AI 助手设置指南。
• 混合运行时支持，基于 Jupyter Enterprise Gateway
• 具有本地/远程执行能力的 Python 和 R 脚本编辑器
• 使用自动生成目录的 Python 脚本导航
• Python 脚本集成调试器（实验性）
• 使用自动生成目录的 Notebook 导航
• 语言服务器协议集成
• 使用 Git 集成进行版本控制

Elyra 入门指南 包含更多关于这些功能的详细信息。特定版本的新特性摘要位于 发布页面。

试用 Elyra

使用容器镜像

您也可以通过运行来自 Docker Hub 或 quay.io 的容器镜像来试用 Elyra：

• elyra/elyra:latest 安装了最新发布的版本。
• elyra/elyra:x.y.z 安装了特定版本。

注意：您还可以从 main 分支构建容器镜像（“开发版”），以试用尚未发布的功能。

要运行其中一个容器镜像，您可以发出以下命令，并指定您选择的标签。

docker run -it -p 8888:8888 elyra/elyra:dev jupyter lab --debug

要使包含您的 Notebooks 的本地目录（例如 ${HOME}/opensource/jupyter-notebooks/）在 Docker 容器中可用，可以使用类似如下的挂载命令：

docker run -it -p 8888:8888 -v ${HOME}/opensource/jupyter-notebooks/:/home/jovyan/work -w /home/jovyan/work elyra/elyra:dev jupyter lab --debug

这些命令应产生类似于下面的输出，您可以在其中找到用于在本地浏览器中访问 Elyra 的 URL。

    要访问 Notebook，请在浏览器中打开此文件：
        file:///home/jovyan/.local/share/jupyter/runtime/nbserver-6-open.html
    或复制并粘贴以下任一 URL：
        http://4d17829ecd4c:8888/?token=d690bde267ec75d6f88c64a39825f8b05b919dd084451f82
     或 http://127.0.0.1:8888/?token=d690bde267ec75d6f88c64a39825f8b05b919dd084451f82

有关详细信息，请参阅 安装文档。

安装

有关详细信息，请参阅 安装文档。

先决条件：

• Node.js 22
• Python 3.10+
• Miniconda / Micromamba（可选）

安装当前版本（适用于 JupyterLab 4.x）

当前版本显示在本页顶部。

• 从 PyPI 安装

  pip3 install --upgrade "elyra[all]"
  

• 从 conda-forge 安装

  conda install -c conda-forge "elyra[all]"
  

安装旧版本

不同版本的安装说明和 JupyterLab 支持有所不同。请注意，需要构建 JupyterLab 才能使用。安装说明位于特定版本的文档中，可通过选择特定版本进行访问。

Elyra 4.x（JupyterLab 4.2.5+）

• 从 PyPI 安装

  pip3 install --upgrade "elyra[all]"
  

• 从 conda-forge 安装

  conda install -c conda-forge "elyra[all]"
  

Elyra 3.7 < 4.0（JupyterLab 3.x）

• 从 PyPI 安装

  pip3 install --upgrade "elyra[all]<4.0.0"
  

• 从 conda-forge 安装

  conda install -c conda-forge "elyra[all]<4.0.0"
  

Elyra 3.1 < 3.7（JupyterLab 3.x）

• 从 PyPI 安装

  pip3 install --upgrade "elyra[all]>=3.1.0" && jupyter lab build
  

• 从 conda-forge 安装

  conda install -c conda-forge "elyra[all]>=3.1.0" && jupyter lab build
  

Elyra 2.0 < 3.1（JupyterLab 3.x）

• 从 PyPI 安装

  pip3 install --upgrade "elyra>=2.0.1" && jupyter lab build
  

• 从 conda-forge 安装

  conda install -c conda-forge "elyra>=2.0.1" && jupyter lab build
  

验证安装

运行以下命令以验证安装。请注意，在下面的示例输出中，[version] 占位符代替了实际的版本标识符，该标识符可能会随每次发布而变化。

jupyter server extension list

应输出：

配置目录：/.../.jupyter

配置目录：/.../etc/jupyter
    elyra 已启用
    - 正在验证 elyra...
      elyra 已通过
    jupyter_lsp 已启用
    - 正在验证 jupyter_lsp...
      jupyter_lsp [version] 已通过
    jupyter_resource_usage 已启用
    - 正在验证 jupyter_resource_usage...
      jupyter_resource_usage [version] 已通过
    jupyter_server_mathjax 已启用
    - 正在验证 jupyter_server_mathjax...
      jupyter_server_mathjax 已通过
    jupyterlab 已启用
    - 正在验证 jupyterlab...
      jupyterlab [version] 已通过
    jupyterlab_git 已启用
    - 正在验证 jupyterlab_git...
      jupyterlab_git [version] 已通过
    nbclassic 已启用
    - 正在验证 nbclassic...
      nbclassic 已通过
    nbdime 已启用
    - 正在验证 nbdime...
      nbdime [version] 已通过

配置目录：/.../etc/jupyter

注意：如果您没有看到 Elyra 服务器扩展已启用，可能需要使用 jupyter server extension enable elyra 命令显式启用它。

jupyter labextension list

应输出：

JupyterLab [version]
/.../share/jupyter/labextensions
        nbdime-jupyterlab [version] 已启用且正常
        @jupyter-server/resource-usage [version] 已启用且正常（Python，jupyter-resource-usage）
        @krassowski/jupyterlab-lsp [version] 已启用且正常（Python，jupyterlab_lsp）
        @elyra/code-snippet-extension [version] 已启用且正常
        @elyra/metadata-extension [version] 已启用且正常
        @elyra/pipeline-editor-extension [version] 已启用且正常
        @elyra/python-editor-extension [version] 已启用且正常
        @elyra/scala-editor-extension [version] 已启用且正常
        @elyra/r-editor-extension [version] 已启用且正常
        @elyra/theme-extension [version] 已启用且正常
        @jupyterlab/git [version] 已启用且正常（Python，jupyterlab-git）

其他内置在 JupyterLab 中的 Lab 扩展
   应用程序目录：/.../share/jupyter/lab

启动 Elyra

在确认 Elyra 已成功安装后，可以通过以下命令启动 Elyra：

jupyter lab

获取帮助

我们欢迎您的问题、想法和反馈。请查看《入门指南》中的获取帮助部分，了解您可以用来与我们联系的各种渠道。

参与 Elyra 贡献

如果您有兴趣帮助改进 Elyra，我们鼓励您查看我们的贡献页面、开发工作流程文档，并邀请您参加我们每周的开发者社区会议。

与我们见面！

我们的每日和每周社区会议日程安排可在此处找到。

Elyra 快速上手指南

Elyra 是一套面向 AI 开发的 JupyterLab 扩展工具集，支持可视化流水线编辑、脚本批量执行、代码片段复用及 AI 助手集成等功能，旨在简化机器学习工作流的构建与运行。

环境准备

在开始之前，请确保您的系统满足以下前置依赖要求：

• Node.js: 版本 22
• Python: 版本 3.10 或更高
• 包管理器 (可选但推荐): Miniconda 或 Micromamba
• JupyterLab: 需安装 JupyterLab 4.x (当前最新版本)

注意：国内用户若遇到网络问题，建议在安装 Python 包时配置清华或阿里云镜像源。

安装步骤

您可以选择通过 pip 或 conda 进行安装。以下命令将安装包含所有功能的完整版本。

方式一：使用 pip 安装

# 推荐使用国内镜像源加速下载
pip3 install --upgrade "elyra[all]" -i https://pypi.tuna.tsinghua.edu.cn/simple

方式二：使用 conda 安装

conda install -c conda-forge "elyra[all]"
# 若 conda-forge 下载缓慢，可尝试配置国内镜像源后执行上述命令

验证安装

安装完成后，运行以下命令检查服务器扩展和前端插件是否启用成功：

jupyter server extension list

输出中应包含 elyra enabled 且状态为 OK。

jupyter labextension list

输出中应包含 @elyra/pipeline-editor-extension 等相关插件且状态为 enabled OK。

如果未看到 Elyra 服务器扩展启用，请手动执行：jupyter server extension enable elyra

基本使用

1. 启动 Elyra

安装验证无误后，直接启动 JupyterLab 即可进入 Elyra 环境：

jupyter lab

浏览器会自动打开 JupyterLab 界面，此时您已可以使用 Elyra 的各项功能。

2. 创建可视化 AI 流水线 (Visual Pipeline)

1. 在 JupyterLab 左侧文件浏览器中，右键点击空白处。
2. 选择 New > Pipeline。
3. 将现有的 .ipynb (Notebook)、.py (Python 脚本) 或 .r (R 脚本) 文件拖拽至画布中作为节点。
4. 连接节点以定义执行顺序。
5. 点击工具栏的 Run 按钮，即可将流水线作为批处理作业提交执行（支持本地或远程集群）。

3. 使用 AI 助手与代码片段

• AI 助手：在 Notebook 单元格中，可通过集成的 AI Assistant (需额外配置) 获取代码建议。
• 代码片段：点击左侧边栏的代码片段图标，可直接拖拽预定义的常用代码块到编辑器中，提高开发效率。

替代方案：使用 Docker 快速体验

如果您不想配置本地环境，可以直接使用 Docker 容器运行最新版 Elyra：

docker run -it -p 8888:8888 -v ${HOME}/jupyter-notebooks/:/home/jovyan/work -w /home/jovyan/work elyra/elyra:latest jupyter lab --debug

运行成功后，复制终端输出的带有 token 的 URL (例如 http://127.0.0.1:8888/?token=...) 到浏览器访问即可。