Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a separate line for jupyter server extension enable in README #1000

Merged
merged 1 commit into from
Oct 14, 2021

Conversation

StanczakDominik
Copy link
Contributor

@StanczakDominik StanczakDominik commented Oct 14, 2021

This proposed change tries to clean up a bit of confusion about the server extension workflow.

I was running into an issue like #561 . However, I wanted to keep my Jupyter install as a system package on Arch (obligatory "arch, btw!") rather than switching to conda. Thus, the addition of --sys-prefix to jupyter serverextension enable was not an option for me. I thus tried jupyter serverextension enable voila, but to no avail.

There's no Arch/AUR package for Voila just yet (I might make one later), so I'm using Voila via pip install --user.

However, I found out in https://github.com/voila-dashboards/voila/blob/88d55eaa418f497cc338a4a0602c961449b76de4/.binder/postBuild that jupyter serverextension and jupyter server extension are two different concepts (no idea why, honestly). I tried running jupyter server extension enable --user voila, and, well... voila! It works now.

So I'd like to propose this change as a "hey, this is confusing in the documentation; perhaps let's change it up in places!" idea.

References

Addresses similar problems to #561

Code changes, User-facing changes, Backwards-incompatible changes

None whatsoever; just a README change. I'd be happy to also improve the docs once I get better understanding of why this is necessary.

This proposed change tries to clean up a bit of confusion about the server extension workflow.

I was running into an issue like voila-dashboards#561 . However, I wanted to keep my Jupyter install as a system package on Arch (obligatory "arch, btw!") rather than switching to conda. Thus, the addition of `--sys-prefix` to `jupyter serverextension enable` was not an option for me.

There's no Arch/AUR package for Voila just yet (I might make one later), so I'm using Voila via `pip install --user`.

However, I found out in https://github.com/voila-dashboards/voila/blob/88d55eaa418f497cc338a4a0602c961449b76de4/.binder/postBuild that `jupyter serverextension` and `jupyter server extension` are two different concepts. I tried running `jupyter server extension enable --user voila`, and, well... voila! It works now.

So I'd like to propose this change as a "hey, this is confusing in the documentation; perhaps let's change it up in places!" idea.
@github-actions
Copy link
Contributor

Binder 👈 Try it on binder (branch StanczakDominik/voila/patch-1)

@github-actions
Copy link
Contributor

Benchmark report

The execution time (in milliseconds) are grouped by test file, test type and browser.
For each case, the following values are computed: min <- [1st quartile - median - 3rd quartile] -> max.

Results table
Test file basics.ipynb bqplot.ipynb dashboard.ipynb gridspecLayout.ipynb interactive.ipynb ipympl.ipynb ipyvolume.ipynb multiple_widgets.ipynb query-strings.ipynb
Render
chromium
actual 2907 <- [2941 - 3096 - 3334] -> 3899 2426 <- [2473 - 2518 - 2534] -> 2637 2747 <- [2902 - 2920 - 2961] -> 3019 2941 <- [3138 - 3166 - 3175] -> 3209 1809 <- [1883 - 1905 - 1916] -> 1935 3366 <- [3473 - 3606 - 4006] -> 4906 9116 <- [11362 - 12380 - 13523] -> 13665 9972 <- [10177 - 10183 - 10278] -> 10458 1490 <- [1494 - 1543 - 1549] -> 1804
expected 3379 <- [3442 - 3517 - 3701] -> 3876 2976 <- [3227 - 3321 - 3421] -> 3604 3608 <- [3623 - 3709 - 3793] -> 3825 4453 <- [4453 - 4523 - 4661] -> 4748 2559 <- [2655 - 2656 - 2660] -> 2674 3982 <- [4079 - 4213 - 4356] -> 4743 12183 <- [18509 - 19553 - 20811] -> 21515 15319 <- [15660 - 15796 - 15912] -> 16056 1517 <- [1920 - 1997 - 2103] -> 2113

