Fixed Majority of the Typos in `transformers[en]` Documentation #33350

nnilayy · 2024-09-06T10:42:33Z

What does this PR do?

Fixes #33349
This PR fixes majority of the typos in the docs folder for transformers[en] documentation.

Before submitting

This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
Did you read the contributor guideline,
Pull Request section?
Was this discussed/approved via a Github issue or the forum? Please add a link
to it if that's the case.
Did you make sure to update the documentation with your changes? Here are the
documentation guidelines, and
here are tips on formatting docstrings.
Did you write any new necessary tests?

Who can review?

CC: @stevhliu 🤗

…rk, benchmarks

…etForMultipleChoice

…ents

…bertForCausalLM

…ast_hidden_state

…hmark

LysandreJik

That's a lot of typo fixes, thanks!

LysandreJik · 2024-09-06T20:45:04Z

docs/source/en/main_classes/logging.md

@@ -30,7 +30,7 @@ transformers.logging.set_verbosity_info()
 ```

 You can also use the environment variable `TRANSFORMERS_VERBOSITY` to override the default verbosity. You can set it
-to one of the following: `debug`, `info`, `warning`, `error`, `critical`. For example:
+to one of the following: `debug`, `info`, `warning`, `error`, `critical`, `fatal`. For example:


I don't think we have fatal, where is this coming from?

transformers/src/transformers/utils/logging.py

Lines 168 to 178 in a70286f

<Tip>

🤗 Transformers has following logging levels:

- 50: `transformers.logging.CRITICAL` or `transformers.logging.FATAL`

- 40: `transformers.logging.ERROR`

- 30: `transformers.logging.WARNING` or `transformers.logging.WARN`

- 20: `transformers.logging.INFO`

- 10: `transformers.logging.DEBUG`

</Tip>"""

I referenced the above code file to include fatal as an addition in the docs and currently using transformers-4.44.2 in a Kaggle Notebook, I am able to generate logs with logger.fatal("FATAL").

Is there any plan to deprecate this functionality? If not, then I apologize for the confusion, I didnt see that critical and fatal have the same logging level and the fixed commit should have been:
debug, info, warning, error, critical/fatal

If fatal is going to be deprecated, i'll update the PR and remove it, If not i'll make the change as mentioned above. Do let me know if it's either of the case. Thanks for Reviewing 🤗.

No worries, let's keep it like that in the meantime

LysandreJik · 2024-09-06T20:46:34Z

docs/source/en/peft.md

@@ -125,7 +125,7 @@ Now you can use [`~peft.PeftModel.set_adapter`] to set which adapter to use:
 ```py
 # use adapter_1
 model.set_adapter("adapter_1")
-output = model.generate(**inputs)
+output_disabled = model.generate(**inputs)


Are you sure about this one?

transformers/docs/source/en/peft.md

Lines 126 to 134 in a70286f

# use adapter_1

model.set_adapter("adapter_1")

output = model.generate(**inputs)

print(tokenizer.decode(output_disabled[0], skip_special_tokens=True))

# use adapter_2

model.set_adapter("adapter_2")

output_enabled = model.generate(**inputs)

print(tokenizer.decode(output_enabled[0], skip_special_tokens=True))

Yup, in here output_disabled[0] has been referenced but never declared in the file, and looking at the code below using pretty much the same code block for output_enabled, I assume its a typo, where output should have been output_disabled.

Awesome, you're a great proofreader 🤗 thanks @nnilayy!

