Skip to content

Commit f675826

Browse files
Document new_version metadata (#1430)
* Document new_version metadata * Update docs/hub/model-cards.md Co-authored-by: Omar Sanseviero <[email protected]> * Add note about transitive versions --------- Co-authored-by: Omar Sanseviero <[email protected]>
1 parent ed36c92 commit f675826

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/hub/model-cards.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,23 @@ base_model:
158158

159159
The Hub will infer the type of relationship from the current model to the base model (`"adapter", "merge", "quantized", "finetune"`) but you can also set it explicitly if needed: `base_model_relation: quantized` for instance.
160160

161+
### Specifying a new version
162+
163+
If a new version of your model is available in the Hub, you can specify it in a `new_version` field.
164+
165+
For example, on `l3utterfly/mistral-7b-v0.1-layla-v3`:
166+
167+
```yaml
168+
new_version: l3utterfly/mistral-7b-v0.1-layla-v4
169+
```
170+
171+
This metadata will be used to display a link to the latest version of a model on the model page. If the model linked in `new_version` also has a `new_version` field, the very latest version will always be displayed.
172+
173+
<div class="flex justify-center">
174+
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/new_version.png"/>
175+
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/new_version-dark.png"/>
176+
</div>
177+
161178
### Specifying a dataset
162179

163180
You can specify the datasets used to train your model in the model card metadata section. The datasets will be displayed on the model page and users will be able to filter models by dataset. You should use the Hub dataset identifier, which is the same as the dataset's repo name as the identifier:

0 commit comments

Comments
 (0)