Skip to content

Commit 8527998

Browse files
authored
Update README.md
1 parent 2417ff8 commit 8527998

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,43 @@
11
# jupyterlab_variableinspector
2-
2+
![PyPi_Version](https://img.shields.io/pypi/v/lckr-jupyterlab-variableinspector)
33
![Build](https://github.com/lckr/jupyterlab-variableInspector/workflows/Build/badge.svg)
44
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/lckr/jupyterlab-variableInspector.git/master?urlpath=lab)
55

6-
Jupyterlab extension that shows currently used variables and their values. The goal is to provide a tool similar to the variable inspector in RStudio.
7-
8-
This project is inspired by the [variable inspector extension for jupyter notebooks](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/tree/master/src/jupyter_contrib_nbextensions/nbextensions/varInspector) and by the [inspector extension included in jupyterlab](https://github.com/jupyterlab/jupyterlab/tree/master/packages/inspector-extension).
9-
10-
Contributions in any form are very welcome!
6+
Jupyterlab extension that shows currently used variables and their values.
7+
Contributions in any form are welcome!
118

129
## Features
1310

1411
![Demogif](early_demo.gif)
1512

1613
- Allows inspection of variables for both consoles and notebooks.
17-
- This extension is currently targets `python` as a main language but also supports the following languages with different levels of feature completeness
18-
- `R`
19-
- `scala` via the [almond kernel](https://github.com/almond-sh/almond)
2014
- Allows inspection of matrices in a datagrid-viewer. This might not work for large matrices.
2115
- Allows an inline and interactive inspection of Jupyter Widgets.
16+
17+
### Supported Languages
18+
- This extension is currently targets `python` as a main language but also supports the following languages with different levels of feature completeness
19+
- `R`
20+
- `scala` via the [almond kernel](https://github.com/almond-sh/almond)
21+
2222

23-
**Caveat** In order to allow variabale inspection, all content that is displayed first need to be sent from the kernel to the front end.
23+
### How it Works
24+
In order to allow variabale inspection, all content that is displayed first need to be sent from the kernel to the front end.
2425
Therefore, opening large data frames with the datagrid viewer can dramatically increase your occupied memory and *significantly slow down* your browser.
2526
Use at your own risk.
2627

2728

2829
## Requirements
29-
3030
* JupyterLab >= 3.0
3131

32-
### Requirements for Python functionality
33-
32+
### Requirements for `python` functionality
3433
- `pandas` and `numpy` are required to enable matrix inspection.
3534
- `pyspark` for spark support.
3635
- `tensorflow` and `keras` to allow inspection of tf objects.
36+
- `torch` for PyTorch support.
37+
38+
### Requirements for `R` functionality
39+
- The `repr` library.
40+
3741

3842
### Requirements for `ipywidgets` functionality
3943

@@ -46,10 +50,7 @@ The requirements for this functionality are:
4650
- `ipywidgets`
4751
- Support for widgets in JupyterLab: `jupyter labextension install @jupyter-widgets/jupyterlab-manager`
4852

49-
### Requirements for R functionality
5053

51-
- The `repr` library.
52-
5354

5455
## Install
5556

0 commit comments

Comments
 (0)