Improve error message when executing `kedro run` without pipeline #3794

davidmosca · 2024-04-09T14:26:20Z

Description

After having installed Kedro as per the instructions (https://docs.kedro.org/en/stable/get_started/new_project.html#run-the-new-project), I get an error message when I execute kedro run.

Context

This bug prevents me from completing the installation of Kedro.

Steps to Reproduce

activate the kedro environment: conda activate myenv
execute kedro: kedro run

Expected Result

The execution should complete without errors.

Actual Result

The run fails and the the stack trace shows an error message.

(myenv) C:\Users\user1\Documents\GitHub\myproject>kedro run
[04/09/24 15:02:13] INFO     Kedro project myproject                                                      session.py:321Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "C:\Users\user1\AppData\Local\anaconda3\envs\myenv\Scripts\kedro.exe\__main__.py", line 7, in <module>
  File "C:\Users\user1\AppData\Local\anaconda3\envs\myenv\Lib\site-packages\kedro\framework\cli\cli.py", line 198, in main
    cli_collection()
  File "C:\Users\user1\AppData\Local\anaconda3\envs\myenv\Lib\site-packages\click\core.py", line 1157, 
in __call__
    return self.main(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\user1\AppData\Local\anaconda3\envs\myenv\Lib\site-packages\kedro\framework\cli\cli.py", line 127, in main
    super().main(
  File "C:\Users\user1\AppData\Local\anaconda3\envs\myenv\Lib\site-packages\click\core.py", line 1078, 
in main
    rv = self.invoke(ctx)
         ^^^^^^^^^^^^^^^^
  File "C:\Users\user1\AppData\Local\anaconda3\envs\myenv\Lib\site-packages\click\core.py", line 1688, 
in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\user1\AppData\Local\anaconda3\envs\myenv\Lib\site-packages\click\core.py", line 1434, 
in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\user1\AppData\Local\anaconda3\envs\myenv\Lib\site-packages\click\core.py", line 783, in invoke
    return __callback(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\user1\AppData\Local\anaconda3\envs\myenv\Lib\site-packages\kedro\framework\cli\project.py", line 225, in run
    session.run(
  File "C:\Users\user1\AppData\Local\anaconda3\envs\myenv\Lib\site-packages\kedro\framework\session\session.py", line 346, in run
    filtered_pipeline = pipeline.filter(
                        ^^^^^^^^^^^^^^^^
  File "C:\Users\user1\AppData\Local\anaconda3\envs\myenv\Lib\site-packages\kedro\pipeline\pipeline.py", line 768, in filter
    raise ValueError(
ValueError: Pipeline contains no nodes after applying all provided filters

Your Environment

IDE: VSCode
Kedro version used (pip show kedro or kedro -V): 0.19.3
Python version used (python -V): 3.11.8
Operating system and version: Windows 10.0.19045

The text was updated successfully, but these errors were encountered:

noklam · 2024-04-09T14:49:29Z

You need to install the project dependencies to run a project. (which could be pandas, pyspark etc depending what you have selected).

The steps should be

kedro new
cd <project_name>
pip install -r . or pip install -e .
kedro run

If this solve the issue please close the ticket.

noklam · 2024-04-09T14:51:21Z

I see that the docs are confusing, you need to have a pipeline in order to run kedro run.

kedro new --name=testproject --tools=lint,docs,pyspark --example=n mean you are not selecting any example, thus you have no pipeline/nodes and the error, can you change it to --example=y instead?

davidmosca · 2024-04-09T19:55:15Z

I see. I don't have a pipeline, I was just following the installation instructions in sequence. The docs would benefit from clarifying that a pipeline is needed. Once I have built one, I will try again. In the meantime, you can close the ticket. Thanks.

astrojuanlu · 2024-04-09T21:42:15Z

Thanks for opening this issue @davidmosca and sorry you had a bumpy first experience.

I don't think this is only a docs issue: if there are no pipelines defined, kedro run should clearly say so:

> kedro run
No pipelines defined, use `kedro pipeline create` to create one
> echo $status
1

davidmosca · 2024-04-09T21:48:16Z

Then I don't know. I just followed the installation instructions sequentially with tools 1,2,4,5,7. kedro info returns the expected message.

astrojuanlu · 2024-04-10T07:09:05Z

If anything, there are 2 issues here:

The docs literally say "Whichever options you selected for tools and example code [...] Now run the project:", which is not exactly correct: a pipeline needs to be there.

kedro/docs/source/get_started/new_project.md

Lines 123 to 133 in 2b6f741

    
           Whichever options you selected for tools and example code, once `kedro new` has completed, the next step is to navigate to the project folder (`cd <project-name>`) and install dependencies with `pip` as follows: 
        
           ```bash 
        
           pip install -r requirements.txt 
        
           ``` 
        
           Now run the project: 
        
           ```bash 
        
           kedro run 
        
           ```

The error message should be 1 line. Maybe Kedro tracebacks are overwhelming #2401 should be a parent issue.

noklam · 2024-04-22T13:47:31Z

You have selected no project tools

To skip the interactive flow you can run `kedro new` with
kedro new --name=<your-project-name> --tools=<your-project-tools> --example=<yes/no>

Consider adding some warning about an empty project.

Improve error message Improve error message when executing kedro run without pipeline #3794 (comment)
Docs change in https://docs.kedro.org/en/stable/get_started/new_project.html#run-the-new-project
Maybe make this a collapsible section /appendix notes, it should be clear which command user should runs

doshi-kevin · 2024-08-21T21:02:00Z

Hey is this issue still open, since I want to work on it

astrojuanlu · 2024-08-22T06:27:36Z

Hi @doshi-kevin , go ahead!

doshi-kevin · 2024-08-22T17:17:10Z

Hey @astrojuanlu, could you tell me which changes are yet to be applied? Since I see no change in the documentation, I am getting a different error message upon running the command kedro run.

noklam closed this as completed Apr 9, 2024

noklam reopened this Apr 9, 2024

noklam added this to Kedro Framework Apr 9, 2024

noklam added Issue: Bug Report 🐞 Bug that needs to be fixed Component: Documentation 📄 Issue/PR for markdown and API documentation labels Apr 9, 2024

astrojuanlu mentioned this issue Apr 9, 2024

Kedro tracebacks are overwhelming #2401

Open

github-actions bot mentioned this issue May 1, 2024

Monthly issue metrics report #3846

Open

merelcht changed the title ~~Error when executing kedro run~~ Improve error message when executing kedro run without pipeline May 20, 2024

merelcht added good first issue Good first issues for beginners and removed Component: Documentation 📄 Issue/PR for markdown and API documentation labels May 20, 2024

merelcht added this to the Improve Developer Experience milestone May 20, 2024

merelcht added Component: Documentation 📄 Issue/PR for markdown and API documentation Component: CLI Issue/PR that addresses the CLI for Kedro and removed Issue: Bug Report 🐞 Bug that needs to be fixed labels May 20, 2024

merelcht moved this to To Do in Kedro Framework Jun 5, 2024

ravi-kumar-pilla self-assigned this Dec 9, 2024

ravi-kumar-pilla moved this from To Do to In Progress in Kedro Framework Dec 23, 2024

ravi-kumar-pilla linked a pull request Dec 23, 2024 that will close this issue

Update error message when executing kedro run without pipeline #4391

Open

7 tasks

ravi-kumar-pilla moved this from In Progress to In Review in Kedro Framework Dec 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve error message when executing `kedro run` without pipeline #3794

Improve error message when executing `kedro run` without pipeline #3794

davidmosca commented Apr 9, 2024 •

edited by astrojuanlu

Loading

noklam commented Apr 9, 2024 •

edited

Loading

noklam commented Apr 9, 2024

davidmosca commented Apr 9, 2024

astrojuanlu commented Apr 9, 2024

davidmosca commented Apr 9, 2024

astrojuanlu commented Apr 10, 2024

noklam commented Apr 22, 2024

doshi-kevin commented Aug 21, 2024

astrojuanlu commented Aug 22, 2024

doshi-kevin commented Aug 22, 2024

Improve error message when executing kedro run without pipeline #3794

Improve error message when executing kedro run without pipeline #3794

Comments

davidmosca commented Apr 9, 2024 • edited by astrojuanlu Loading

Description

Context

Steps to Reproduce

Expected Result

Actual Result

Your Environment

noklam commented Apr 9, 2024 • edited Loading

noklam commented Apr 9, 2024

davidmosca commented Apr 9, 2024

astrojuanlu commented Apr 9, 2024

davidmosca commented Apr 9, 2024

astrojuanlu commented Apr 10, 2024

noklam commented Apr 22, 2024

doshi-kevin commented Aug 21, 2024

astrojuanlu commented Aug 22, 2024

doshi-kevin commented Aug 22, 2024

Improve error message when executing `kedro run` without pipeline #3794

Improve error message when executing `kedro run` without pipeline #3794

davidmosca commented Apr 9, 2024 •

edited by astrojuanlu

Loading

noklam commented Apr 9, 2024 •

edited

Loading