debian-mirror-gitlab/doc/user/project/repository/jupyter_notebooks/index.md

49 lines
1.8 KiB
Markdown
Raw Normal View History

2020-10-24 23:57:45 +05:30
---
stage: Create
group: Source Code
2021-02-22 17:27:13 +05:30
info: "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"
2020-10-24 23:57:45 +05:30
type: reference
---
2021-12-11 22:18:48 +05:30
# Jupyter Notebook files **(FREE)**
2020-03-13 15:44:24 +05:30
2021-12-11 22:18:48 +05:30
[Jupyter Notebook](https://jupyter.org/) (previously, IPython Notebook) files are used for
interactive computing in many fields. They contain a complete record of the
user's sessions and include:
2020-03-13 15:44:24 +05:30
2021-12-11 22:18:48 +05:30
- Code.
- Narrative text.
- Equations.
- Rich output.
2020-03-13 15:44:24 +05:30
2021-12-11 22:18:48 +05:30
When you add a Jupyter Notebook (with `.ipynb` extension) to your repository,
it's rendered into HTML when you view it:
2020-03-13 15:44:24 +05:30
![Jupyter Notebook Rich Output](img/jupyter_notebook.png)
2021-04-17 20:07:23 +05:30
Interactive features, including JavaScript plots, don't work when viewed in
2020-03-13 15:44:24 +05:30
GitLab.
2021-12-11 22:18:48 +05:30
## Cleaner diffs
2022-03-02 08:16:31 +05:30
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/6589) in GitLab 14.5 [with a flag](../../../../administration/feature_flags.md) named `jupyter_clean_diffs`. Enabled by default.
2021-12-11 22:18:48 +05:30
FLAG:
2022-03-02 08:16:31 +05:30
On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to [disable the feature flag](../../../../administration/feature_flags.md) named `jupyter_clean_diffs`.
2021-12-11 22:18:48 +05:30
On GitLab.com, this feature is available.
When commits include changes to Jupyter Notebook files, GitLab:
- Transforms the machine-readable `.ipynb` file into a human-readable Markdown file.
- Displays a cleaner version of the diff that includes syntax highlighting.
Code suggestions are not available on diffs and merge requests for `.ipynb` files.
![Jupyter Notebook Clean Diff](img/jupyter_notebook_diff_v14_5.png)
2020-03-13 15:44:24 +05:30
## Jupyter Git integration
2021-09-04 01:27:46 +05:30
Jupyter can be configured as an OAuth application with repository access, acting
on behalf of the authenticated user. See the
[Runbooks documentation](../../../project/clusters/runbooks/index.md) for an
example configuration.