From 963ed98bed38b1903a79daba56828f73b2543749 Mon Sep 17 00:00:00 2001 From: Jeongseok Kang Date: Mon, 2 Sep 2024 20:40:34 +0900 Subject: [PATCH] docs: Replace package abbreviations with full name(`bitsandbytes`) in docstrings (#33230) * docs: Provide fullname for `bitsandbytes` package * docs: Provide fullname for `bitsandbytes` package (2) --- src/transformers/trainer.py | 2 +- tests/trainer/test_trainer.py | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/transformers/trainer.py b/src/transformers/trainer.py index 2d7020ffaf..1002ceb0cf 100755 --- a/src/transformers/trainer.py +++ b/src/transformers/trainer.py @@ -1274,7 +1274,7 @@ class Trainer: optimizer_kwargs.update(additional_optim_kwargs) optimizer_kwargs.update(bnb_kwargs) except ImportError: - raise ValueError("Trainer tried to instantiate bnb optimizer but bnb is not installed!") + raise ValueError("Trainer tried to instantiate bnb optimizer but `bitsandbytes` is not installed!") if is_bitsandbytes_available() and version.parse( importlib.metadata.version("bitsandbytes") ) < version.parse("0.41.1"): diff --git a/tests/trainer/test_trainer.py b/tests/trainer/test_trainer.py index 00d15acf18..a557e0f80b 100644 --- a/tests/trainer/test_trainer.py +++ b/tests/trainer/test_trainer.py @@ -4427,7 +4427,7 @@ class TrainerOptimizerChoiceTest(unittest.TestCase): args = TrainingArguments(optim=OptimizerNames.ADAMW_BNB, output_dir="None") # Pretend that bnb does not exist, even if installed. By setting bnb to None, importing - # bnb will fail even if bnb is installed. + # bnb will fail even if `bitsandbytes` is installed. with patch.dict("sys.modules", {"bitsandbytes.optim": None}): with self.assertRaises(ValueError): Trainer.get_optimizer_cls_and_kwargs(args) @@ -4436,7 +4436,7 @@ class TrainerOptimizerChoiceTest(unittest.TestCase): args = TrainingArguments(optim=OptimizerNames.PAGED_ADAMW, output_dir="None") # Pretend that bnb does not exist, even if installed. By setting bnb to None, importing - # bnb will fail even if bnb is installed. + # bnb will fail even if `bitsandbytes` is installed. with patch.dict("sys.modules", {"bitsandbytes.optim": None}): with self.assertRaises(ValueError): Trainer.get_optimizer_cls_and_kwargs(args) @@ -4445,7 +4445,7 @@ class TrainerOptimizerChoiceTest(unittest.TestCase): args = TrainingArguments(optim=OptimizerNames.PAGED_ADAMW_8BIT, output_dir="None") # Pretend that bnb does not exist, even if installed. By setting bnb to None, importing - # bnb will fail even if bnb is installed. + # bnb will fail even if `bitsandbytes` is installed. with patch.dict("sys.modules", {"bitsandbytes.optim": None}): with self.assertRaises(ValueError): Trainer.get_optimizer_cls_and_kwargs(args) @@ -4454,7 +4454,7 @@ class TrainerOptimizerChoiceTest(unittest.TestCase): args = TrainingArguments(optim=OptimizerNames.PAGED_LION, output_dir="None") # Pretend that bnb does not exist, even if installed. By setting bnb to None, importing - # bnb will fail even if bnb is installed. + # bnb will fail even if `bitsandbytes` is installed. with patch.dict("sys.modules", {"bitsandbytes.optim": None}): with self.assertRaises(ValueError): Trainer.get_optimizer_cls_and_kwargs(args) @@ -4463,7 +4463,7 @@ class TrainerOptimizerChoiceTest(unittest.TestCase): args = TrainingArguments(optim=OptimizerNames.PAGED_LION_8BIT, output_dir="None") # Pretend that bnb does not exist, even if installed. By setting bnb to None, importing - # bnb will fail even if bnb is installed. + # bnb will fail even if `bitsandbytes` is installed. with patch.dict("sys.modules", {"bitsandbytes.optim": None}): with self.assertRaises(ValueError): Trainer.get_optimizer_cls_and_kwargs(args)