FEAT Helper to check if a model is a PEFT model

[BenjaminBossan]

After internal discussion, we decided to add this convenience function.

>>> from peft.helpers import check_is_peft_model
>>> check_is_peft_model("gpt2")
False
>>> check_is_peft_model("peft-internal-testing/gpt2-lora-random")
True
>>> check_is_peft_model("peft-internal-testing/non-existing-model")
False
>>> check_is_peft_model("path/to/local/model/also/works")

[HuggingFaceDocBuilderDev]

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

[BenjaminBossan]

Ping @stas00

[stas00]

Excellent, thank you @BenjaminBossan.

The only possible suggestion is for a different naming as check and is are both verbs, so perhaps either is_peft_model or check_if_peft_model?

I'm not sure if you have a precedent for other similar check-if utils to follow the same convention.

[younesbelkada]

Nice API ! Thanks !

[BenjaminBossan]

The only possible suggestion is for a different naming as check and is are both verbs, so perhaps either is_peft_model or check_if_peft_model?

Good point, I renamed it to check_if_peft_model. My reasoning for not using is_peft_model is that I often want to call the variable that name in similar situations, e.g. is_peft_model = check_if_peft_model(...); if is_peft_model: ...

[stas00]

yes, I totally agree that:

is_peft_model = check_if_peft_model()

sounds perfect to me.