Skip to content

docs: add required models to run tests with ollama backend to the CONTRIBUTING.md doc#674

Open
code4days wants to merge 1 commit intogenerative-computing:mainfrom
code4days:re/add-ollama-model-requirements
Open

docs: add required models to run tests with ollama backend to the CONTRIBUTING.md doc#674
code4days wants to merge 1 commit intogenerative-computing:mainfrom
code4days:re/add-ollama-model-requirements

Conversation

@code4days
Copy link

@code4days code4days commented Mar 17, 2026

Misc PR

Type of PR

  • Bug Fix
  • New Feature
  • Documentation
  • Other

Description

Adds 'Models Required to Run Tests in test/' section to the CONTRIBUTING.md doc with a list of required models for the ollama backend. It also updates the verification steps to include the ollama pull commands.

Also raised #673 to address one test case that failed consistently due to a dependency issue.

Testing

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

@code4days code4days requested a review from a team as a code owner March 17, 2026 20:47
@github-actions
Copy link
Contributor

The PR description has been updated. Please fill out the template for your PR to be reviewed.

Copy link
Contributor

@ajbozarth ajbozarth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC the tests should just download these automatically (thus why the tests stick to very small models). I can understand wanting to list models that are downloaded, but I don't think the extra commands are worth the doc clutter. I do have some hesitation around listing the models though as well since the list could changes and this would be another place to keep updated.

No strong feeling against this idea though. Many small issues with the actual change below:

CONTRIBUTING.md Outdated
Comment on lines +97 to +100
ollama pull granite4:micro-h
ollama pull granite3.2-vision
ollama pull granite4:micro
ollama pull qwen2.5vl:7b
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would maybe add the list of required models down to the Testing section (maybe right after the quick reference), something like

### Required models

Ollama
- granite4:micro-h
- ...

_Note: ollama models can be obtained by running `ollama pull <model>_

@mergify
Copy link

mergify bot commented Mar 17, 2026

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|release)(?:\(.+\))?:

…ests to run

Adds a Required models section with a list of required ollama models for non qualitative tests to pass

Supports generative-computing#574
@code4days code4days force-pushed the re/add-ollama-model-requirements branch from 8a9d5da to 9694e16 Compare March 18, 2026 18:47

This script handles environment setup, dependency installation, and pre-commit hook installation.


Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change


### Verify Installation

Pull [required models](#required-models)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: looking at the doc as a whole, I would actually put this link with the ollama prereq. Maybe say something like

- [Ollama](https://ollama.com/download) with [required models](#required-models) (for local testing)

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