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

Issue#28224 fix a link in doc #30562

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

nmuthusamy
Copy link

@nmuthusamy nmuthusamy commented Apr 30, 2024

What does this PR do?

This PR fixes a documentation link in pipeline docs. The link pointing to additional documentation for additional keyword arguments that pass along to the generate method of the model was incorrect which has been addressed in this PR.

Fixes # (issue)

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

- The link pointing to additional documentation for additional keyword arguments that pass along to the generate method of the model was incorrect which has been addressed in this commit.
- The link pointing to additional documentation for additional keyword arguments that pass along to the generate method of the model was incorrect which has been addressed in this commit.
@amyeroberts
Copy link
Collaborator

cc @gante

@@ -270,7 +270,7 @@ def __call__(self, conversations: Union[List[Dict], Conversation, List[Conversat
Whether or not to clean up the potential extra spaces in the text output.
generate_kwargs:
Additional keyword arguments to pass along to the generate method of the model (see the generate method
corresponding to your framework [here](./model#generative-models)).
corresponding to your framework [here](https://huggingface.co/docs/transformers/generation_strategies#text-generation-strategies)).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it'd be better to link to the Generation API doc since that has the specific keyword arguments for each framework whereas the Text generation strategies doc has a wider scope.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed with Steven!

@lappemic
Copy link

@nmuthusamy are you planning on further working on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants