Config: Make a better description for lora config

This is not ideal because users may still have trouble understanding
what a lora includes, but adding an example comment will help instead
of leaving a blank line.

Signed-off-by: kingbri <bdashore3@proton.me>
This commit is contained in:
kingbri 2024-09-16 23:29:39 -04:00
parent 852ea8faaa
commit 63f8c46a92

View file

@ -333,7 +333,7 @@ class DraftModelConfig(BaseConfigModel):
class LoraInstanceModel(BaseConfigModel):
"""Model representing an instance of a Lora."""
name: str = Field(..., description=("Name of the LoRA model."))
name: Optional[str] = Field(None, description=("Name of the LoRA model."))
scaling: float = Field(
1.0,
description=("Scaling factor for the LoRA model (default: 1.0)."),
@ -352,7 +352,10 @@ class LoraConfig(BaseConfigModel):
None,
description=(
"List of LoRAs to load and associated scaling factors "
"(default scale: 1.0)."
"(default scale: 1.0).\n"
"For the YAML file, add each entry as a YAML list:\n"
"- name: lora1\n"
" scaling: 1.0"
),
)