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

Rewrite Summarization recipe to utilize larger context #80 #98

Closed
wants to merge 2 commits into from

Conversation

gh-madhu1
Copy link

@gh-madhu1 gh-madhu1 commented Dec 20, 2024

PR Checklist

Model Interaction

  • Flexible LLM platform support The platform should be easily switchable. Use LangChain or LlamaIndex.
  • Use prompt guide corresponding to the model For example for Granite 3.x Language Models

Data

  • Example data: Follow the example data guidance.

Notebook requirements

  • Notebook outputs cleared: Ensure all notebook outputs are cleared.
  • Automated testing: Add the recipe to the automated tests as described here
  • Test in Google Colab:
    • Test that it works in Google Colab (Python 3.10.12).
    • Colab has its own package set and Python version, so ensure compatibility.
  • Test locally:
    • Ensure the code works in a fresh Python virtual environment (venv).
  • Standard access to secrets and variables Include !pip install git+https://github.com/ibm-granite-community/utils in the first code cell in order to make get_env_var available to accessing secrets and variables in the recipe.

Incoming References

  • README.md updates:
    • Add a link to the recipe in the Table of Contents (ToC).
    • Include a Colab button after that link.

GitHub

  • Commits signed: All commits must be GPG or SSH signed.
  • DCO Compliance: Developer Certificate of Origin (DCO) applies to the code, documentation, and any example data provided. Ensure commits are signed off.

MADHU KANUKULA added 2 commits December 21, 2024 00:04
Signed-off-by: MADHU KANUKULA <[email protected]>
@gh-madhu1
Copy link
Author

@adampingel @bjhargrave Can you please have a look and merge if it looks good?

@gh-madhu1 gh-madhu1 enabled auto-merge (squash) December 30, 2024 09:08
@bjhargrave
Copy link
Collaborator

I have an alternate solution in #101. That pr uses docling to chunk the book from html to get chapter level chunking. It also uses the granite 3.1 prompting including using the documents role: https://www.ibm.com/granite/docs/models/granite/#summarization

@bjhargrave bjhargrave disabled auto-merge January 9, 2025 13:29
@bjhargrave
Copy link
Collaborator

@gh-madhu1, I am closing this PR since I merged #101 as an alternate solution. Thanks!

@bjhargrave bjhargrave closed this Jan 10, 2025
@bjhargrave bjhargrave deleted the summarize_recipe branch January 14, 2025 19:10
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.

2 participants