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

Not super clear from docs that %load_node can be used with ipython #3638

Closed
Tracked by #3631
merelcht opened this issue Feb 21, 2024 · 2 comments · Fixed by #3648
Closed
Tracked by #3631

Not super clear from docs that %load_node can be used with ipython #3638

merelcht opened this issue Feb 21, 2024 · 2 comments · Fixed by #3648
Assignees

Comments

@merelcht
Copy link
Member

Description

While testing the new %load_node feature and reading the docs, I found that it's not entirely clear that %load_node can also be used for IPython. Everywhere we mention the feature we talk about "in a notebook", see:

  1. In your notebook, run %load_node to load the contents of the problematic node with the %load_node line magic
  2. This is still an experimental feature and is currently only availble for Jupyter Notebook (>7.0) and Jupyter Lab.
  3. Debugging a Kedro project within a notebook for information on how to debug using the %load_node line magic and an interactive debugger.
  4. Currently this feature has better supports with Jupyter Notebook (>7.0) and Jupyter Lab and VSCode Notebook.
@lrcouto
Copy link
Contributor

lrcouto commented Feb 21, 2024

I had the same impression while trying to imagine running the debugger from a new user's perspective. I think the IPython feature is a little "hidden".

@noklam
Copy link
Contributor

noklam commented Feb 21, 2024

def magic_load_node(args: str) -> None:
"""The line magic %load_node <node_name>
Currently this feature has better supports with Jupyter Notebook (>7.0) and Jupyter Lab
and VSCode Notebook. This line magic will generate code in multiple cells to load
datasets from `DataCatalog`, import relevant functions and modules, node function
definition and a function call. If generating code is not possible, it will print
the code instead.
"""

Should update the docstring too

@merelcht merelcht moved this to To Do in Kedro Framework Feb 21, 2024
@merelcht merelcht mentioned this issue Feb 21, 2024
4 tasks
@merelcht merelcht self-assigned this Feb 22, 2024
@merelcht merelcht moved this from To Do to In Progress in Kedro Framework Feb 22, 2024
@merelcht merelcht linked a pull request Feb 22, 2024 that will close this issue
7 tasks
@merelcht merelcht moved this from In Progress to In Review in Kedro Framework Feb 22, 2024
@github-project-automation github-project-automation bot moved this from In Review to Done in Kedro Framework Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants