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

Fix incomplete json output in guideline evaluator #12646

Merged
merged 4 commits into from Apr 9, 2024

Conversation

moria97
Copy link
Contributor

@moria97 moria97 commented Apr 8, 2024

Description

For guidelines evaluator, the code expect json output from LLM and raise exception when fail to parse json.

However, sometimes the LLM response is longer than max token due to a long feedback, the output json will be incomplete and thus break the evaluation process. This is an unintended behavior for evaluation process.

Considering we don't need very long feedbacks in evaluation, I added a 'concise hint' to the output format prompt to fix this issue.

Fixes # (issue)

New Package?

Did I fill in the tool.llamahub section in the pyproject.toml and provide a detailed README.md for my new integration or package?

  • Yes
  • No

Version Bump?

Did I bump the version in the pyproject.toml file of the package I am updating? (Except for the llama-index-core package)

  • Yes
  • No

Type of Change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Added new unit/integration tests
  • Added new notebook (that tests end-to-end)
  • I stared at the code and made sure it makes sense

Suggested Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added Google Colab support for the newly added notebooks.
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I ran make format; make lint to appease the lint gods

@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Apr 8, 2024
@@ -71,7 +79,9 @@ def __init__(
else:
self._eval_template = eval_template or DEFAULT_EVAL_TEMPLATE

self._output_parser = PydanticOutputParser(output_cls=EvaluationData)
self._output_parser = PydanticOutputParser(
output_cls=EvaluationData, pydantic_format_tmpl=PYDANTIC_FORMAT_TMPL
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why do we modify prompt here? There is already a very similar prompt here

Feels like either the default prompt could be modified, or this is specific to the LLM you are using and you should just pass in a customized output parser as kwarg

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. Actually I'm overwriting the template for evaluations only because I'm not quite sure whether it's a common requirements for json output to modify the default template.
Now I feel adding a custom output parser to the constructor here makes more sense since it allows flexibility with different LLMs/settings and backward compatibility. I have added a custom output parser para now.

@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. and removed size:S This PR changes 10-29 lines, ignoring generated files. labels Apr 9, 2024
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Apr 9, 2024
@logan-markewich logan-markewich merged commit 5148c80 into run-llama:main Apr 9, 2024
8 checks passed
chrisalexiuk-nvidia pushed a commit to chrisalexiuk-nvidia/llama_index that referenced this pull request Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants