“Error displaying widget: model not found” with Jupyter lab #112

MrAnimaniac · 2019-07-02T22:34:03Z

I followed your installation instructions on a fresh python and jupyter setup with pip but end up with “Error displaying widget: model not found” even if I try to run the provided examples under Jupyter lab.
Nevertheless, the examples run just fine with Jupyter notebook, although I didn’t separately install anything. Is this a known issue?

SylvainCorlay · 2019-07-02T23:13:37Z

JupyterLab 1.0 has been released last friday and ipympl does not support it quite yet (although the master branch does). It will be updated in the next day or so.

russkel · 2019-07-03T05:35:45Z

I thought I was going mad. What poor timing!

Pip installing the master branch of ipympl didn't work for me. Still getting the same error.

martinRenou · 2019-07-03T07:20:08Z

What is the error you are seeing?

thomasaarholt · 2019-07-03T07:59:10Z

Same issue here. I've been trying over the past week (as I've been following @martinRenou's updates) but reckoned that it was a WIP bug and that I should wait until it was mostly complete to try.

I installed ipympl on python 3.7.1, latest conda nodejs 11.14.0 and npm 6.7.0, with the following commands:

git clone repo
pip install .
jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension install jupyter-matplotlib

I then test it with

%matplotlib widget
import matplotlib.pyplot as plt
plt.figure()
plt.plot([1,2,3])

I'm happy to debug more.

Edit:
I've also tried calling the
jupyter nbextension install --py --symlink --sys-prefix ipympl and jupyter nbextension enable --py --sys-prefix ipympl commands just to be sure.

I decided not to follow through with the full readme.md developer install instructions, since I don't want to develop it, just test the most recent version. If this is where I have gone wrong, it would be great if someone could clarify why the above doesn't work :)

thomasaarholt · 2019-07-03T08:23:47Z

I would try in a fresh conda environment, but I have terrible internet until tomorrow.

martinRenou · 2019-07-03T08:30:23Z

If you are installing a dev version, instead of

jupyter labextension install jupyter-matplotlib

(I suggest you uninstall it with jupyter labextension uninstall jupyter-matplotlib)

you should try from the jupyter-matplotlib directory:

jupyter labextension install js

thomasaarholt · 2019-07-03T09:00:26Z

$ jupyter labextension install js
An error occured.
ValueError: "/home/thomasaar/documents/jupyter-matplotlib/js" is not a valid npm package
See the log file for details:  /tmp/jupyterlab-debug-q6xjcr43.log

thomasaarholt · 2019-07-03T09:02:55Z

Here is the log:
Uploading jupyterlab-debug-q6xjcr43.log…

thomasaarholt · 2019-07-03T09:04:36Z

(I am going to be a bit on and off wifi today, catching a ferry in a few hours and then a plane during the night)

martinRenou · 2019-07-03T09:09:53Z

Are you sure you are in the right directory? Is there a js directory in the current location? What does ls say?

thomasaarholt · 2019-07-03T09:50:45Z

Yes, definitely right directory:

$ ls
environment.yml  ipympl           js                       LICENSE      matplotlib.gif  RELEASE.md  setup.py
examples         ipympl.egg-info  jupyter-matplotlib.json  MANIFEST.in  README.md       setup.cfg

thomasaarholt · 2019-07-03T09:55:38Z

I'm gonna suggest that we wait with debugging my case until I can make a fresh conda environment. Meanwhile, maybe @MrAnimaniac or @russkel have tried as well?

thomasaarholt · 2019-07-03T09:56:41Z

@martinRenou is there a specific npm/nodejs version requirement? #57 suggests there was, but i suspect that is old news?

martinRenou · 2019-07-03T10:02:03Z

Not that I know of, I have nodejs 11.14.0 installed with conda, and it seems to work just fine

t1nux · 2019-07-03T12:24:15Z

I am facing the same error as well. In order to reproduce the error, I'm simply using docker where I am installing everything via pip. Maybe this will help reproduce the error (and help fix it).

Dockerfile

