Skip to content

DOC Fix incorrect LoRA references in hira and ln_tuning model docstrings #3291

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

Open
javierdejesusda wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

DOC Fix incorrect LoRA references in hira and ln_tuning model docstrings #3291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions src/peft/tuners/hira/model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,13 @@ class HiraModel(BaseTuner):

Args:
model ([`torch.nn.Module`]): The model to be adapted.
config ([`LoraConfig`]): The configuration of the Lora model.
config ([`HiraConfig`]): The configuration of the HiRA model.
adapter_name (`str`): The name of the adapter, defaults to `"default"`.
low_cpu_mem_usage (`bool`, `optional`, defaults to `False`):
Create empty adapter weights on meta device. Useful to speed up the loading process.

Returns:
`torch.nn.Module`: The Lora model.
`torch.nn.Module`: The HiRA model.

Example:

Expand Down Expand Up @@ -113,7 +113,7 @@ class HiraModel(BaseTuner):

**Attributes**:
- **model** ([`~transformers.PreTrainedModel`]) -- The model to be adapted.
- **peft_config** ([`LoraConfig`]): The configuration of the Lora model.
- **peft_config** ([`HiraConfig`]): The configuration of the HiRA model.
"""

prefix: str = "hira_"
Expand Down
4 changes: 2 additions & 2 deletions src/peft/tuners/ln_tuning/model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class LNTuningModel(BaseTuner):

Args:
model ([`torch.nn.Module`]): The model to be adapted.
config ([`LNTuningConfig`]): The configuration of the Lora model.
config ([`LNTuningConfig`]): The configuration of the LN tuning model.
adapter_name (`str`): The name of the adapter, defaults to `"default"`.
low_cpu_mem_usage (`bool`, `optional`, defaults to `False`):
This option has no effect on LN tuning but exists for consistency with other PEFT methods.
Expand All @@ -58,7 +58,7 @@ class LNTuningModel(BaseTuner):

**Attributes**:
- **model** ([`~transformers.PreTrainedModel`]) -- The model to be adapted.
- **peft_config** ([`LNTuningConfig`]): The configuration of the Lora model.
- **peft_config** ([`LNTuningConfig`]): The configuration of the LN tuning model.
"""

prefix: str = "ln_tuning_"
Expand Down