Skip to content

docs(examples): standardize data, extraction, and RAG examples - #1764

Open
rafvasq wants to merge 1 commit into
generative-computing:mainfrom
rafvasq:docs/data-extraction-rag-standardize
Open

rafvasq wants to merge 1 commit into
generative-computing:mainfrom
rafvasq:docs/data-extraction-rag-standardize

Conversation

@rafvasq

@rafvasq rafvasq commented Oct 26, 2026

Copy link
Copy Markdown
Contributor

Pull Request

Issue

Towards #1746

Description

Docstrings:

  • One-line title, body paragraph describing the pattern/APIs demonstrated
  • Prerequisites: block with exact ollama pull / pip install commands
  • 4-space-indented Usage: with the full run command

READMEs:

  • all 4 replaced with a description + ## Examples table
  • content (pipeline diagrams, code samples, concept explanations) was verified present in the site docs before removal

Other fixes:

  • Removed unused from mellea.backends import model_ids imports in both information_extraction/ scripts
  • Fixed ollama pull tags to match actual ModelIdentifier.ollama_name values
  • Added missing pip install docling to mellea_pdf.py

Testing

  • Tests added to the respective file if code was changed
  • New code has 100% coverage if code was added
  • Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

Attribution

  • AI coding assistants used

Adding a new component, requirement, sampling strategy, or tool?

If your PR adds or modifies one of the types below, check the matching box. A checklist of type-specific review items will be posted as a comment.

  • Component
  • Requirement
  • Sampling Strategy
  • Tool

NOTE: Please ensure you have an issue that has been acknowledged by a core contributor and routed you to open a pull request against this repository. Otherwise, please open an issue before continuing with this pull request.

…ed-by: IBM Bob

Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
@rafvasq
rafvasq requested a review from a team as a code owner October 26, 2026 20:00
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 26, 2026

This branch has not been deployed

No deployments
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.

1 participant