Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/205g0/notebook-free-notebook
A professional, lock-in-free Jupyter dev env for coders, teams and non-trivial, large Jupyter projects
https://github.com/205g0/notebook-free-notebook
ipynb ipython jupyter jupyter-notebook jupyter-notebooks jupyterlab vscode
Last synced: 2 months ago
JSON representation
A professional, lock-in-free Jupyter dev env for coders, teams and non-trivial, large Jupyter projects
- Host: GitHub
- URL: https://github.com/205g0/notebook-free-notebook
- Owner: 205g0
- Created: 2020-12-05T11:05:13.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-02-16T05:04:45.000Z (almost 4 years ago)
- Last Synced: 2024-09-27T23:41:03.730Z (3 months ago)
- Topics: ipynb, ipython, jupyter, jupyter-notebook, jupyter-notebooks, jupyterlab, vscode
- Homepage:
- Size: 1.04 MB
- Stars: 39
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
⚠️ _Disclaimer: If you think there is nothing wrong with notebooks (.ipynb files) or a data scientist who never coded professionally in teams this post might not be for you or offense you._
# Notebook-free Notebook
## A professional, lock-in-free Jupyter dev env for coders, big teams and non-trivial, large Jupyter projects
### Minimal but fully-featured, no fluff, no nonsense, no docs, no .ipynb, free 🎅🏼 🎅🏼 🎅🏼
#### This is a stupid-simple 5-minute read and you're ready to go, it's just a readme and won't try to sell you anything (no slow web IDE, not another modded Jupyter Notebook nor Lab, no laggy, shared, overpriced or capped "free" GPUs from 2010 in a fugly web dashboard, no books, no courses, no consulting, no monthly subscriptions haha)
To skip my click-baity marketing fluff scroll down to Quick Setup!
tl;dr never touch notebooks/.ipynb files again, use VS Code + VS Code's Interactive Python Tab + the Jupyter kernel + .py scripts in the percent format and move on
**Key features:**
- **No .ipynb, no notebooks or the planet's worst file format**
- **Not for toy projects**
- **No vendor lock-in**
- **Zero properietary tooling, no evanglism, no nonsense, no new framework, no esoteric workflows**
- **Works with large TPU farms or minimal local setups**
- **Works with cloud or local TPUs out of the box**
- **Super simple, no moving parts, just 2 parts—VS Code and a Jupyter kernel**
- **No gazillion pages of documentation**
- **No fragile or complex setup**
- **No gatekeeper or arbitrageur between you and the TPUs, get maximum speed at the lowest price**
- **Fast and easy setup**
- **Optional vim binds**
- **Not opioniated, you could still use .ipynb files**
- **Free**
Initially, I was impressed by Jupyter and notebooks but found them quickly annoying (coming from a programming background). Finding the right IDE was not easy because the entire data science community is using .ipynb notebooks + many vendor-locked-in, pricey, slow products lacking essential/typical dev features. I finally came to following setup which is rather for coders and not for data scientists who are not familiar with traditional coding contexts/workflows. It is at the same time very simple but powerful and flexible like no other tooling:
**Features detailed:**
- VS Code as front-end but **not** with VS Code's built-in notebook viewer[1]
- Instead I use **VS Code's Interactive Python Tab** which allows quick execution of one cell with `Ctrl-Enter` or all above cells
- The Interactive Tab shows the cell outputs in **chronological order**
- The **execute above cells** feature is quite handy, it's located at every cell and let you run the entire notebook till that button
- **vim binds** via the vim plugin[2]; fwiw, this setup is the only with proper vim binds next to Google's Colab
- The Jupyter kernel runs on a beefy remote machine (any kind of bare-metal TPU-based machine in the cloud, under you desk, etc.) connected to VS Code; the Jupyter Notebook or Lab interface is not used
- **Images are rendered;** sounds like a minor thing but it's not, before I sent via vim-slime commands to a tmux tab with IPython which is a similar setup but I couldn't render images because it's in the terminal
- Easy shareable, human-readable raw files and git-committable `.py` files which have all the notebook data in the convinient *percent format*
- Any further shortcuts above the vim layer can be defined
- Since TPUs can be hosted anywhere with huge bandwidths, moving gbyte of data sets between source servers and your TPU servers is just one scp command away at max speed and a piece of cake; you are not locked-in into any slow server infrastructure from one provider
- Free as in free lunch
### Quick Setup
- Install VS Code on a client machine, miniconda and Jupyter on a beefy TPU machine or locally
- Run Jupyter without using Jupyter Notebook nor Lab, copy the access url/token from the log
- In VS Code open the Command Palette, eg. with F1 and search for _Jupyter: Specify local or remote Jupyter server for connections_, click on existing and add the token
- Now import .ipynb files which will converted to .py in the percent format or just start with some code
- Use the given shortcuts, such as `Ctrl-Enter` for executing a cell or add your own shortcuts
I found this setup painless, scalable and most important fluid. No manual back and forth between cells but one file of code with easy, instant navigation via vim binds. No cloud notebook vendor lock-in and a super simple setup.
It is for teams (fully git-able and human-readable in contrast to .ipynb), scalable and in particular for non-trivial, larger projects because it clearly separates (one of the most flexible) frontends and TPUs without locking in the users into anything.
Give a user 8x A100 and he does the entire dev setup in 5 minutes incl. OS installation of the TPU machines and it doesn't matter if the TPUs are in the cloud or under his desk haha, no lock-in nowhere. Or give this setup to a friend and he will git clone your model 1:1 and run it within seconds on his new 3090. Or another peer who prefers vim binds because it might be easier to explore/do his own experiments/navigate through huge code bases for hours. Or a data scientist who prefers the .ipynb format, one click and voilà, he can work in the notebook format. IDK of any other free IDE that allows such flexibility without any lock-in.
You have ideas how to improve this setup? PRs are welcome!
A must-watch on why notebooks might not be the right choice for professional developers: https://www.youtube.com/watch?v=7jiPeIFXb6U and the slides to this talk https://docs.google.com/presentation/d/1n2RlMdmv1p25Xy5thJUhkKGvjtV-dkAIsUXP-AL4ffI/edit#slide=id.g3a428e2eb8_0_259
[1] VS Code's built-in native `.ipynb` viewer is good but it does not support any vim bind extension and I still think the notebook paradigm is not the right one. For learning and following tutorials in the beginning it's great but once you interact more than you read it slows you down.
[2] vim binds have a steep learning curve but once you have the muscle memory you should be faster when dealing with large code bases (different discussion but just to clarify my requirements in this regard)
