Skip to content

Commit 963ed98

Browse files
authored
docs: Replace package abbreviations with full name(bitsandbytes) in docstrings (#33230)
* docs: Provide fullname for `bitsandbytes` package * docs: Provide fullname for `bitsandbytes` package (2)
1 parent 409fcfd commit 963ed98

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

src/transformers/trainer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1274,7 +1274,7 @@ def get_optimizer_cls_and_kwargs(
12741274
optimizer_kwargs.update(additional_optim_kwargs)
12751275
optimizer_kwargs.update(bnb_kwargs)
12761276
except ImportError:
1277-
raise ValueError("Trainer tried to instantiate bnb optimizer but bnb is not installed!")
1277+
raise ValueError("Trainer tried to instantiate bnb optimizer but `bitsandbytes` is not installed!")
12781278
if is_bitsandbytes_available() and version.parse(
12791279
importlib.metadata.version("bitsandbytes")
12801280
) < version.parse("0.41.1"):

tests/trainer/test_trainer.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4427,7 +4427,7 @@ def test_bnb_adam8bit_no_bnb(self):
44274427
args = TrainingArguments(optim=OptimizerNames.ADAMW_BNB, output_dir="None")
44284428

44294429
# Pretend that bnb does not exist, even if installed. By setting bnb to None, importing
4430-
# bnb will fail even if bnb is installed.
4430+
# bnb will fail even if `bitsandbytes` is installed.
44314431
with patch.dict("sys.modules", {"bitsandbytes.optim": None}):
44324432
with self.assertRaises(ValueError):
44334433
Trainer.get_optimizer_cls_and_kwargs(args)
@@ -4436,7 +4436,7 @@ def test_bnb_paged_adam_no_bnb(self):
44364436
args = TrainingArguments(optim=OptimizerNames.PAGED_ADAMW, output_dir="None")
44374437

44384438
# Pretend that bnb does not exist, even if installed. By setting bnb to None, importing
4439-
# bnb will fail even if bnb is installed.
4439+
# bnb will fail even if `bitsandbytes` is installed.
44404440
with patch.dict("sys.modules", {"bitsandbytes.optim": None}):
44414441
with self.assertRaises(ValueError):
44424442
Trainer.get_optimizer_cls_and_kwargs(args)
@@ -4445,7 +4445,7 @@ def test_bnb_paged_adam8bit_no_bnb(self):
44454445
args = TrainingArguments(optim=OptimizerNames.PAGED_ADAMW_8BIT, output_dir="None")
44464446

44474447
# Pretend that bnb does not exist, even if installed. By setting bnb to None, importing
4448-
# bnb will fail even if bnb is installed.
4448+
# bnb will fail even if `bitsandbytes` is installed.
44494449
with patch.dict("sys.modules", {"bitsandbytes.optim": None}):
44504450
with self.assertRaises(ValueError):
44514451
Trainer.get_optimizer_cls_and_kwargs(args)
@@ -4454,7 +4454,7 @@ def test_bnb_paged_lion_no_bnb(self):
44544454
args = TrainingArguments(optim=OptimizerNames.PAGED_LION, output_dir="None")
44554455

44564456
# Pretend that bnb does not exist, even if installed. By setting bnb to None, importing
4457-
# bnb will fail even if bnb is installed.
4457+
# bnb will fail even if `bitsandbytes` is installed.
44584458
with patch.dict("sys.modules", {"bitsandbytes.optim": None}):
44594459
with self.assertRaises(ValueError):
44604460
Trainer.get_optimizer_cls_and_kwargs(args)
@@ -4463,7 +4463,7 @@ def test_bnb_paged_lion8bit_no_bnb(self):
44634463
args = TrainingArguments(optim=OptimizerNames.PAGED_LION_8BIT, output_dir="None")
44644464

44654465
# Pretend that bnb does not exist, even if installed. By setting bnb to None, importing
4466-
# bnb will fail even if bnb is installed.
4466+
# bnb will fail even if `bitsandbytes` is installed.
44674467
with patch.dict("sys.modules", {"bitsandbytes.optim": None}):
44684468
with self.assertRaises(ValueError):
44694469
Trainer.get_optimizer_cls_and_kwargs(args)

0 commit comments

Comments
 (0)