FROM python:3.7
WORKDIR /jup
COPY . /jup
RUN apt-get update \
	&& curl -sL https://deb.nodesource.com/setup_12.x | bash - \
	&& apt-get install -y nodejs \
	&& pip install --trusted-host pypi.python.org -r python_requirements.txt \
	&& jupyter labextension install @jupyter-widgets/jupyterlab-manager \
	&& jupyter labextension install jupyter-matplotlib \
	&& jupyter labextension install jupyterlab_bokeh
EXPOSE 8888
ENTRYPOINT ["jupyter", "lab","--ip=0.0.0.0","--allow-root"]

python_requirements.txt

numpy
scipy
pandas
sympy
jupyterlab
matplotlib
bokeh
ipympl

I am building the docker image with: docker build -t img/jupyterlab:test01 .
And I am running it with: docker run -p 8888:8888 img/jupyterlab:test01

The code to test is:

%matplotlib widget
import matplotlib.pyplot as plt
plt.plot([0, 1, 2])

which results in: Error displaying widget: model not found

martinRenou · 2019-07-03T12:28:31Z

If you are using jupyterlab 1.0 it cannot work, it should work on master though. Please wait for a release of jupyter-matplotlib before using jupyterlab 1.0

thomasaarholt · 2019-07-03T12:52:56Z

:D

I misinterpreted @SylvainCorley's comment above as the master of ipympl should work with jupyterlab 1.0, rather than the opposite.

That makes sense, and probably explains the error. Does it work with the most recent non 1.0 of jupyterlab?

martinRenou · 2019-07-03T12:59:16Z

I misinterpreted @SylvainCorley's comment above as the master of ipympl should work with jupyterlab 1.0, rather than the opposite.

You did not misinterpret Sylvain's answer. The master of ipympl works with jupyterlab 1.0.

But if you use the last released version of ipympl with JupyterLab 1.0, it does not work. We need to release ipympl first.

russkel · 2019-07-04T01:08:13Z

I am running in a pipenv on 3.7.3, I uninstalled the labextension, pip uninstalled ipympl then
pip install git+https://github.com/matplotlib/jupyter-matplotlib.git#egg=ipympl and then rebuilt extensions. Running the code as per @t1nux 's post returns the same error, and in the terminal I get this:

[IPKernelApp] WARNING | No such comm: d87b30d7f6b54fcc88683fa792c98baf
[IPKernelApp] WARNING | No such comm: 6ab177c9e2c34633965a94a9b100f4a2

ivartz · 2019-07-04T17:16:19Z

I got all examples in https://github.com/matplotlib/jupyter-matplotlib/blob/master/examples/ipympl.ipynb working after running:

jupyter labextension uninstall jupyter-matplotlib && jupyter labextension uninstall @jupyter-widgets/jupyterlab-manager && conda update -y widgetsnbextension && conda update -y nodejs && pip uninstall -y ipympl && pip install git+https://github.com/matplotlib/jupyter-matplotlib.git#egg=ipympl && conda update jupyterlab -y && jupyter labextension install @jupyter-widgets/jupyterlab-manager && jupyter labextension install jupyter-matplotlib && jupyter labextension update --all && jupyter lab build && jupyter nbextension list && jupyter labextension list

From what I understand, the important combination is the master ipympl from github (0.3.1) + latest jupyterlab conda install (1.0.1). Also made sure other important packages were updated, and finally all jupyterlab extension updated and rebuilt. At last a verification that all jupyter nbextensions and labextensions were ok.

SylvainCorlay · 2019-07-04T17:25:02Z

We just release 0.3.1 with support for jupyterlab 1.0.

StanczakDominik · 2019-07-04T19:45:11Z

I'd just like to, one, confirm that 0.3.1 fixes the issue, and two, thank everyone involved for solving this :)

russkel · 2019-07-05T00:12:23Z

Working a treat now. I think the issue was even with the master ipympl, jupyter-matplotlib v0.3.0 was being installed into jupyter directory. Maybe something to check out?

SylvainCorlay · 2019-07-05T08:41:58Z

Thanks. Closing.

gabegrand · 2019-07-08T15:39:32Z

I was getting the same error. Followed the steps from @ivartz above and can confirm that widgets display properly now. Thanks everyone!

westurner · 2019-07-09T03:29:49Z

@SylvainCorlay What were the changes necessary to support JupyterLab 1.0?
Are there JupyterLab docs on what needs to be upgraded?

(edit)

