-
Notifications
You must be signed in to change notification settings - Fork 243
/
PKG-INFO
157 lines (124 loc) · 5.15 KB
/
PKG-INFO
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
Metadata-Version: 2.1
Name: neural-compressor-ext-lab
Version: 0.1.0
Summary: jupyterlab extension
Home-page: https://github.com/intel-sandbox/neural-coder/tree/master/neural_coder/extensions/JupyterLab
Author: NeuralCoder
Author-email: xin.long@intel.com
License: BSD-3-Clause
Keywords: Jupyter,JupyterLab,JupyterLab3
Platform: Linux
Platform: Mac OS X
Platform: Windows
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 3
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
# Neural-Compressor-EXT-LAB
## Requirements
- JupyterLab >= 3.0
## Install
Before install, you should install the NeuralCoder, please refer to https://github.com/intel-sandbox/neural-coder/blob/master/neural_coder/README.md
### Python Backend
To install the Python source code, execute:
```bash
pip install -e.
```
Note: After the extension is published to the PyPI or conda-forge repositories, you can easily install the extension using pip or conda, such as:
```bash
pip install neural-compressor-ext-lab
```
### Javascript/Typescript Front-end
Install source extension from npm with:
```bash
jupyter labextension install --py neural-compressor-ext-lab
```
Note: After the extension is published to the NPM repositories, you can easily install the extension from jupyter lab extension market and don't need to execute the above command manually.
## Debugging
Check if the package has been added into the extension list:
```bash
jupyter labextension list
jupyter serverextension list
```
If the neural-compressor-ext-lab is not in ```serverextionsion``` list, try to enable the package to bacome a server extension:
```bash
jupyter serverextension enable --py neural-compressor-ext-lab
```
*debugging tip* :if the enable fails, try running:
```bash
jupyter lab --ServerAPP.jpserver_extension="{'neural-compressor-ext-lab':True}" --debug
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall neural-compressor-ext-lab
```
## Access jupyter lab remotely using SSH
Launch the jupyter lab service on the remote server:
```bash
jupyter lab --no-browser --port=8889
```
Start SSH in a local terminal:
```bash
ssh -N -f -L localhost:8888:localhost:8889 username@serverIP
```
## Contributing
### Development install
Note: You will need NodeJS to build the extension package.
The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# Clone the repo to your local environment
# Change directory to the Neural_Coder directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm build
```
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab
```
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
```bash
jupyter lab build --minimize=False
```
### Development uninstall
```bash
pip uninstall neural-compressor-ext-lab
```
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `Neural_Coder` within that folder.
### Testing the extension
#### Frontend tests
This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
To execute them, execute:
```sh
jlpm
jlpm test
```
#### Integration tests
This extension uses [Playwright](https://playwright.dev/docs/intro/) for the integration tests (aka user level tests).
More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
More information are provided within the [ui-tests](./ui-tests/README.md) README.
### Packaging the extension
See [RELEASE](RELEASE.md)