Generate: move generation_.py src files into generation/.py #20096

gante · 2022-11-07T11:16:29Z

What does this PR do?

Moves generation_*.py source files into generation/*.py.

I tried a few slow tests locally, no problems were raised.

⚠️ the link to the docs seems broken, can't validate their correctness 🤔

HuggingFaceDocBuilderDev · 2022-11-07T12:23:24Z

The documentation is not available anymore as the PR was closed or merged.

gante · 2022-11-07T15:30:00Z

docs/source/de/pipeline_tutorial.mdx

@@ -56,7 +56,7 @@ Wenn Sie mehr als eine Eingabe haben, übergeben Sie die Eingabe als Liste:
 ... )  # doctest: +SKIP
 ```

-Alle zusätzlichen Parameter für Ihre Aufgabe können auch in die [`pipeline`] aufgenommen werden. Die Aufgabe `Text-Generierung` hat eine [`~generation_utils.GenerationMixin.generate`]-Methode mit mehreren Parametern zur Steuerung der Ausgabe. Wenn Sie zum Beispiel mehr als eine Ausgabe erzeugen wollen, setzen Sie den Parameter `num_return_sequences`:
+Alle zusätzlichen Parameter für Ihre Aufgabe können auch in die [`pipeline`] aufgenommen werden. Die Aufgabe `Text-Generierung` hat eine [`~generation.utils.GenerationMixin.generate`]-Methode mit mehreren Parametern zur Steuerung der Ausgabe. Wenn Sie zum Beispiel mehr als eine Ausgabe erzeugen wollen, setzen Sie den Parameter `num_return_sequences`:


Note: these changes were mass made with generation_X -> generation.X, X being the name of the moved files (with light manual checking before committing the changes)

gante · 2022-11-07T15:34:08Z

src/transformers/generation/flax_utils.py

@@ -0,0 +1,947 @@
+# coding=utf-8


(No changes in this file, wasn't tagged as moved because of the new Mixin alias left in the original file. The same comment applies to the PT and TF changes)

gante · 2022-11-07T15:38:17Z

src/transformers/generation_flax_utils.py

+class FlaxGenerationMixin(FlaxGenerationMixin):
+    # warning at import time
+    warnings.warn(
+        "Importing `FlaxGenerationMixin` from `src/transformers/generation_flax_utils.py` is deprecated and will "
+        "be removed in Transformers v5. Import from `src/transformers/generation/flax_utils.py` instead.",
+        FutureWarning,
+    )


Our deprecation warnings typically go in __init__() (example). However, the generation mixins have no __init__() -- as it stands, the warning is printed at import time.

gante · 2022-11-07T15:39:03Z

utils/documentation_tests.txt

@@ -11,7 +11,8 @@ docs/source/en/model_doc/byt5.mdx
 docs/source/en/model_doc/tapex.mdx
 docs/source/en/model_doc/donut.mdx
 docs/source/en/model_doc/encoder-decoder.mdx
-src/transformers/generation_utils.py
+src/transformers/generation/utils.py
+src/transformers/generation/tf_utils.py


Sneakily added this one 👼

sgugger

Looking at the changes, would be great to see all imports move to a simple from .generation import Xxx. What do you think?

sgugger · 2022-11-07T16:56:04Z

src/transformers/generation/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2022 The HuggingFace Team. All rights reserved.


It's a bit sad to have an empty init here. Would probably will make it easier for users to have everything importable in this submodule directly? That would just quire building this init like the main init of the models init.

Sounds good 👍

patrickvonplaten

Thanks!

…object

gante · 2022-11-08T12:41:04Z

@sgugger now with ~/generation/__init__.py populated with lazy references (as in most __init__.py files).

I've updated all references to objects outside /generation from generation.file_name.ObjectName to generation.ObjectName, including in the docs. That does make tracking external references easier -- if an object is in ~/generation/__init__.py it means that it is likely used somewhere else, and should be treated with extra care.

sgugger

New init is looking great! Can you jsut track all the generation.xxx to just abbreviate them into generation?

sgugger · 2022-11-08T15:01:35Z

docs/source/en/internal/generation_utils.mdx

-[`~generation_utils.GenerationMixin.beam_sample`],
-[`~generation_utils.GenerationMixin.group_beam_search`], and
-[`~generation_utils.GenerationMixin.constrained_beam_search`].
+This page lists all the utility functions used by [`~generation.utils.GenerationMixin.generate`],


Can we use generation everywhere generation.utils is used?

sgugger

Nice refactor!

…gface#20096) * move generation_*.py src files into generation/*.py * populate generation.__init__ with lazy loading * move imports and references from generation.xxx.object to generation.object

evrial · 2022-12-02T11:45:26Z

Could you please update optimum to reflect these changes?

from optimum.onnxruntime import ORTModelForSeq2SeqLM
site-packages/transformers/generation_utils.py:27: FutureWarning: Importing `GenerationMixin` from `src/transformers/generation_utils.py` is deprecated and will be removed in Transformers v5. Import as `from transformers import GenerationMixin` instead.
  FutureWarning,

regisss · 2022-12-02T16:41:56Z

Could you please update optimum to reflect these changes?

from optimum.onnxruntime import ORTModelForSeq2SeqLM
site-packages/transformers/generation_utils.py:27: FutureWarning: Importing `GenerationMixin` from `src/transformers/generation_utils.py` is deprecated and will be removed in Transformers v5. Import as `from transformers import GenerationMixin` instead.
  FutureWarning,

The PR huggingface/optimum#536 has just been merged and solves this issue.

…gface#20096) * move generation_*.py src files into generation/*.py * populate generation.__init__ with lazy loading * move imports and references from generation.xxx.object to generation.object

gante added 4 commits November 7, 2022 12:09

move generation_*.py src files into generation/*.py

bfd67b5

reintegrate changes from tf contrastive search PR

ae426a7

make style

28e8705

make style again

2677903

gante force-pushed the separate_generate_folders branch from c90ad80 to 2677903 Compare November 7, 2022 12:10

gante marked this pull request as ready for review November 7, 2022 15:22

gante commented Nov 7, 2022

View reviewed changes

typo

3e2dc8e

gante commented Nov 7, 2022

View reviewed changes

gante added 3 commits November 7, 2022 15:44

Manual check

4154bd0

better deprecation message

5298da5

typo

b76ad09

gante requested review from sgugger and patrickvonplaten November 7, 2022 16:52

sgugger reviewed Nov 7, 2022

View reviewed changes

patrickvonplaten approved these changes Nov 8, 2022

View reviewed changes

gante added 2 commits November 8, 2022 11:24

populate generation.__init__ with lazy loading

425150b

move imports and references from generation.xxx.object to generation.…

0243a9c

…object

sgugger reviewed Nov 8, 2022

View reviewed changes

forgot this one >:(

66e0972

sgugger approved these changes Nov 9, 2022

View reviewed changes

gante merged commit f270b96 into huggingface:main Nov 9, 2022

gante deleted the separate_generate_folders branch November 9, 2022 15:39

regisss mentioned this pull request Dec 2, 2022

Import GenerationMixin from transformers.generation if transformers >= 4.25.0 huggingface/optimum#536

Merged

3 tasks

gante mentioned this pull request Jan 19, 2024

Generate: deprecate old src imports #28607

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate: move generation_.py src files into generation/.py #20096

Generate: move generation_.py src files into generation/.py #20096

gante commented Nov 7, 2022 •

edited

Loading

HuggingFaceDocBuilderDev commented Nov 7, 2022 •

edited

Loading

gante Nov 7, 2022

gante Nov 7, 2022

gante Nov 7, 2022

gante Nov 7, 2022

sgugger left a comment

sgugger Nov 7, 2022

gante Nov 7, 2022

patrickvonplaten left a comment

gante commented Nov 8, 2022

sgugger left a comment

sgugger Nov 8, 2022

sgugger left a comment

evrial commented Dec 2, 2022 •

edited

Loading

regisss commented Dec 2, 2022

		@@ -0,0 +1,13 @@
		# Copyright 2022 The HuggingFace Team. All rights reserved.

Generate: move generation_*.py src files into generation/*.py #20096

Generate: move generation_*.py src files into generation/*.py #20096

Conversation

gante commented Nov 7, 2022 • edited Loading

What does this PR do?

HuggingFaceDocBuilderDev commented Nov 7, 2022 • edited Loading

gante Nov 7, 2022

Choose a reason for hiding this comment

gante Nov 7, 2022

Choose a reason for hiding this comment

gante Nov 7, 2022

Choose a reason for hiding this comment

gante Nov 7, 2022

Choose a reason for hiding this comment

sgugger left a comment

Choose a reason for hiding this comment

sgugger Nov 7, 2022

Choose a reason for hiding this comment

gante Nov 7, 2022

Choose a reason for hiding this comment

patrickvonplaten left a comment

Choose a reason for hiding this comment

gante commented Nov 8, 2022

sgugger left a comment

Choose a reason for hiding this comment

sgugger Nov 8, 2022

Choose a reason for hiding this comment

sgugger left a comment

Choose a reason for hiding this comment

evrial commented Dec 2, 2022 • edited Loading

regisss commented Dec 2, 2022

Generate: move generation_.py src files into generation/.py #20096

Generate: move generation_.py src files into generation/.py #20096

gante commented Nov 7, 2022 •

edited

Loading

HuggingFaceDocBuilderDev commented Nov 7, 2022 •

edited

Loading

evrial commented Dec 2, 2022 •

edited

Loading