[DOCS] Add example for HammingDiversityLogitsProcessor #25481

jessthebp · 2023-08-13T05:26:57Z

What does this PR do?

Adds an example to the docstring of HammingDiversityLogitsProcessor class definition in this file.

Part of the docs work on Generate: have an example on each logits processor class docstring

Changes -

Added example
Added some more info about beam search and how hamming diversity works with it
Added warning/tip about resources

Happy to edit it all down a bit if it's too much stuff!

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.

Who can review?

@gante

…tyLogitsProcessor

…tyLogitsProcessor' into dev-documentation-HammingDiversityLogitsProcessor

jessthebp · 2023-08-14T18:51:52Z

@gante -- hey! Currently, the checks are failing because of some changes in the docs, but not sure if I can/should fix those-- using black, the files I've changed seem to be formatted correctly? Is there something I need to change in the docs to have this merge?

gante

Thank you for opening the PR! The descriptions are very thorough, I wish I had them when I first read about group beam search 🔥

I have two requests, before we merge the PR:

You should be able to fix the CI errors if you run make fixup in your terminal, commit the changes, and then push them :)
Although the example is good, it would be even better if it could be done entirely with generate calls, as opposed to with some group_beam_search calls! Most users stay at a generate level, so an example using generate is much more powerful 💪

…tyLogitsProcessor

jessthebp · 2023-08-18T16:02:39Z

@gante Fixes made! :)

gante

(the doc preview should work after correcting the syntax in the warning block)

src/transformers/generation/logits_process.py

examples/flax/text-classification/run_flax_glue.py

Co-authored-by: Joao Gante <[email protected]>

This reverts commit 4764308

HuggingFaceDocBuilderDev · 2023-08-22T07:09:31Z

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

gante

Awesome 🔥

There are two rendering nits that should be fixed, but other than that I'm happy with the PR. Thank you for documenting this complex logits processor! 💛

gante · 2023-08-22T15:39:54Z

src/transformers/generation/logits_process.py

+    Example: the below example shows a comparison before and after applying Hamming Diversity.
+
+    ```python
+            from transformers import AutoTokenizer, AutoModelForSeq2SeqLM


Final nit 1: let's remove indentation in the example, it shows up awkwardly in the rendered docs (see here the preview)

You also need to add >>> before the code as it is done for every other logit processor.

Examples: ```python >>> from transformers import AutoTokenizer, AutoModelForCausalLM

oh, yeah, and the missing >>> / ..., good catch!

gante · 2023-08-22T15:40:47Z

src/transformers/generation/logits_process.py

+                # summary 1:  the solar system formed 4.6 billion years ago from the collapse of a giant interstellar molecular cloud.
+                # summary 2:  the solar system formed 4.6 billion years ago from the collapse of a giant interstellar molecular cloud.
+    ```
+                For more details, see [Diverse Beam Search: Decoding Diverse Solutions from Neural Sequence


Final nit 2: let's move this to above the example, and decrease the indentation -- it is not rendering correctly (see here the preview)

Argh, sorry. Just autoaccepted the formatting suggestions from the CLI. I'll revert the weird/unnecessary changes + fix the formatting for the logits comment.

ArthurZucker

Thanks for working on this!

ArthurZucker · 2023-08-22T18:08:28Z

src/transformers/generation/logits_process.py

+    Example: the below example shows a comparison before and after applying Hamming Diversity.
+
+    ```python
+            from transformers import AutoTokenizer, AutoModelForSeq2SeqLM


You also need to add >>> before the code as it is done for every other logit processor.

