Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lablup/backend.ai-integration-jupyter
Jupyter kernel integration for Backend.AI
https://github.com/lablup/backend.ai-integration-jupyter
backendai cloud-computing integration jupyter python
Last synced: 20 days ago
JSON representation
Jupyter kernel integration for Backend.AI
- Host: GitHub
- URL: https://github.com/lablup/backend.ai-integration-jupyter
- Owner: lablup
- License: mit
- Created: 2017-03-16T02:47:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-09T14:54:07.000Z (about 6 years ago)
- Last Synced: 2024-10-27T22:12:14.521Z (24 days ago)
- Topics: backendai, cloud-computing, integration, jupyter, python
- Language: Python
- Homepage:
- Size: 131 KB
- Stars: 10
- Watchers: 16
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Backend.AI Integration for Jupyter
==================================
Your Jupyter notebooks are running on the Backend.AI Cloud!
Migration Guide for v0.1.x "Sorna" Users
----------------------------------------
Now we use the v1.0.0 release of [Backend.AI Client for Python]
(https://pypi.python.org/pypi/backend.ai-client).
To use the latest version, please remove all existing "Sorna" kernel
configurations and re-install them.
```console
$ python -m sorna.integration.jupyter.install --clean-only
Removing existing Sorna kernel: C11 on Sorna
...
$ pip uninstall sorna-jupyter-integration
...
$ pip install backend.ai-integration-jupyter
...
$ python -m ai.backend.integration.jupyter.install
Installing Backend.AI Jupyter kernel spec: Python 3 on Backend.AI
...
```
Note that you also need to reconfigure your existing notebooks to use the new
kernels. This is a safe operation -- you can change the backend kernel without
losing/modifying the content of notebooks.
Installation and Usage
----------------------
First, grab your API keypair in [Backend.AI Cloud](https://cloud.backend.ai).
```console
$ pip install jupyter backend.ai-integration-jupyter
$ python -m ai.backend.integration.jupyter.install
$ export BACKEND_ACCESS_KEY=...
$ export BACKEND_SECRET_KEY=...
$ jupyter notebook
```
Then you will see Backend.AI kernels in the new notebook menu:
More kernels will become available soon!
**NOTE:** Currently only Python-based kernels support cross-cell contexts
(i.e., variables are kept across different notebook cells which is the default
behavior of Jupyter notebooks you already know). With other language kernels,
each cell is executed as a separate process, meaning that a new context is used
whenever you execute a cell.
Development
-----------
Add `--sys-prefix` argument to tell the installer to recognize editable
installation under your virtual environment.
```console
$ python -m venv venv
$ source venv/bin/activate
$ pip install jupyter
$ pip install -e . # editable installation
$ python -m ai.backend.integration.jupyter.install --sys-prefix
$ export BACKEND_ACCESS_KEY=...
$ export BACKEND_SECRET_KEY=...
$ jupyter notebook
```
Uninstall
---------
To list and uninstall existing kernelspecs registered to Jupyter, use
`jupyter-kernelspec` command.