
.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "tutorials/_rendered_examples/dynamo/torch_compile_gpt2.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_tutorials__rendered_examples_dynamo_torch_compile_gpt2.py>`
        to download the full example code

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_tutorials__rendered_examples_dynamo_torch_compile_gpt2.py:


.. _torch_compile_gpt2:

Compiling GPT2 using the Torch-TensorRT ``torch.compile`` frontend
==========================================================

This example illustrates the state of the art model `GPT2 <https://cdn.openai.com/better-language-models/language_models_are_unsupervised_multitask_learners.pdf>`_ optimized using
``torch.compile`` frontend of Torch-TensorRT. Install the following dependencies before compilation

.. code-block:: python

    pip install -r requirements.txt

GPT2 is a causal (unidirectional) transformer pretrained using language modeling on a very large corpus of text data. In this example, we use the GPT2 model available at `HuggingFace <https://huggingface.co/docs/transformers/en/model_doc/gpt2>`_ and apply torch.compile on it to
get the graph module representation of the graph. Torch-TensorRT converts this graph into an optimized TensorRT engine.

.. GENERATED FROM PYTHON SOURCE LINES 19-21

Import necessary libraries
-----------------------------

.. GENERATED FROM PYTHON SOURCE LINES 21-25

.. code-block:: python

    import torch
    import torch_tensorrt
    from transformers import AutoModelForCausalLM, AutoTokenizer


.. GENERATED FROM PYTHON SOURCE LINES 26-31

Define the necessary parameters
-----------------------------
Torch-TensorRT requires a GPU for successful compilation of the model.
``MAX_LENGTH`` is the maximum length the generated tokens can have. This corresponds to the length of the input prompt +
number of new tokens generated

.. GENERATED FROM PYTHON SOURCE LINES 31-34

.. code-block:: python

    MAX_LENGTH = 32
    DEVICE = torch.device("cuda:0")


.. GENERATED FROM PYTHON SOURCE LINES 35-38

Model definition
-----------------------------
We use ``AutoModelForCausalLM`` class to load the pretrained GPT2 model from hugging face. ``kv_cache`` is not supported in Torch-TRT currently so ``use_cache=False``

.. GENERATED FROM PYTHON SOURCE LINES 38-51

.. code-block:: python

    with torch.no_grad():
        tokenizer = AutoTokenizer.from_pretrained("gpt2")
        model = (
            AutoModelForCausalLM.from_pretrained(
                "gpt2",
                pad_token_id=tokenizer.eos_token_id,
                use_cache=False,
                attn_implementation="eager",
            )
            .eval()
            .cuda()
        )


.. GENERATED FROM PYTHON SOURCE LINES 52-55

PyTorch inference
-----------------------------
Tokenize a sample input prompt and get pytorch model outputs

.. GENERATED FROM PYTHON SOURCE LINES 55-59

.. code-block:: python

    prompt = "I enjoy walking with my cute dog"
    model_inputs = tokenizer(prompt, return_tensors="pt")
    input_ids = model_inputs["input_ids"].cuda()


.. GENERATED FROM PYTHON SOURCE LINES 60-61

The ``generate()`` API of the ``AutoModelForCausalLM`` class is used for auto-regressive generation with greedy decoding.

.. GENERATED FROM PYTHON SOURCE LINES 61-68

.. code-block:: python

    pyt_gen_tokens = model.generate(
        input_ids,
        max_length=MAX_LENGTH,
        use_cache=False,
        pad_token_id=tokenizer.eos_token_id,
    )


.. GENERATED FROM PYTHON SOURCE LINES 69-74

Torch-TensorRT compilation and inference
-----------------------------
The input sequence length is dynamic, so we mark it using ``torch._dynamo.mark_dynamic`` API.
We provide a (min, max) range of this value so that TensorRT knows in advance what values to optimize for.
Usually, this would be the context length for the model. We start with ``min=2`` due to the `0/1 specialization <https://docs.google.com/document/d/16VPOa3d-Liikf48teAOmxLc92rgvJdfosIy-yoT38Io/edit?fbclid=IwAR3HNwmmexcitV0pbZm_x1a4ykdXZ9th_eJWK-3hBtVgKnrkmemz6Pm5jRQ&tab=t.0#heading=h.ez923tomjvyk>`_

.. GENERATED FROM PYTHON SOURCE LINES 74-86

.. code-block:: python

    torch._dynamo.mark_dynamic(input_ids, 1, min=2, max=1023)
    model.forward = torch.compile(
        model.forward,
        backend="tensorrt",
        dynamic=None,
        options={
            "enabled_precisions": {torch.float32},
            "disable_tf32": True,
            "min_block_size": 1,
        },
    )


.. GENERATED FROM PYTHON SOURCE LINES 87-90

Auto-regressive generation loop for greedy decoding using TensorRT model
The first token generation compiles the model using TensorRT and the second token
encounters recompilation (which is an issue currently that would be resolved in the future)

.. GENERATED FROM PYTHON SOURCE LINES 90-97

.. code-block:: python

    trt_gen_tokens = model.generate(
        inputs=input_ids,
        max_length=MAX_LENGTH,
        use_cache=False,
        pad_token_id=tokenizer.eos_token_id,
    )


.. GENERATED FROM PYTHON SOURCE LINES 98-100

Decode the output sentences of PyTorch and TensorRT
-----------------------------

.. GENERATED FROM PYTHON SOURCE LINES 100-110

.. code-block:: python

    print(
        "Pytorch model generated text: ",
        tokenizer.decode(pyt_gen_tokens[0], skip_special_tokens=True),
    )
    print("=============================")
    print(
        "TensorRT model generated text: ",
        tokenizer.decode(trt_gen_tokens[0], skip_special_tokens=True),
    )


.. GENERATED FROM PYTHON SOURCE LINES 111-112

The output sentences should look like

.. GENERATED FROM PYTHON SOURCE LINES 112-118

.. code-block:: python


    """
    Pytorch model generated text:  I enjoy walking with my cute dog, but I'm not sure if I'll ever be able to walk with my dog. I'm not sure if I'll
    =============================
    TensorRT model generated text:  I enjoy walking with my cute dog, but I'm not sure if I'll ever be able to walk with my dog. I'm not sure if I'll
    """


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** ( 0 minutes  0.000 seconds)


.. _sphx_glr_download_tutorials__rendered_examples_dynamo_torch_compile_gpt2.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example




    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: torch_compile_gpt2.py <torch_compile_gpt2.py>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: torch_compile_gpt2.ipynb <torch_compile_gpt2.ipynb>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_
