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

Reorder the load_node docs to make requirement clear. #4065

Merged
merged 4 commits into from
Aug 16, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/source/notebooks_and_ipython/kedro_and_notebooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,13 @@ For more details, run `%reload_kedro?`.
``` {note}
This is still an experimental feature and is currently only available for Jupyter Notebook (>7.0), Jupyter Lab, IPython, and VS Code Notebook. If you encounter unexpected behaviour or would like to suggest feature enhancements, add it under [this github issue](https://github.com/kedro-org/kedro/issues/3580).
```

When using this feature in Jupyter Notebook you will need to have the following requirements and minimum versions installed:
```yaml
ipylab>=1.0.0
notebook>=7.0.0
```

You can load the contents of a node in your project into a series of cells using the `%load_node` line magic. To use `%load_node`, the node you want to load needs to fulfil two requirements:
- The node needs to have a name
- The node's inputs need to be persisted
Expand Down Expand Up @@ -309,11 +316,6 @@ To be able to access your node's inputs, make sure they are explicitly defined i

You can then run the generated cells to recreate how the node would run in your pipeline. You can use this to explore your node's inputs, behaviour, and outputs in isolation, or for [debugging](#debugging-a-kedro-project-within-a-notebook).

When using this feature in Jupyter Notebook you will need to have the following requirements and minimum versions installed:
```yaml
ipylab>=1.0.0
notebook>=7.0.0
```

### `%run_viz` line magic

Expand Down