❗ Test metadata have changed
--- /dev/fd/63	2021-10-14 07:58:53.568979430 +0000
+++ /dev/fd/62	2021-10-14 07:58:53.568979430 +0000
@@ -8,27 +8,27 @@
   },
   "systemInformation": {
     "cpu": {
-      "brand": "Xeon® Platinum 8272CL",
+      "brand": "Xeon® E5-2673 v3",
       "cache": {
         "l1d": 65536,
         "l1i": 65536,
-        "l2": 2097152,
-        "l3": 36700160
+        "l2": 524288,
+        "l3": 31457280
       },
       "cores": 2,
       "family": "6",
-      "flags": "fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush mmx fxsr sse sse2 ss ht syscall nx pdpe1gb rdtscp lm constant_tsc rep_good nopl xtopology cpuid pni pclmulqdq ssse3 fma cx16 pcid sse4_1 sse4_2 movbe popcnt aes xsave avx f16c rdrand hypervisor lahf_lm abm 3dnowprefetch invpcid_single pti fsgsbase bmi1 hle avx2 smep bmi2 erms invpcid rtm mpx avx512f avx512dq rdseed adx smap clflushopt avx512cd avx512bw avx512vl xsaveopt xsavec xsaves md_clear",
+      "flags": "fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush mmx fxsr sse sse2 ss ht syscall nx pdpe1gb rdtscp lm constant_tsc rep_good nopl xtopology cpuid pni pclmulqdq ssse3 fma cx16 pcid sse4_1 sse4_2 movbe popcnt aes xsave avx f16c rdrand hypervisor lahf_lm abm invpcid_single pti fsgsbase bmi1 avx2 smep bmi2 erms invpcid xsaveopt md_clear",
       "governor": "",
       "manufacturer": "Intel®",
-      "model": "85",
+      "model": "63",
       "physicalCores": 2,
       "processors": 1,
       "revision": "",
       "socket": "",
-      "speed": 2.6,
+      "speed": 2.4,
       "speedMax": null,
       "speedMin": null,
-      "stepping": "7",
+      "stepping": "2",
       "vendor": "GenuineIntel",
       "virtualization": false,
       "voltage": ""
@@ -42,11 +42,11 @@
       "codename": "Focal Fossa",
       "codepage": "UTF-8",
       "distro": "Ubuntu",
-      "kernel": "5.8.0-1042-azure",
+      "kernel": "5.8.0-1040-azure",
       "logofile": "ubuntu",
       "platform": "linux",
       "release": "20.04.3 LTS",
-      "serial": "6c19bc2f6263432da3d31804b6f46a17",
+      "serial": "cfc067bfcb844f35865e279a1b0e66c5",
       "servicepack": "",
       "uefi": false
     }

@jtpio
Copy link
Member

jtpio commented Oct 14, 2021

Thanks @StanczakDominik!

However, I found out in https://github.com/voila-dashboards/voila/blob/88d55eaa418f497cc338a4a0602c961449b76de4/.binder/postBuild that jupyter serverextension and jupyter server extension are two different concepts (no idea why, honestly). I tried running jupyter server extension enable --user voila, and, well... voila! It works now.

jupyter serverextension is for the classic notebook server which is currently used on Binder when starting the servers. And jupyter server extension is for Jupyter Server. Jupyter Server originated from the classic notebook server and should now be the preferred option.

@jtpio jtpio added this to the 0.3.0 milestone Oct 14, 2021
Copy link
Member

@jtpio jtpio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@jtpio jtpio merged commit 3d83258 into voila-dashboards:main Oct 14, 2021
Comment on lines +77 to +78
jupyter serverextension enable voila
jupyter server extension enable voila
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we want to be more specific, we could even add comments such as:

Suggested change
jupyter serverextension enable voila
jupyter server extension enable voila
# if you are using the classic notebook server
jupyter serverextension enable voila
# if you are using Jupyter Server
jupyter server extension enable voila

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants