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: correct default value of 'use_llmlingua2' #142

Merged
merged 1 commit into from
May 16, 2024

Conversation

kexplo
Copy link
Contributor

@kexplo kexplo commented May 2, 2024

What does this PR do?

The default argument for the 'use_llmlingua2' parameter is False, but the docstring is incorrectly written as True. The DOCUMENT.md file is correctly written as False.

- **use_llmlingua2** (bool, optional): Whether to use llmlingua-2 for prompt compression. Defaults is False.

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Was this discussed/approved via a Github issue? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes?
    • the document already describes it's default value is False:
      • - **use_llmlingua2** (bool, optional): Whether to use llmlingua-2 for prompt compression. Defaults is False.
  • 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.

@iofu728 @mydmdm

@iofu728
Copy link
Contributor

iofu728 commented May 7, 2024

Thanks for your help.

@iofu728 iofu728 self-assigned this May 7, 2024
@iofu728 iofu728 added the documentation Improvements or additions to documentation label May 7, 2024
@iofu728 iofu728 merged commit 7a440a1 into microsoft:main May 16, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants