-
Notifications
You must be signed in to change notification settings - Fork 14
chore: add ipykernel docs AI-22776 #98
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
EdisonSu768
wants to merge
1
commit into
main
Choose a base branch
from
chore/ipykernel
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+107
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,3 +14,4 @@ | |
| node_modules | ||
| dist | ||
| .DS_Store | ||
| .idea | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| --- | ||
| products: | ||
| - Alauda AI | ||
| kind: | ||
| - Solution | ||
| ProductsVersion: | ||
| - 1.5 | ||
| --- | ||
| # Add a New ipykernel in JupyterLab | ||
|
|
||
| This document explains how to create a new Python virtual environment, register it as a Jupyter ipykernel, and verify that it is available in JupyterLab. | ||
|
|
||
| All commands in this guide should be executed **inside the JupyterLab environment**. You can either exec into the JupyterLab Pod using Kubernetes commands, or run the commands directly from the **Terminal** available on the JupyterLab Launcher page. | ||
|
|
||
| ## Download an Additional Python Version (Optional) | ||
|
|
||
| The built-in Python version in JupyterLab is **Python 3.11**. If you need a virtual environment based on a different Python version, it is recommended to download a **prebuilt standalone Python distribution** instead of compiling Python manually or installing system packages. | ||
|
|
||
| In this guide, we use **python-build-standalone**, which provides a *clean, dependency-free, precompiled Python binary for Linux*. This approach does not rely on system libraries, does not require root privileges. It is well-suited for containerized or restricted environments such as JupyterLab. | ||
|
|
||
| The following example shows how to install **Python 3.10** using a python-build-standalone release: | ||
|
|
||
| ```bash | ||
| # Create a directory | ||
| mkdir -p ~/python310_static && cd ~/python310_static | ||
|
|
||
| # Download a prebuilt Python 3.10 archive (recent 2024 build) | ||
| curl -L https://github.com/indygreg/python-build-standalone/releases/download/20240107/cpython-3.10.13+20240107-x86_64-unknown-linux-gnu-install_only.tar.gz | tar -xz | ||
|
|
||
| # Verify the Python version (expected output: Python 3.10.13) | ||
| ~/python310_static/python/bin/python3 --version | ||
|
|
||
| # Create a virtual environment using Python 3.10 | ||
| ~/python310_static/python/bin/python3 -m venv ~/.venv-py310 | ||
| ``` | ||
|
|
||
| ## Create and Register a New ipykernel | ||
|
|
||
| First, create a new Python virtual environment: | ||
|
|
||
| ```bash | ||
| python -m venv ~/.venv-testing | ||
|
|
||
| # If you installed Python 3.10 in the previous section, use: | ||
| ~/python310_static/python/bin/python3 -m venv ~/.venv-py310 | ||
| ``` | ||
|
|
||
| Activate the virtual environment: | ||
|
|
||
| ```bash | ||
| source ~/.venv-testing/bin/activate | ||
|
|
||
| # If you are using the Python 3.10 virtual environment: | ||
| source ~/.venv-py310/bin/activate | ||
| ``` | ||
|
|
||
| Install the required `ipykernel` package into the virtual environment: | ||
|
|
||
| ```bash | ||
| pip install ipykernel -i https://pypi.tuna.tsinghua.edu.cn/simple | ||
| ``` | ||
|
|
||
| Register this virtual environment as a Jupyter kernel: | ||
|
|
||
| ```bash | ||
| python -m ipykernel install \ | ||
| --user \ | ||
| --name python-testing \ | ||
| --display-name "Python (testing)" | ||
| ``` | ||
|
|
||
| Verify that the new kernel has been registered successfully: | ||
|
|
||
| ```bash | ||
| jupyter kernelspec list | ||
| ``` | ||
|
|
||
| Example output: | ||
|
|
||
| ```text | ||
| Available kernels: | ||
| python3 /home/jovyan/.venv/share/jupyter/kernels/python | ||
| python-testing /home/jovyan/.local/share/jupyter/kernels/python-testing | ||
| ``` | ||
|
|
||
| ## Verify the Kernel in JupyterLab | ||
|
|
||
| After registering the kernel, refresh the JupyterLab page in your browser. | ||
|
|
||
| On the **Launcher** page, a new card named **Python (testing)** will appear under both the **Notebook** and **Console** sections. | ||
|
|
||
| Click **Python (testing)** under **Console** to open a new console tab, then run the following code to verify that the kernel is using the correct environment: | ||
|
|
||
| ```python | ||
| import sys | ||
|
|
||
| print("Python version:", sys.version) | ||
| print("Python executable:", sys.executable) | ||
| ``` | ||
|
|
||
| If the output shows the Python executable path pointing to the newly created virtual environment, the ipykernel has been configured correctly. For example: | ||
|
|
||
| ```text | ||
| Python version: 3.11.13 (main, ...) | ||
| Python executable: /home/jovyan/.venv-testing/bin/python | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.