User Guide
Learn how to use the JupyterLab Mount Extension with Pachyderm.
March 22, 2023
Select a Project #
You can filter mountable repositories by selecting a project.
- Open the JupyterLab UI.
- Navigate to the Project dropdown.
- Select an existing project or the
default
project.
Create a Repo & Repo Branch #
-
Open the JupyterLab UI.
-
Open a Terminal from the launcher.
-
Input the following:
pachctl create repo demo pachctl create branch demo@master
-
Check the Unmounted Repositories section.
Your repo is created within the project set to your current context.
Mount a Repo Branch #
- Open the JupyterLab UI.
- Navigate to the Unmounted Repositories section.
- Scroll to a repository’s row.
- Select Mount.
Mount (and Test) a Datum #
You can mount to 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.
-
Open the JupyterLab UI.
-
Mount to a repo from the Unmounted Repositories section. (e.g., mounting to
demo
would look like/pfs/demo/
in the file browser). -
Navigate to the Mounted Repositories section and select Datum.
You should see the following:
pfs: repo: demo branch: master glob: /
-
Update the glob pattern to match the datums you wish to focus on.
Directory Example #
pfs: repo: demo branch: master glob: /images/2022/*
Extension Example #
pfs: repo: demo branch: master glob: /images/**.png
-
Select Mount Datums.
-
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.
- Mounted repositories are nested within the root
/pfs
(Pachyderm’s File System) - These repositories are read-only
- Mounted repositories have a
/
glob pattern applied to their directories and files - Files only downloaded locally when you access them (saving you time)
Using the previous example, while the Demo repository is mounted, you can select the demo folder to reveal the example myfile.txt
.