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 rag doc example #891

Merged
merged 2 commits into from
May 6, 2024
Merged

Add rag doc example #891

merged 2 commits into from
May 6, 2024

Conversation

skrawcz
Copy link
Collaborator

@skrawcz skrawcz commented May 6, 2024

Adds example showing a simple document processing pipeline.

It uses the notebook as the main documentation bit.

Changes

  • adds to examples
  • fixes one notebook for a related example

How I tested this

  • locally

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

This is to go with the Maven class. More notebooks
will be added here to show how to parallelize/scale processes.
@skrawcz skrawcz merged commit dc853d8 into main May 6, 2024
20 of 22 checks passed
@skrawcz skrawcz deleted the add_rag_doc_example branch May 6, 2024 06:07
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

1 participant