https://jupyterlab.readthedocs.io/en/stable/getting_started/changelog.html#extension-development-changes

davzaman · 2019-09-06T00:58:55Z

For background I had done the following:

conda install -c conda-forge ipympl
conda install nodejs
jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension install jupyter-matplotlib
jupyter labextension install ipyvolume

And got issues, so I ran: conda update jupyterlab && jupyter labextension update --all and it fixed.

jbulow · 2019-11-12T08:43:22Z

This is still an issue with jupyter lab 1.2.2 and current jupter-matplotlib

martinRenou · 2019-11-12T08:47:23Z

@jbulow it's not, you must have missed a step in the installation. Please check that you correctly followed the installation steps. Did you correctly install the JupyterLab extensions?

jupyter labextension install @jupyter-widgets/jupyterlab-manager jupyter-matplotlib

RGD2 · 2019-11-29T05:16:00Z

I am having the same issue. Also:

root@vagrant:~# jupyter labextension install @jupyter-widgets/jupyterlab-manager jupyter-matplotlib
Building jupyterlab assets (build:prod:minimize)
An error occured.
RuntimeError: JupyterLab failed to build
See the log file for details:  /tmp/jupyterlab-debug-57792pd3.log
root@vagrant:~# jupyter labextension list
JupyterLab v1.2.1
Known labextensions:
   app dir: /usr/local/share/jupyter/lab
        @jupyter-widgets/jupyterlab-manager v1.1.0  enabled  OK
        @jupyterlab/git v0.8.2  enabled  OK
        @jupyterlab/toc v1.0.1  enabled  OK
        @krassowski/jupyterlab_go_to_definition v0.7.1  enabled  OK
        @lckr/jupyterlab_variableinspector v0.3.0  enabled  OK
        @ryantam626/jupyterlab_sublime v0.2.0  enabled  OK
        jupyter-matplotlib v0.4.2  enabled  OK
        jupyterlab-drawio v0.6.0  enabled  OK
        nbdime-jupyterlab v1.0.0  enabled  OK
root@vagrant:~# pip show ipywidgets
Name: ipywidgets
Version: 7.5.1
Summary: IPython HTML widgets for Jupyter
Home-page: http://ipython.org
Author: IPython Development Team
Author-email: ipython-dev@scipy.org
License: BSD
Location: /usr/local/lib/python3.7/dist-packages
Requires: ipykernel, traitlets, ipython, widgetsnbextension, nbformat
Required-by: ipympl

Funny thing was, I had this working... until I added a different extension (which triggered a rebuild). After which, it broke. This is running in a VM with 1GB ram. I will try upping the memory and see if that fixes the problem. (might be the minimize part of the build running out of ram - I do see swapfile use).
That logfile ended in:

> node /usr/local/lib/python3.7/dist-packages/jupyterlab/staging/yarn.js run build:prod:minimize
yarn run v1.15.2
$ ensure-max-old-space webpack --config webpack.prod.minimize.config.js
child_process.js:642
    throw err;
    ^

Error: Command failed: webpack --config webpack.prod.minimize.config.js
    at checkExecSyncError (child_process.js:621:11)
    at Object.execFileSync (child_process.js:639:15)
    at Object.<anonymous> (/usr/local/share/jupyter/lab/staging/node_modules/@jupyterlab/buildutils/lib/ensure-max-old-space.js:30:17)
    at Module._compile (internal/modules/cjs/loader.js:956:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:973:10)
    at Module.load (internal/modules/cjs/loader.js:812:32)
    at Function.Module._load (internal/modules/cjs/loader.js:724:14)
    at Function.Module.runMain (internal/modules/cjs/loader.js:1025:10)
    at internal/main/run_main_module.js:17:11 {
  status: null,
  signal: 'SIGKILL',
  output: [ null, null, null ],
  pid: 1320,
  stdout: null,
  stderr: null
}
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

JupyterLab failed to build
Traceback (most recent call last):

  File "/usr/local/lib/python3.7/dist-packages/jupyterlab/debuglog.py", line 47, in debug_logging
    yield

  File "/usr/local/lib/python3.7/dist-packages/jupyterlab/labextensions.py", line 105, in start
    command=command, app_options=app_options)

  File "/usr/local/lib/python3.7/dist-packages/jupyterlab/commands.py", line 459, in build
    command=command, clean_staging=clean_staging)

  File "/usr/local/lib/python3.7/dist-packages/jupyterlab/commands.py", line 669, in build
    raise RuntimeError(msg)

