docs: Replace package abbreviations with full name(bitsandbytes) in docstrings (#33230)

* docs: Provide fullname for `bitsandbytes` package

* docs: Provide fullname for `bitsandbytes` package (2)
This commit is contained in:
Jeongseok Kang 2024-09-02 20:40:34 +09:00 committed by GitHub
parent 409fcfdfcc
commit 963ed98bed
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 6 deletions

View File

@ -1274,7 +1274,7 @@ class Trainer:
optimizer_kwargs.update(additional_optim_kwargs) optimizer_kwargs.update(additional_optim_kwargs)
optimizer_kwargs.update(bnb_kwargs) optimizer_kwargs.update(bnb_kwargs)
except ImportError: 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( if is_bitsandbytes_available() and version.parse(
importlib.metadata.version("bitsandbytes") importlib.metadata.version("bitsandbytes")
) < version.parse("0.41.1"): ) < version.parse("0.41.1"):

View File

@ -4427,7 +4427,7 @@ class TrainerOptimizerChoiceTest(unittest.TestCase):
args = TrainingArguments(optim=OptimizerNames.ADAMW_BNB, output_dir="None") args = TrainingArguments(optim=OptimizerNames.ADAMW_BNB, output_dir="None")
# Pretend that bnb does not exist, even if installed. By setting bnb to None, importing # 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 patch.dict("sys.modules", {"bitsandbytes.optim": None}):
with self.assertRaises(ValueError): with self.assertRaises(ValueError):
Trainer.get_optimizer_cls_and_kwargs(args) Trainer.get_optimizer_cls_and_kwargs(args)
@ -4436,7 +4436,7 @@ class TrainerOptimizerChoiceTest(unittest.TestCase):
args = TrainingArguments(optim=OptimizerNames.PAGED_ADAMW, output_dir="None") args = TrainingArguments(optim=OptimizerNames.PAGED_ADAMW, output_dir="None")
# Pretend that bnb does not exist, even if installed. By setting bnb to None, importing # 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 patch.dict("sys.modules", {"bitsandbytes.optim": None}):
with self.assertRaises(ValueError): with self.assertRaises(ValueError):
Trainer.get_optimizer_cls_and_kwargs(args) 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") 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 # 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 patch.dict("sys.modules", {"bitsandbytes.optim": None}):
with self.assertRaises(ValueError): with self.assertRaises(ValueError):
Trainer.get_optimizer_cls_and_kwargs(args) Trainer.get_optimizer_cls_and_kwargs(args)
@ -4454,7 +4454,7 @@ class TrainerOptimizerChoiceTest(unittest.TestCase):
args = TrainingArguments(optim=OptimizerNames.PAGED_LION, output_dir="None") args = TrainingArguments(optim=OptimizerNames.PAGED_LION, output_dir="None")
# Pretend that bnb does not exist, even if installed. By setting bnb to None, importing # 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 patch.dict("sys.modules", {"bitsandbytes.optim": None}):
with self.assertRaises(ValueError): with self.assertRaises(ValueError):
Trainer.get_optimizer_cls_and_kwargs(args) 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") 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 # 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 patch.dict("sys.modules", {"bitsandbytes.optim": None}):
with self.assertRaises(ValueError): with self.assertRaises(ValueError):
Trainer.get_optimizer_cls_and_kwargs(args) Trainer.get_optimizer_cls_and_kwargs(args)