Datalayer on JupyterLab
Datalayer integrates seamlessly as a JupyterLab extension, allowing you to manage and interact with Runtimes directly from your familiar JupyterLab interface. The extension mirrors the functionality available on Datalayer SaaS once you log in.
Installation
To install the Datalayer extension for JupyterLab, ensure you have python>=3.9 and pip installed on your machine. Then, run the following command in your terminal.
# Use --upgrade if you want to update an existing installation to the latest version.
pip install datalayer
Environment setup with conda
If you are using conda, you can create a new environment and install the required packages as follows. Note that conda and miniconda are interchangeable.
ENV_NAME=datalayer
miniconda create -y -n $ENV_NAME
miniconda activate $ENV_NAME
miniconda install -c conda-forge -y python=3.11 pip
pip install datalayer
Start JupyterLab as usual.
jupyter lab
You can provide traits to configure the Datalayer server as well as additional options used at runtime.
jupyter lab \
--DatalayerExtensionApp.run_url="https://prod1.datalayer.run" \
--DatalayerExtensionApp.white_label=False \
--DatalayerExtensionApp.Launcher.category="GPU" \
--DatalayerExtensionApp.Launcher.name="GPU Runtimes" \
--DatalayerExtensionApp.Launcher.icon_svg_url="https://raw.githubusercontent.com/datalayer/icons/main/svg/data2/circle-white.svg" \
The traits can be provided in a configuration as well, see the Jupyter common directories and file locations.
JupyterLab users are familiar accessing the feature via tiles as shown below.
Datalayer introduces a new section. Click on the Jupyter Kernels tile to access the Datalayer interface.
Account
- Login
- Logout
- Profile
Before login, you should have a valid account created during the Join process from the SaaS.
Once the Datalayer extension is installed, you can login via the user interface.
If you have a Token, you can use it to authenticate. The Token can be a Datalayer Token or an External Token in case of integration with an External IAM Provider.
You can logout at any time.
Once logged in, you can view the details of your profile.
You can view your profile details in the "Profile" section.
Environments
Refer to the Environments feature documentation for more information.
You can see the list of available environments in the SaaS under the Environments tab.
Runtimes
Refer to the Runtimes feature documentation for more information.
- Launch
- Assign
- Interrupt
- Restart
- Pause
- Resume
- Transfer State
- Terminate
You can launch Runtimes from the "Runtimes" page of the extension.
Refer to the Launch a Runtime feature documentation for more information on the different options available.
Assign a Runtime to a Notebook
You can change the Runtime of any Notebook to a Runtime by using the Runtime Picker. The Runtime Picker is located in the top-right corner of the Notebook interface.
You can also launch a new Runtime directly from the Runtime Picker by selecting an environment in the 'Assign a new Kernel' section. You'll have the option to configure the Runtime settings, such as Time Reservation.
Assign a Runtime to a Cell
Datalayer allows you to selectively run specific Notebook cells on Runtime. This hybrid approach optimizes both performance and cost by using Remote resources only when necessary.
Learn more about this feature in our Blog Post.
To assign a cell to a Runtime, simply use the cell menu as shown below.
Refer to the Interrupt a Runtime feature documentation for more information.
Refer to the Restart a Runtime feature documentation for more information.
Refer to the Pause a Runtime feature documentation for more information.
Refer to the Resume a Runtime feature documentation for more information.
Refer to the Terminate a Runtime feature documentation for more information.
Runtimes Snapshots
Refer to the Runtimes Snapshots feature documentation for more information.
Credits
Refer to the Credits feature documentation for more information.
Go to the "Usage" tab to see your credit consumption with detailed dashboard and to add credits.