…ingface#33350) * Fixed typo: insted to instead * Fixed typo: relase to release * Fixed typo: nighlty to nightly * Fixed typos: versatible, benchamarks, becnhmark to versatile, benchmark, benchmarks * Fixed typo in comment: quantizd to quantized * Fixed typo: architecutre to architecture * Fixed typo: contibution to contribution * Fixed typo: Presequities to Prerequisites * Fixed typo: faste to faster * Fixed typo: extendeding to extending * Fixed typo: segmetantion_maps to segmentation_maps * Fixed typo: Alternativelly to Alternatively * Fixed incorrectly defined variable: output to output_disabled * Fixed typo in library name: tranformers.onnx to transformers.onnx * Fixed missing import: import tensorflow as tf * Fixed incorrectly defined variable: token_tensor to tokens_tensor * Fixed missing import: import torch * Fixed incorrectly defined variable and typo: uromaize to uromanize * Fixed incorrectly defined variable and typo: uromaize to uromanize * Fixed typo in function args: numpy.ndarry to numpy.ndarray * Fixed Inconsistent Library Name: Torchscript to TorchScript * Fixed Inconsistent Class Name: OneformerProcessor to OneFormerProcessor * Fixed Inconsistent Class Named Typo: TFLNetForMultipleChoice to TFXLNetForMultipleChoice * Fixed Inconsistent Library Name Typo: Pytorch to PyTorch * Fixed Inconsistent Function Name Typo: captureWarning to captureWarnings * Fixed Inconsistent Library Name Typo: Pytorch to PyTorch * Fixed Inconsistent Class Name Typo: TrainingArgument to TrainingArguments * Fixed Inconsistent Model Name Typo: Swin2R to Swin2SR * Fixed Inconsistent Model Name Typo: EART to BERT * Fixed Inconsistent Library Name Typo: TensorFLow to TensorFlow * Fixed Broken Link for Speech Emotion Classification with Wav2Vec2 * Fixed minor missing word Typo * Fixed minor missing word Typo * Fixed minor missing word Typo * Fixed minor missing word Typo * Fixed minor missing word Typo * Fixed minor missing word Typo * Fixed minor missing word Typo * Fixed minor missing word Typo * Fixed Punctuation: Two commas * Fixed Punctuation: No Space between XLM-R and is * Fixed Punctuation: No Space between [~accelerate.Accelerator.backward] and method * Added backticks to display model.fit() in codeblock * Added backticks to display openai-community/gpt2 in codeblock * Fixed Minor Typo: will to with * Fixed Minor Typo: is to are * Fixed Minor Typo: in to on * Fixed Minor Typo: inhibits to exhibits * Fixed Minor Typo: they need to it needs * Fixed Minor Typo: cast the load the checkpoints To load the checkpoints * Fixed Inconsistent Class Name Typo: TFCamembertForCasualLM to TFCamembertForCausalLM * Fixed typo in attribute name: outputs.last_hidden_states to outputs.last_hidden_state * Added missing verbosity level: fatal * Fixed Minor Typo: take To takes * Fixed Minor Typo: heuristic To heuristics * Fixed Minor Typo: setting To settings * Fixed Minor Typo: Content To Contents * Fixed Minor Typo: millions To million * Fixed Minor Typo: difference To differences * Fixed Minor Typo: while extract To which extracts * Fixed Minor Typo: Hereby To Here * Fixed Minor Typo: addition To additional * Fixed Minor Typo: supports To supported * Fixed Minor Typo: so that benchmark results TO as a consequence, benchmark * Fixed Minor Typo: a To an * Fixed Minor Typo: a To an * Fixed Minor Typo: Chain-of-though To Chain-of-thought

nnilayy added 30 commits September 6, 2024 01:19

Fixed typo: insted to instead

db43182

Fixed typo: relase to release

a92e09d

Fixed typo: nighlty to nightly

35dff74

Fixed typos: versatible, benchamarks, becnhmark to versatile, benchma…

413e90f

…rk, benchmarks

Fixed typo in comment: quantizd to quantized

385eb5e

Fixed typo: architecutre to architecture

e805d0a

Fixed typo: contibution to contribution

cf1bcdb

Fixed typo: Presequities to Prerequisites

14789c9

Fixed typo: faste to faster

893830a

Fixed typo: extendeding to extending

2c72345

Fixed typo: segmetantion_maps to segmentation_maps

60ab41d

Fixed typo: Alternativelly to Alternatively

a30d7ef

Fixed incorrectly defined variable: output to output_disabled

875e301

Fixed typo in library name: tranformers.onnx to transformers.onnx

b7e5afc

Fixed missing import: import tensorflow as tf

a4ee0b0

Fixed incorrectly defined variable: token_tensor to tokens_tensor

25557e0

Fixed missing import: import torch

6a33bfa

Fixed incorrectly defined variable and typo: uromaize to uromanize

a550e25

Fixed incorrectly defined variable and typo: uromaize to uromanize

7d78acc

Fixed typo in function args: numpy.ndarry to numpy.ndarray

171ec0f

Fixed Inconsistent Library Name: Torchscript to TorchScript

b490ab2

Fixed Inconsistent Class Name: OneformerProcessor to OneFormerProcessor

cd6de70

Fixed Inconsistent Class Named Typo: TFLNetForMultipleChoice to TFXLN…

efaf2f7

…etForMultipleChoice

Fixed Inconsistent Library Name Typo: Pytorch to PyTorch

7937754

Fixed Inconsistent Function Name Typo: captureWarning to captureWarnings

cab50dd

Fixed Inconsistent Library Name Typo: Pytorch to PyTorch

807ec88