RuntimeError: JupyterLab failed to build

Exiting application: jupyter

It seems like the gui-managed rebuild process sometimes silently fails this way during the rebuild of jupyter-matplotlib, leaving the widget javascript missing.

I'll see if throwing more memory at it helps (was using the default vagrant config which was only 1GB). BTW I am bulding within a singularity image, on a vagrant managed virtualbox VM on windows.
The exact fork is at https://github.com/RGD2/jupyter/tree/pipjupyterlab which works, (with working matplot lib) but with wierd steps which involve repeated builds and refreshs (see the commit message for those steps).

RGD2 · 2019-11-29T05:30:58Z

4GB ram seems to fix my problem with jupyter labextension install @jupyter-widgets/jupyterlab-manager jupyter-matplotlib failing, but I still have the error in the title of this issue.
(good to know if you're trying to install this on a raspi or other linux SBC -- probably will need the 4GB ram model).

minostauros · 2020-05-18T09:08:20Z

Since I avoid using Conda, I tried following:

In my case, just worked with

jupyter labextension update --all 
jupyter lab build 
jupyter nbextension list
jupyter labextension list

which comes after installation process of

pip install jupyterlab
pip install ipympl
curl -sL https://deb.nodesource.com/setup_12.x | bash -
apt install nodejs
jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension install jupyter-matplotlib

belletbg · 2020-10-06T12:48:19Z

I followed your installation instructions on a fresh python and jupyter setup with pip but end up with “Error displaying widget: model not found” even if I try to run the provided examples under Jupyter lab.
Nevertheless, the examples run just fine with Jupyter notebook, although I didn’t separately install anything. Is this a known issue?

yes, runs fine in notebook

ray-ronnaret · 2021-02-28T09:25:47Z

Today I still have the same problem after update to Jupyter lab 3. I would appreciate for the suggestions.

martinRenou · 2021-03-02T07:18:53Z

Please open another issue with your specific problem and show us the output of the requested commands when opening an issue.

shnaqvi · 2021-03-13T20:31:13Z

@ray-ronnaret , I ran into the same issue and I'm in the same boat as @minostauros, who prefers brew over conda to manage packages on my macOS Big Sur. @minostauros's super-helpful advice worked for me! And listed below are the 2 changes I made:

One major change for JupyterLab 3.0 was to install the jupyter-widgets/jupyterlab-manager using pip instead of jupyter labextension install by following the instructions here:
- https://github.com/jupyter-widgets/ipywidgets/tree/master/jupyterlab_widgets
- https://ipywidgets.readthedocs.io/en/latest/user_install.html#installing-in-jupyterlab-3-0

pip install ipywidgets --upgrade

Another change for me was to use brew to install nodejs:

brew install node

Finally, ensured that all extensions are enabled, OK and compatible by running:

jupyter labextension update --all 
jupyter labextension list

In Summary, here's the full trail of commands:

pip install jupyterlab --upgrade
pip install ipympl --upgrade

brew install node
pip install ipywidgets --upgrade

jupyter labextension install jupyter-matplotlib

jupyter labextension update --all 
jupyter lab build 
jupyter labextension list

As a bonus, I also enabled using plotly with:

jupyter labextension install jupyterlab-plotly

Note:

Uninstall any extensions listed as incompatible by jupyter labextension list, by calling jupyter labextension uninstall <extension-name>. In my case @jupyter-widgets/jupyterlab-managerandjs` were being shown as incompatible.
Check that you indeed have JupyterLab 3.0 installed using pip show jupyterlab

ianhi · 2021-03-13T20:48:25Z

@shnaqvi You should not need to to labextension install anymore. In fact I'd advise against doing that jupyter-matplotlib instead let the pip install handle everything. For an ipympl only installation (in a fresh virtual environment) the only step that should be necessary is:

pip install --upgrade jupyterlab ipympl

gwerbin-tive · 2022-08-01T12:47:08Z

@shnaqvi You should not need to to labextension install anymore. In fact I'd advise against doing that jupyter-matplotlib instead let the pip install handle everything. For an ipympl only installation (in a fresh virtual environment) the only step that should be necessary is:
pip install --upgrade jupyterlab ipympl

What if I need to run Jupyterlab from a different environment than my IPython kernel? Or is that not a supported use case?

fmgonsalves · 2022-09-01T14:36:59Z

I've got the same question. I have JupyterLab installed on a common/"master" environment. I have various environments created according to the application needs and each one having its own ipykernel. I have even installed ipympl in each environment - not sure if this is necessary.

When I run JupyterLab from the master environment, create a new notebook using one of the other environments and try to plot a figure, I have the same error as the OP.

thomasaarholt · 2022-09-01T15:29:30Z

Please create a new issue on this topic, even though you get the same error :) There are 20 people getting pinged with each new comment here, and many of them do not use jupyterlab via nb_kernels.

SylvainCorlay closed this as completed Jul 5, 2019

westurner mentioned this issue Jul 9, 2019

BUG,BLD: JupyterLab 1.0 bernhard-42/jupyter-cadquery#2

Closed

jeffneuen mentioned this issue Dec 1, 2019

Widget loads, returns Error displaying widget: model not found #154

Open

wmwv mentioned this issue Feb 4, 2020

[NERSC] Test and Deploy a JupyterHub kernel that reliably can use ipympl + afwdisplay LSSTDESC/desc-help#2

Closed

9 tasks

JackKelly mentioned this issue Apr 7, 2020

[Bug][Jupyter Widget] Error displaying widget: model not found keplergl/kepler.gl#1064

Closed

gwerbin mentioned this issue Sep 1, 2022

Docs request (feature request?): Using ipympl when Jupyter and kernel are in different environments #486

Open

matplotlib locked as resolved and limited conversation to collaborators Sep 2, 2022

“Error displaying widget: model not found” with Jupyter lab #112

“Error displaying widget: model not found” with Jupyter lab #112

Comments

MrAnimaniac commented Jul 2, 2019

SylvainCorlay commented Jul 2, 2019

russkel commented Jul 3, 2019 • edited Loading

martinRenou commented Jul 3, 2019

thomasaarholt commented Jul 3, 2019 • edited Loading

thomasaarholt commented Jul 3, 2019

martinRenou commented Jul 3, 2019 • edited Loading

thomasaarholt commented Jul 3, 2019

thomasaarholt commented Jul 3, 2019

thomasaarholt commented Jul 3, 2019

martinRenou commented Jul 3, 2019

thomasaarholt commented Jul 3, 2019

thomasaarholt commented Jul 3, 2019

thomasaarholt commented Jul 3, 2019

martinRenou commented Jul 3, 2019

t1nux commented Jul 3, 2019

martinRenou commented Jul 3, 2019

thomasaarholt commented Jul 3, 2019

martinRenou commented Jul 3, 2019

russkel commented Jul 4, 2019

ivartz commented Jul 4, 2019

SylvainCorlay commented Jul 4, 2019

StanczakDominik commented Jul 4, 2019

russkel commented Jul 5, 2019

SylvainCorlay commented Jul 5, 2019

gabegrand commented Jul 8, 2019

westurner commented Jul 9, 2019 • edited Loading

davzaman commented Sep 6, 2019

jbulow commented Nov 12, 2019

martinRenou commented Nov 12, 2019

RGD2 commented Nov 29, 2019

RGD2 commented Nov 29, 2019

minostauros commented May 18, 2020

belletbg commented Oct 6, 2020

ray-ronnaret commented Feb 28, 2021

martinRenou commented Mar 2, 2021

shnaqvi commented Mar 13, 2021 • edited Loading

ianhi commented Mar 13, 2021

gwerbin-tive commented Aug 1, 2022

fmgonsalves commented Sep 1, 2022

thomasaarholt commented Sep 1, 2022

russkel commented Jul 3, 2019 •

edited

Loading

thomasaarholt commented Jul 3, 2019 •

edited

Loading

martinRenou commented Jul 3, 2019 •

edited

Loading

westurner commented Jul 9, 2019 •

edited

Loading

shnaqvi commented Mar 13, 2021 •

edited

Loading