3.1 KiB
| stage | group | info | type |
|---|---|---|---|
| Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments | reference |
Jupyter Notebook files (FREE)
Jupyter Notebook (previously, IPython Notebook) files are used for interactive computing in many fields. They contain a complete record of the user's sessions and include:
- Code.
- Narrative text.
- Equations.
- Rich output.
When you add a Jupyter Notebook (with .ipynb extension) to your repository,
it's rendered into HTML when you view it:
Interactive features, including JavaScript plots, don't work when viewed in GitLab.
Cleaner diffs and raw diffs
- Introduced in GitLab 14.5 as an Alpha release with a flag named
jupyter_clean_diffs. Enabled by default.- Generally available in GitLab 14.9. Feature flag
jupyter_clean_diffsremoved.- Reintroduced toggle in GitLab 15.0 with a flag named
ipynb_semantic_diff. Enabled by default.- Selecting between raw and cleaner diffs introduced in GitLab 15.0 with a flag named
rendered_diffs_viewer. Enabled by default.
FLAG:
On self-managed GitLab, by default semantic diffs are available. To hide the feature, ask an administrator to disable the feature flag named ipynb_semantic_diff.
On GitLab.com, this feature is available.
FLAG:
On self-managed GitLab, by default the ability to switch between raw and rendered diffs is available. To hide the feature, ask an administrator to disable the feature flagnamed rendered_diffs_viewer. On GitLab.com, this feature is available.
When commits include changes to Jupyter Notebook files, GitLab:
- Transforms the machine-readable
.ipynbfile into a human-readable Markdown file. - Displays a cleaner version of the diff that includes syntax highlighting.
- Enables switching between raw and rendered diffs on the Commit and Compare pages. (Not available on merge request pages.)
Code suggestions are not available on diffs and merge requests for .ipynb files.
This feature is an Alpha release, and might lead to performance degradation. On self-managed GitLab, if unexpected issues arise, disable the feature.
Jupyter Git integration
Jupyter can be configured as an OAuth application with repository access, acting on behalf of the authenticated user. See the Runbooks documentation for an example configuration.