Skip to content

docs(examples): standardize m_serve, m_decompose, audio_text_models - #1774

Open
rafvasq wants to merge 1 commit into
generative-computing:mainfrom
rafvasq:docs/serving-multimodal-standardize
Open

rafvasq wants to merge 1 commit into
generative-computing:mainfrom
rafvasq:docs/serving-multimodal-standardize

Conversation

@rafvasq

@rafvasq rafvasq commented Oct 29, 2026

Copy link
Copy Markdown
Contributor

Pull Request

Issue

Towards #1746

Description

Standardizes m_serve/, m_decompose/, audio_text_models/, image_text_models/, and mini_researcher/

Docstrings

  • Converted to module docstrings and added prerequisites/usage blocks. Most original text was left unchanged aside from some instances to include relevant info from the README. Added descriptions to scripts that had none.
  • audio_examples.py: Prerequisites now include the full llama-server command from the old README and pii_serve.py: added the spaCy prerequisites.

READMEs

  • Each is now a short description, links to the matching site docs, and an ## Examples table, using the original per-file descriptions.
  • Removed content was checked against integration, how-to, and CLI docs first. Kept content the docs don't cover yet.

Other fixes

  • Both tool-calling examples list granite4:micro-h, the model they use (IBM_GRANITE_4_HYBRID_MICRO).
  • Removed a misplaced #!/usr/bin/env python3 from python_decompose_example.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.

…image_text_models, mini_researcher

Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
Assisted-by: IBM Bob
@rafvasq
rafvasq requested a review from a team as a code owner October 29, 2026 14:44
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 29, 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