Run Commands

User Guide

Learn how to use the JupyterLab Mount Extension.

Select a Project #

You can filter mountable repositories by selecting a project.

  1. Open the JupyterLab UI.
  2. Navigate to the Pachyderm Mount tab ().
  3. Navigate to the Project dropdown.
  4. Select an existing project or the default project.

project select

Create a Repo & Repo Branch #

  1. Open the JupyterLab UI.

  2. Open a Terminal from the launcher.

  3. Input the following:

    pachctl create repo demo
    pachctl create branch demo@master
  4. Open the Pachyderm tab ().

  5. Check the Unmounted Repositories section.

create repo and branch


Your repo is created within the project set to your current context.

Create a Pipeline #

  1. Open the JupyterLab UI.
  2. Create a notebook from the launcher (it can be left blank).
  3. Navigate to the Pachyderm tab ().
  4. Select Pipeline in the side panel.
  5. Input values for all of the following:
    • Name: The name of your pipeline.
    • Image: The Docker Hub image that has your user code.
    • Requirements: A requirements.txt file that contains the dependencies for your code.
    • Input Spec: The input spec for your pipeline in YAML format. See the Pipeline Specification for input options.
  6. Select Save.
  7. Select Create Pipeline.
  8. Track the status of your pipeline using the command pachctl list pipelines in a terminal or view the pipeline in Console.

You can view the full compiled pipeline spec from the Pipline Spec Preview section.

Load a Repo Branch #

  1. Open the JupyterLab UI.
  2. Navigate to the Pachyderm tab ().
  3. Navigate to the Unmounted Repositories section.
  4. Scroll to a repository’s row.
  5. Select Load.

load repo

Load (and Test) a Datum #

You can load a specific datum in your repository from the JupyterLab UI using an input spec. This is useful when:

  • Working on data that is deeply nested within a specific directory of your repository.
  • Testing and exploring viable glob patterns to use for your datums.
  1. Open the JupyterLab UI.

  2. Navigate to the Pachyderm tab ().

  3. Load a repo from the Unmounted Repositories section. (e.g., loading demo would look like /pfs/demo/ in the file browser).

  4. Navigate to the Mounted Repositories section and select Datum.

    mount and test datums

    You should see the following:

       repo: demo
       branch: master
       glob: /
  5. Update the glob pattern to match the datums you wish to focus on.

    Directory Example #
       repo: demo
       branch: master
       glob: /images/2022/*
    Extension Example #
       repo: demo
       branch: master
       glob: /images/**.png
  6. Select Load Datums.

  7. The file browser updates to display the matching datums.

When you return to the mounted view by selecting Back, the file browser will return to displaying datums that match your default glob pattern.

Explore Directories & Files #

At the bottom of the Mounted Repositories tab, you’ll find the file browser.

  • File and directory structure of your repositories can be viewed using this file browser.
  • These repositories are read-only.
  • File formats that are supported by JupyterLab can be viewed by double-clicking the file.
  • Files and directories can be downloaded to the CWD as needed by right-clicking the file or directory then selecting the Download item. This can be useful for testing your code against your Pachyderm data.