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

docs: Add more info on debugging & seeing component outputs #6901

Closed
TuanaCelik opened this issue Feb 3, 2024 · 3 comments
Closed

docs: Add more info on debugging & seeing component outputs #6901

TuanaCelik opened this issue Feb 3, 2024 · 3 comments
Assignees
Labels
P1 High priority, add to the next sprint type:documentation Improvements on the docs

Comments

@TuanaCelik
Copy link
Member

Our docs doesn't really yet guide users on how to inspect individual component outputs. This comes up especially in terms of prompts, to see the full created prompt.
I can imagine a few sections where we could improve the explanations:

  • In the Creating Pipelines section: I can imagine a point 7) Inspect the pipeline (or something along those lines)
  • Specifically in the PromptBuilder docs
  • Adding more context in the setting the log level docs in terms of inspecting component outputs

These are just some ideas..

@TuanaCelik TuanaCelik added the type:documentation Improvements on the docs label Feb 3, 2024
@underthesand
Copy link

underthesand commented Feb 6, 2024

I am currently looking for how to debug with v2, not tested with v1. Knowing that debug_path doesn't seem to do anything in the haystack code

Pipeline(debug_path=Path("debug/"))

and I don't see where to get the debug information after pipeline excec with debug=True, debug folder still empty and no data in the output dictionary, no _debug key ?

pipeline.run(data={"query_embedder": {"text": input_text}, "prompt_builder": {"query": input_text}}, debug=True)

So yes it would be helpful to document this.

@masci masci added the P3 Low priority, leave it in the backlog label Feb 17, 2024
@MrDVolk
Copy link

MrDVolk commented Apr 16, 2024

I also would like some documentation (or functionality) for debugging pipelines. My previous solution relied heavily on getting _debug information from pipeline's output, but after migration I cannot find anything that could effectively substitute it.

@mrm1001 mrm1001 added P1 High priority, add to the next sprint and removed P3 Low priority, leave it in the backlog labels Jun 21, 2024
@dfokina
Copy link
Contributor

dfokina commented Jul 11, 2024

Hi all, I have added a doc page with currently available methods for debugging in Haystack: https://docs.haystack.deepset.ai/docs/debugging-pipelines

The debug param during execution will be deprecated as it is no longer used in 2.x.

@dfokina dfokina closed this as completed Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1 High priority, add to the next sprint type:documentation Improvements on the docs
Projects
None yet
Development

No branches or pull requests

6 participants