Examples: ```python >>> from transformers import AutoTokenizer, AutoModelForCausalLM

src/transformers/generation/logits_process.py

src/transformers/models/llama/tokenization_llama_fast.py

docs/source/_config.py

This reverts commit bfb1536.

This reverts commit 4764308

This reverts commit ad6ceb6

This reverts commit ad6ceb6.

Co-authored-by: Arthur <[email protected]>

…tyLogitsProcessor' into dev-documentation-HammingDiversityLogitsProcessor # Conflicts: # src/transformers/generation/logits_process.py

This reverts commit 4764308

…tyLogitsProcessor

gante · 2023-08-25T11:35:46Z

@jesspeck thank for you iterating and thank you for the contribution 🤗

…5481) * updated logits processor text * Update logits_process.py * fixed formatting with black * fixed formatting with black * fixed formatting with Make Fixup * more formatting fixes * Update src/transformers/generation/logits_process.py Co-authored-by: Joao Gante <[email protected]> * Update src/transformers/generation/logits_process.py Co-authored-by: Joao Gante <[email protected]> * Revert "fixed formatting with Make Fixup" This reverts commit 4764308 * Revert "fixed formatting with black" This reverts commit bfb1536. * Revert "fixed formatting with Make Fixup" This reverts commit 4764308 * Revert "fixed formatting with Make Fixup" This reverts commit 4764308 * Revert "fixed formatting with black" This reverts commit ad6ceb6 * Revert "fixed formatting with black" This reverts commit ad6ceb6. * Update src/transformers/generation/logits_process.py Co-authored-by: Arthur <[email protected]> * Revert "fixed formatting with Make Fixup" This reverts commit 4764308 * formatted logits_process with make fixup --------- Co-authored-by: jesspeck <[email protected]> Co-authored-by: Joao Gante <[email protected]> Co-authored-by: Arthur <[email protected]>

jesspeck and others added 6 commits August 12, 2023 23:38

updated logits processor text

ab75556

Update logits_process.py

5f3eb85

Merge branch 'huggingface:main' into dev-documentation-HammingDiversi…

0b666a3

…tyLogitsProcessor

fixed formatting with black

ad6ceb6

Merge remote-tracking branch 'origin/dev-documentation-HammingDiversi…

f54e125

…tyLogitsProcessor' into dev-documentation-HammingDiversityLogitsProcessor

fixed formatting with black

bfb1536

gante reviewed Aug 17, 2023

View reviewed changes

jessthebp and others added 4 commits August 17, 2023 12:29

Merge branch 'huggingface:main' into dev-documentation-HammingDiversi…

5651226

…tyLogitsProcessor

fixed formatting with Make Fixup

4764308

Merge branch 'huggingface:main' into dev-documentation-HammingDiversi…

a9c5b32

…tyLogitsProcessor

more formatting fixes

c7a9ae8

gante reviewed Aug 21, 2023

View reviewed changes

src/transformers/generation/logits_process.py Outdated Show resolved Hide resolved

src/transformers/generation/logits_process.py Outdated Show resolved Hide resolved

examples/flax/text-classification/run_flax_glue.py Outdated Show resolved Hide resolved

jessthebp and others added 3 commits August 21, 2023 16:31

Update src/transformers/generation/logits_process.py

0b9528c

Co-authored-by: Joao Gante <[email protected]>

Update src/transformers/generation/logits_process.py

aa51216

Co-authored-by: Joao Gante <[email protected]>

Revert "fixed formatting with Make Fixup"

3584a53

This reverts commit 4764308

gante reviewed Aug 22, 2023

View reviewed changes

gante approved these changes Aug 22, 2023

View reviewed changes

gante requested a review from ArthurZucker August 22, 2023 15:42

ArthurZucker reviewed Aug 22, 2023

View reviewed changes

jesspeck and others added 8 commits August 23, 2023 11:39

Revert "fixed formatting with black"

8b50875

This reverts commit bfb1536.

Revert "fixed formatting with Make Fixup"

b11f536

This reverts commit 4764308

Revert "fixed formatting with Make Fixup"

a21a3ab

This reverts commit 4764308

Revert "fixed formatting with black"

aef619c

This reverts commit ad6ceb6

Revert "fixed formatting with black"

f6c301b

This reverts commit ad6ceb6.

Update src/transformers/generation/logits_process.py

d34c714

Co-authored-by: Arthur <[email protected]>

Merge remote-tracking branch 'origin/dev-documentation-HammingDiversi…

a29cbee

…tyLogitsProcessor' into dev-documentation-HammingDiversityLogitsProcessor # Conflicts: # src/transformers/generation/logits_process.py

Revert "fixed formatting with Make Fixup"

e252405

This reverts commit 4764308

jesspeck and others added 2 commits August 23, 2023 13:25

formatted logits_process with make fixup

33c682c

Merge branch 'huggingface:main' into dev-documentation-HammingDiversi…

ba56724

…tyLogitsProcessor

gante merged commit c6a84b7 into huggingface:main Aug 25, 2023

jessthebp deleted the dev-documentation-HammingDiversityLogitsProcessor branch August 25, 2023 13:20

[DOCS] Add example for HammingDiversityLogitsProcessor #25481

[DOCS] Add example for HammingDiversityLogitsProcessor #25481

Uh oh!

Conversation

jessthebp commented Aug 13, 2023

What does this PR do?

Before submitting

Who can review?

Uh oh!

jessthebp commented Aug 14, 2023

Uh oh!

gante left a comment

Choose a reason for hiding this comment

Uh oh!

jessthebp commented Aug 18, 2023

Uh oh!

gante left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

HuggingFaceDocBuilderDev commented Aug 22, 2023

Uh oh!

gante left a comment

Choose a reason for hiding this comment

Uh oh!

gante Aug 22, 2023

Choose a reason for hiding this comment

Uh oh!

ArthurZucker Aug 22, 2023

Choose a reason for hiding this comment

Uh oh!

gante Aug 22, 2023

Choose a reason for hiding this comment

Uh oh!

gante Aug 22, 2023

Choose a reason for hiding this comment

Uh oh!

jessthebp Aug 23, 2023

Choose a reason for hiding this comment

Uh oh!

ArthurZucker left a comment

Choose a reason for hiding this comment

Uh oh!

ArthurZucker Aug 22, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gante commented Aug 25, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants