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

Add granite guardian examples using watsonx #51

Closed

Conversation

martinscooper
Copy link
Contributor

@martinscooper martinscooper commented Oct 24, 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.

@martinscooper martinscooper force-pushed the watsonx-gg branch 2 times, most recently from c5620ec to 721202f Compare October 24, 2024 18:19
@adampingel
Copy link
Contributor

Hi, @martinscooper . Please have a look at the checklist for recipes: https://github.com/ibm-granite-community/community/wiki/Authoring-Recipes

@martinscooper martinscooper force-pushed the watsonx-gg branch 4 times, most recently from a79b64a to 41a3410 Compare October 24, 2024 20:29
@martinscooper
Copy link
Contributor Author

@adampingel Done!

@martinscooper martinscooper force-pushed the watsonx-gg branch 2 times, most recently from 32e8d5d to af03499 Compare October 30, 2024 14:19
@martinscooper
Copy link
Contributor Author

@adampingel I resolved the conflicts.

@martinscooper
Copy link
Contributor Author

@adampingel Hi! is there any reason this is not being merged? If so, let me know.

@bjhargrave
Copy link
Collaborator

There are new merge conflicts as we replaced the vanilla workflow yaml. You now only need to add the new notebook to the txt file.

@martinscooper martinscooper force-pushed the watsonx-gg branch 2 times, most recently from c043d02 to a20173c Compare November 4, 2024 10:02
@martinscooper martinscooper force-pushed the watsonx-gg branch 2 times, most recently from f112270 to 0ea9890 Compare November 15, 2024 15:43
Signed-off-by: Martín Santillán Cooper <[email protected]>
@adampingel
Copy link
Contributor

@martinscooper The test is failing: https://github.com/ibm-granite-community/granite-snack-cookbook/actions/runs/12054219413/job/33611754118?pr=51

Please follow the established pattern using the get_env_var from the utils repo.

A example of that applied to WatsonX can be found here: https://github.com/ibm-granite-community/granite-kitchen/blob/main/recipes/Getting_Started/Getting_Started_with_WatsonX.ipynb

@martinscooper martinscooper force-pushed the watsonx-gg branch 3 times, most recently from d456537 to 903bb59 Compare November 28, 2024 01:18
Signed-off-by: Martín Santillán Cooper <[email protected]>
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.

3 participants