Fixed Inconsistent Class Name Typo: TrainingArgument to TrainingArgum…

5cd0fc7

…ents

Fixed Inconsistent Model Name Typo: Swin2R to Swin2SR

0a5664b

Fixed Inconsistent Model Name Typo: EART to BERT

0069830

Fixed Inconsistent Library Name Typo: TensorFLow to TensorFlow

c84b558

nnilayy added 20 commits September 6, 2024 03:47

Fixed Minor Typo: inhibits to exhibits

aa5c222

Fixed Minor Typo: they need to it needs

4494d66

Fixed Minor Typo: cast the load the checkpoints To load the checkpoints

c58d434

Fixed Inconsistent Class Name Typo: TFCamembertForCasualLM to TFCamem…

331072e

…bertForCausalLM

Fixed typo in attribute name: outputs.last_hidden_states to outputs.l…

e2a4bef

…ast_hidden_state

Added missing verbosity level: fatal

034a363

Fixed Minor Typo: take To takes

7dcc449

Fixed Minor Typo: heuristic To heuristics

15f3493

Fixed Minor Typo: setting To settings

ae84a54

Fixed Minor Typo: Content To Contents

12ff57e

Fixed Minor Typo: millions To million

2328c7f

Fixed Minor Typo: difference To differences

69c90f1

Fixed Minor Typo: while extract To which extracts

d0b6d55

Fixed Minor Typo: Hereby To Here

f7b1cdf

Fixed Minor Typo: addition To additional

f18445a

Fixed Minor Typo: supports To supported

e699ef3

Fixed Minor Typo: so that benchmark results TO as a consequence, benc…

93ef9aa

…hmark

Fixed Minor Typo: a To an

973d029

Fixed Minor Typo: a To an

1e16f74

Fixed Minor Typo: Chain-of-though To Chain-of-thought

a4564cb

nnilayy changed the title ~~Fixed Majority of the Typos in transformers[EN] Documentation~~ Fixed Majority of the Typos in transformers[en] Documentation Sep 6, 2024

nnilayy force-pushed the main branch 4 times, most recently from e3665de to a4564cb Compare September 6, 2024 13:51

LysandreJik approved these changes Sep 6, 2024

View reviewed changes

LysandreJik merged commit eedd21b into huggingface:main Sep 9, 2024
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed Majority of the Typos in `transformers[en]` Documentation #33350

Fixed Majority of the Typos in `transformers[en]` Documentation #33350

nnilayy commented Sep 6, 2024

LysandreJik left a comment

LysandreJik Sep 6, 2024

nnilayy Sep 6, 2024 •

edited

Loading

LysandreJik Sep 9, 2024

LysandreJik Sep 6, 2024

nnilayy Sep 6, 2024 •

edited

Loading

LysandreJik Sep 9, 2024

	<Tip>

	🤗 Transformers has following logging levels:

	- 50: `transformers.logging.CRITICAL` or `transformers.logging.FATAL`
	- 40: `transformers.logging.ERROR`
	- 30: `transformers.logging.WARNING` or `transformers.logging.WARN`
	- 20: `transformers.logging.INFO`
	- 10: `transformers.logging.DEBUG`

	</Tip>"""

	# use adapter_1
	model.set_adapter("adapter_1")
	output = model.generate(**inputs)
	print(tokenizer.decode(output_disabled[0], skip_special_tokens=True))

	# use adapter_2
	model.set_adapter("adapter_2")
	output_enabled = model.generate(**inputs)
	print(tokenizer.decode(output_enabled[0], skip_special_tokens=True))

Fixed Majority of the Typos in transformers[en] Documentation #33350

Fixed Majority of the Typos in transformers[en] Documentation #33350

Conversation

nnilayy commented Sep 6, 2024

What does this PR do?

Before submitting

Who can review?

LysandreJik left a comment

Choose a reason for hiding this comment

LysandreJik Sep 6, 2024

Choose a reason for hiding this comment

nnilayy Sep 6, 2024 • edited Loading

Choose a reason for hiding this comment

LysandreJik Sep 9, 2024

Choose a reason for hiding this comment

LysandreJik Sep 6, 2024

Choose a reason for hiding this comment

nnilayy Sep 6, 2024 • edited Loading

Choose a reason for hiding this comment

LysandreJik Sep 9, 2024

Choose a reason for hiding this comment

Fixed Majority of the Typos in `transformers[en]` Documentation #33350

Fixed Majority of the Typos in `transformers[en]` Documentation #33350

nnilayy Sep 6, 2024 •

edited

Loading

nnilayy Sep 6, 2024 •

edited

Loading