|
1 | | -# jupyter_server_documents |
2 | | - |
3 | | -A JupyterLab extension that provides RTC capabilities. |
| 1 | +# Jupyter Server Documents |
4 | 2 |
|
5 | 3 | This extension is composed of a Python package named `jupyter_server_documents` |
6 | 4 | for the server extension and a NPM package named `@jupyter/server-documents` |
7 | 5 | for the frontend extension. |
8 | 6 |
|
9 | | -## Try it out |
| 7 | +## Overview |
10 | 8 |
|
11 | | -Run with the proper configuration |
| 9 | +Jupyter Server Documents is a powerful extension for JupyterLab that enhances your notebook experience by moving the state of documents to the server. Key features include: |
12 | 10 |
|
13 | | -``` |
14 | | -jupyter lab --config jupyter_config.py |
15 | | -``` |
| 11 | +### Real-Time Collaboration |
| 12 | + |
| 13 | +- New, optimized real-time collabortion engine for Jupyter Server |
| 14 | +- Significant performance and memory usage improvements |
| 15 | +- Proper handling of out-of-band changes (e.g. `git checkout`) |
| 16 | +- No data loss or duplication |
| 17 | + |
| 18 | +### Enhanced Performance |
| 19 | + |
| 20 | +- Optimized memory usage through intelligent output management |
| 21 | +- Significantly faster loading of notebooks with large outputs |
| 22 | +- Reduced memory footprint for notebooks with extensive output data |
| 23 | +- Automatic saving of changes to prevent data loss |
| 24 | + |
| 25 | +### Improved Kernel Management |
| 26 | + |
| 27 | +- More reliable kernel execution and connection handling |
| 28 | +- Enhanced stability with better error recovery mechanisms |
| 29 | +- Streamlined message handling between kernels and the frontend |
| 30 | +- Improved kernel restart and reconnection capabilities |
| 31 | + |
| 32 | +### Efficient Output Handling |
| 33 | + |
| 34 | +- Smart output storage separates large outputs from notebook documents |
| 35 | +- Output streaming controls prevent memory issues with unbounded outputs |
| 36 | +- Faster notebook navigation even with extensive computational outputs |
| 37 | +- Lazy loading of outputs for improved responsiveness |
| 38 | + |
| 39 | +This extension provides the foundation for a more collaborative, stable, and performant JupyterLab experience, especially valuable for data scientists and researchers working with complex notebooks or in team environments. |
16 | 40 |
|
17 | 41 | ## Requirements |
18 | 42 |
|
19 | | -- JupyterLab >= 4.0.0 |
| 43 | +- JupyterLab >= 4.4.0 |
20 | 44 |
|
21 | 45 | ## Installation |
22 | 46 |
|
|
0 commit comments