Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use base_model to encode that a model is a quantized version of another model #1254

Merged
merged 4 commits into from
Mar 29, 2024
Merged

use base_model to encode that a model is a quantized version of another model #1254

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cecad17
use `base_model` to encode that a model is a quantized version of ano…
julien-c Mar 22, 2024
f5ffa65
add some screenshots
julien-c Mar 22, 2024
40ce188
Update docs/hub/model-cards.md
julien-c Mar 29, 2024
7d2f97e
tweak + add the yaml example with two base models
julien-c Mar 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/hub/model-cards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The metadata you add to the model card supports discovery and easier use of your

* Allowing users to filter models at https://huggingface.co/models.
* Displaying the model's license.
* Adding datasets to the metadata will add a message reading `Datasets used to train:` to your model card and link the relevant datasets, if they're available on the Hub.
* Adding datasets to the metadata will add a message reading `Datasets used to train:` to your model page and link the relevant datasets, if they're available on the Hub.

Dataset, metric, and language identifiers are those listed on the [Datasets](https://huggingface.co/datasets), [Metrics](https://huggingface.co/metrics) and [Languages](https://huggingface.co/languages) pages.

Expand Down Expand Up @@ -110,7 +110,7 @@ If it's not specified, the Hub will try to automatically detect the library type

### Specifying a base model

If your model is a fine-tune or adapter of a base model, you can specify the base model in the model card metadata section. This information can also be used to indicate if your model is a merge of multiple existing models. The `base_model` field can either be a single model ID, or a list of one or more base_models (specified by their Hub identifier).
If your model is a fine-tune, an adapter, or a quantized version of a base model, you can specify the base model in the model card metadata section. This information can also be used to indicate if your model is a merge of multiple existing models. The `base_model` field can either be a single model ID, or a list of one or more base_models (specified by their Hub identifier).
julien-c marked this conversation as resolved.
Show resolved Hide resolved

```yaml
base_model: HuggingFaceH4/zephyr-7b-beta
Expand Down
2 changes: 1 addition & 1 deletion docs/hub/peft.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ $ pip install peft

## Using existing models

All PEFT models can be loaded from the Hub. To use a PEFT model you also need to load the base model that was fine-tuned, as shown below. Every fine-tuned model has the base model in it's model card.
All PEFT models can be loaded from the Hub. To use a PEFT model you also need to load the base model that was fine-tuned, as shown below. Every fine-tuned model has the base model in its model card.
julien-c marked this conversation as resolved.
Show resolved Hide resolved

```py
from transformers import AutoModelForCausalLM, AutoTokenizer
Expand Down
Loading