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 warning not to use Jupyter Lab when contributing to the notebooks. #1632

Closed
wants to merge 1 commit into from

Conversation

odysseus0
Copy link

Changes made in Jupyter Lab will break the current build workflow even after running tools/run-after-git-clone. Please refer to the change in the docs' markdown file and another pull request for more detail.

@stas00
Copy link

stas00 commented Feb 13, 2019

Thank you for this suggestion, @odysseus0. We already have a dedicated section for it, so I amended it with the warning: ae72105
The many ways it breaks do not matter, there is no point listing them all, since none of them works.

I haven't experimented with jupyterlab, but most likely it generates a different json file, that is still compliant with nbformat, but is different from the one generated by jupyter notebook. Our fastai-nbstripout is written to bypass nbformat and to manipulate json format directly, which made it
about 10-15 times faster than nbstripout which follows the rules and was too slow for our needs. So chances are that someone needs to look at the format generated by jupyterlab and adjust fastai-nbstripout to support that variation, and then most likely it should just work. If you'd like to have a look, fastai-nbstripout is a simple script that just traverses and manipulates the json file.

@stas00 stas00 closed this Feb 13, 2019
@odysseus0 odysseus0 deleted the note-doc branch February 14, 2019 02:42
@Gokkulnath
Copy link
Contributor

Gokkulnath commented Mar 5, 2019

@odysseus0 Can you please share more details on what problem you faced when running fastai-nbstripout script on jupyterlab notebooks ?
I am currently working on making fastai-nbstripout compatible with jupyter lab notebook as well. Can you provide a sample notebook where you had faced the issue.
P.S : I Tried running the tool on lesson notebook and i dont see any difference in the resulting files. I have to check the Doc Notebooks now..

@odysseus0
Copy link
Author

@Gokkulnath Ah, I believe that it is pretty general. Cannot recall exactly how it happened.

Here is my tip on how to recreate it:

  • Clone two copies of your forked repositories.
  • In cloned repo No. 1, make a change in a cell you choose in Jupyter Lab that will lead to output change. Commit and push it.
  • In cloned repo No. 2, make a different change in the same cell you choose in Jupyter Notebook that will lead to a different output change. Commit.
  • Now when you check git status in repo No. 2, you should be able to see something like that it has diverged from the remote.
  • Then try to pull from remote and see what happens. What happened to me is that everything breaks apart.

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

Successfully merging this pull request may close these issues.

3 participants