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: Pipeline.inputs() #8271

Closed
TuanaCelik opened this issue Aug 22, 2024 · 2 comments
Closed

docs: Pipeline.inputs() #8271

TuanaCelik opened this issue Aug 22, 2024 · 2 comments
Assignees
Labels
P2 Medium priority, add to the next sprint if no P1 available topic:pipeline type:documentation Improvements on the docs

Comments

@TuanaCelik
Copy link
Contributor

Once a pipeline is created, it's difficult for users to know how they should run the pipeline. We have quite a useful utility function for pipelines which is .inputs() which lists all the expected/required inputs for the components.

We should use this in our docs heavily imo. This function is hardly visible, and we don't really provide any help on how a pipeline should be run other than trial and errors. Once a pipeline fails, the error us quite handy. And if a user knows to ues .show() that is also handy. But I think we should add this everywhere as something that a user colud make use of while creating/running pipelines.

  1. In the pipelines doc
  2. In all component docs where we have example pipelines..
@TuanaCelik TuanaCelik added topic:pipeline type:documentation Improvements on the docs labels Aug 22, 2024
@TuanaCelik TuanaCelik changed the title Documentation: Pipeline.inputs() docs: Pipeline.inputs() Aug 22, 2024
@aantti
Copy link
Contributor

aantti commented Aug 22, 2024

I'd love that. Specifically, btw, struggled recently with OpenAITextEmbedder trying to figure out the correct parameter ('text').

@julian-risch julian-risch added the P2 Medium priority, add to the next sprint if no P1 available label Aug 23, 2024
@dfokina
Copy link
Contributor

dfokina commented Sep 10, 2024

I have added the following paragraph to the docs that should be well-searchable for pipeline inputs or component inputs: https://docs.haystack.deepset.ai/docs/creating-pipelines#pipeline-inputs

@dfokina dfokina closed this as completed Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 Medium priority, add to the next sprint if no P1 available topic:pipeline type:documentation Improvements on the docs
Projects
None yet
Development

No branches or pull requests

4 participants