Skip to content

kfp-example-components-connector

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

kfp-example-components-connector

README.md

PyPI version

Kubeflow Pipelines component examples catalog

This catalog connector provides access to example pipeline components for Kubeflow Pipelines.

Install the component examples

You can install the component examples from PyPI or source code. Note that a rebuild of JupyterLab is not required.

Prerequisites

  • Install Elyra (version 3.7 and above). This connector version does not support Elyra versions below 3.7.

Install from PyPI

To install the connector from PyPI:

$ pip install elyra-examples-kfp-catalog

Install from source code

To install the connector from source:

$ git clone https://github.com/elyra-ai/examples.git
$ cd examples/component-catalog-connectors/kfp-example-components-connector/
$ make clean source-install

Run connector unit tests

To run the unit tests:

$ git clone https://github.com/elyra-ai/examples.git
$ cd examples/component-catalog-connectors/kfp-example-components-connector/
$ make test

Use the connector

  1. Launch JupyterLab.
  2. Open the 'Manage Components' panel.
  3. Add a new component examples catalog ('+' > 'New Kubeflow Pipelines example components catalog').
  4. Specify a catalog name, e.g. 'Example components for Kubeflow Pipelines'.
  5. Save the catalog entry.
  6. Open the Visual Pipeline Editor for Kubeflow Pipelines and expand the palette. The example components are displayed.

Customize the catalog

This connector utilizes an embedded catalog as storage and is therefore a static catalog. To customize the catalog content according to your needs:

  1. Clone or fork the https://github.com/elyra-ai/examples repository.
  2. Navigate to the examples/component-catalog-connectors/kfp-example-components-connector/kfp_examples_connector/resources directory. This directory contains the Kubeflow Pipelines components that this connector makes available to Elyra.
  3. Change the content of this directory as desired.
  4. Install the connector from source.

Uninstall the connector

  1. Remove all example catalog entries from the 'Manage Components' panel.
  2. Stop JupyterLab.
  3. Uninstall the elyra-examples-kfp-catalog package. 
    $ pip uninstall -y elyra-examples-kfp-catalog

Troubleshooting

Q: No example components are displayed in the Visual Pipeline Editor palette.

A: Check the JupyterLab log file for error messages.