mirror of
https://github.com/huggingface/transformers.git
synced 2025-07-08 07:10:06 +06:00

* add: the contrastive search for generaton_utils * add: testing scripts for contrastive search under examples/text-generation * update the quality of codes * revise the docstring; make the generation_contrastive_search.py scripts; * revise the examples/pytorch/text-generation/run_generation_contrastive_search.py to the auto-APIs format * revise the necessary documents * fix: revise the docstring of generation_contrastive_search.py * Fix the code indentation * fix: revise the nits and examples in contrastive_search docstring. * fix the copyright * delete generation_contrastive_search.py * revise the logic in contrastive_search * update the intergration test and the docstring * run the tests over * add the slow decorate to the contrastive_search intergrate test * add more test * do the style, quality, consistency checks
42 lines
1.5 KiB
Plaintext
42 lines
1.5 KiB
Plaintext
<!--Copyright 2022 The HuggingFace Team. All rights reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
|
|
the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
|
|
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
|
|
specific language governing permissions and limitations under the License.
|
|
-->
|
|
|
|
# Generation
|
|
|
|
Each framework has a generate method for auto-regressive text generation implemented in their respective `GenerationMixin` class:
|
|
|
|
- PyTorch [`~generation_utils.GenerationMixin.generate`] is implemented in [`~generation_utils.GenerationMixin`].
|
|
- TensorFlow [`~generation_tf_utils.TFGenerationMixin.generate`] is implemented in [`~generation_tf_utils.TFGenerationMixin`].
|
|
- Flax/JAX [`~generation_flax_utils.FlaxGenerationMixin.generate`] is implemented in [`~generation_flax_utils.FlaxGenerationMixin`].
|
|
|
|
## GenerationMixin
|
|
|
|
[[autodoc]] generation_utils.GenerationMixin
|
|
- generate
|
|
- greedy_search
|
|
- sample
|
|
- beam_search
|
|
- beam_sample
|
|
- contrastive_search
|
|
- group_beam_search
|
|
- constrained_beam_search
|
|
|
|
## TFGenerationMixin
|
|
|
|
[[autodoc]] generation_tf_utils.TFGenerationMixin
|
|
- generate
|
|
|
|
## FlaxGenerationMixin
|
|
|
|
[[autodoc]] generation_flax_utils.FlaxGenerationMixin
|
|
- generate
|