Skip to content

chore: correct documentation links in geti tune cards#614

Merged
tybulewicz merged 14 commits into
masterfrom
ttybulew/update-geti-tune-model-cards
Jun 30, 2026
Merged

chore: correct documentation links in geti tune cards#614
tybulewicz merged 14 commits into
masterfrom
ttybulew/update-geti-tune-model-cards

Conversation

@tybulewicz

@tybulewicz tybulewicz commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

Updates model card/README template generation to use more user-friendly license naming and to correct Geti Tune documentation/source links, aligning generated model cards with updated link targets.

Fixes #612

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?

In case of Apache-2.0 license, the official name is capitalized, but
in Hugging Face metadata a lowercased version must be used.

This change allows to specify license and license_name separately.

What's more, for known case of apache-2.0, correct name will be used
automatically.
@tybulewicz tybulewicz requested a review from a team as a code owner June 26, 2026 13:07
@tybulewicz tybulewicz requested a review from Copilot June 26, 2026 13:07
@github-actions github-actions Bot added python python related changes docs Related to documentation labels Jun 26, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates model card/README template generation to use more user-friendly license naming and to correct Geti Tune documentation/source links, aligning generated model cards with updated link targets.

Changes:

  • Update multiple README templates to use <<license_name>> (instead of <<license>>) in Legal information, and adjust Geti links in Geti Tune templates.
  • Add license-name normalization and inferred “docs page type” (card/repository/documentation) placeholders during README rendering.
  • Update several Geti Tune entries in presets/config.json to point docs to the original source/model documentation rather than Geti Training Extensions.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
model_converter/src/model_converter/templates/README-torchvision-int8.md Switch Legal info to <<license_name>>; still needs descriptive “original model repository” link text.
model_converter/src/model_converter/templates/README-torchvision-fp16.md Switch Legal info to <<license_name>>; still needs descriptive “original model repository” link text.
model_converter/src/model_converter/templates/README-timm-int8.md Switch Legal info to <<license_name>>; still needs descriptive “original model card” link text.
model_converter/src/model_converter/templates/README-timm-fp16.md Switch Legal info to <<license_name>>; still needs descriptive “original model card” link text.
model_converter/src/model_converter/templates/README-getitune-int8.md Update Geti links and improve Legal info to reference the original model docs/card/repo.
model_converter/src/model_converter/templates/README-getitune-fp16.md Update Geti links and improve Legal info to reference the original model docs/card/repo.
model_converter/src/model_converter/converters/base.py Add derived placeholders for human license name and inferred docs page label; improve dataset warning message.
model_converter/README.md Document new license_name field in config example (example casing needs adjustment).
model_converter/presets/config.json Update several Geti Tune docs links to point to original upstream sources.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread model_converter/src/model_converter/templates/README-timm-int8.md
Comment thread model_converter/src/model_converter/templates/README-timm-fp16.md
Comment thread model_converter/src/model_converter/converters/base.py
Comment thread model_converter/src/model_converter/converters/base.py
Comment thread model_converter/README.md
@github-actions github-actions Bot added the tests Related to tests label Jun 26, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@tybulewicz tybulewicz enabled auto-merge June 26, 2026 14:07
Comment thread model_converter/src/model_converter/converters/base.py
@tybulewicz tybulewicz disabled auto-merge June 29, 2026 07:04
mgumowsk
mgumowsk previously approved these changes Jun 29, 2026
mgumowsk
mgumowsk previously approved these changes Jun 29, 2026
@tybulewicz tybulewicz force-pushed the ttybulew/update-geti-tune-model-cards branch from e263b0f to 256c913 Compare June 29, 2026 13:46
@tybulewicz tybulewicz force-pushed the ttybulew/update-geti-tune-model-cards branch from 322a354 to d170985 Compare June 29, 2026 13:49
@tybulewicz tybulewicz enabled auto-merge June 30, 2026 05:52
@tybulewicz tybulewicz added this pull request to the merge queue Jun 30, 2026
Merged via the queue into master with commit ab277b2 Jun 30, 2026
70 of 75 checks passed
@tybulewicz tybulewicz deleted the ttybulew/update-geti-tune-model-cards branch June 30, 2026 07:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Related to documentation python python related changes tests Related to tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update model cards from Geti Tune

3 participants