Skip to content

add models to model_converter with hf card templates#507

Open
mgumowsk wants to merge 12 commits intomasterfrom
mgumowsk/hf-model-cards
Open

add models to model_converter with hf card templates#507
mgumowsk wants to merge 12 commits intomasterfrom
mgumowsk/hf-model-cards

Conversation

@mgumowsk
Copy link
Contributor

@mgumowsk mgumowsk commented Mar 18, 2026

What does this PR do?

Usage:

uv sync --extra tools
uv run python model_converter.py config.json -o ./models -d PATH_TO_ILSVRC2012_img_val_subset
upload-to-hf.sh

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?

@mgumowsk mgumowsk requested a review from a team as a code owner March 18, 2026 11:47
@github-actions github-actions bot added docs Related to documentation build Related to build scripts labels Mar 18, 2026
# {model_name}

- Model creator: [timm](https://huggingface.co/timm)
- Original model: [timm/{model_name}](https://huggingface.co/timm/{model_name})
Copy link
Contributor

Choose a reason for hiding this comment

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

model_name differs from original name of the model (dot is replaced by underscode) - consider not changing original names, to make links correct

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed


## Legal information

The original model is distributed under [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/) license. More details can be found in [timm/{model_name}](https://huggingface.co/timm/{model_name}).
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we sure that all TIMM models fall under apache 2.0? Maybe the license should be downloaded from HF metadata?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

add license name in model config

# {model_name}

- Model creator: [torchvision](https://github.com/pytorch/vision)
- Original model: [{model_name}](https://github.com/pytorch/vision)
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't we provide full link to the model? for example https://docs.pytorch.org/vision/main/models/generated/torchvision.models.resnet101.html

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added

@mgumowsk mgumowsk force-pushed the mgumowsk/hf-model-cards branch from 56e4a13 to e07c858 Compare March 19, 2026 13:33
Copy link
Contributor

@tybulewicz tybulewicz left a comment

Choose a reason for hiding this comment

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

This works as a first version, to be refined later

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build Related to build scripts docs Related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants