TorchScript export in PyTorch

Introduction

TorchScript export lets you save your PyTorch model so it can run fast and work without Python. This helps when you want to use the model in apps or share it easily.

You want to run your PyTorch model on a device without Python installed.

You need to speed up model loading and inference in production.

You want to share your model with others who don't use Python.

You want to deploy your model in mobile or embedded systems.

You want to save a model with its computation graph for later use.

Syntax

PyTorch

import torch

# Convert a PyTorch model to TorchScript
scripted_model = torch.jit.script(your_model)

# Or trace the model with example input
scripted_model = torch.jit.trace(your_model, example_input)

# Save the scripted model
scripted_model.save('model_scripted.pt')

Use torch.jit.script when your model has control flow like if or loops.

Use torch.jit.trace when your model is mostly straight-line code and you have example inputs.

Examples

This converts the model using scripting, which analyzes the code including conditions and loops.

PyTorch

scripted_model = torch.jit.script(model)

This converts the model by tracing its operations with example input data.

PyTorch

scripted_model = torch.jit.trace(model, example_input)

This saves the TorchScript model to a file for later loading or deployment.

PyTorch

scripted_model.save('model_scripted.pt')

Sample Model

This example shows how to define a simple model with a condition, convert it to TorchScript using scripting, save it, load it back, and run inference.

PyTorch

import torch
import torch.nn as nn

# Define a simple model
class SimpleModel(nn.Module):
    def __init__(self):
        super().__init__()
        self.linear = nn.Linear(3, 1)
    def forward(self, x):
        if x.sum() > 0:
            return self.linear(x)
        else:
            return self.linear(-x)

model = SimpleModel()

# Create example input
example_input = torch.randn(1, 3)

# Convert model to TorchScript using scripting (because of if condition)
scripted_model = torch.jit.script(model)

# Save the scripted model
scripted_model.save('simple_model_scripted.pt')

# Load the model back
loaded_model = torch.jit.load('simple_model_scripted.pt')

# Run inference
output = loaded_model(example_input)
print(f'Input: {example_input}')
print(f'Output: {output}')

Important Notes

TorchScript models run faster because they are optimized and do not need Python at runtime.

Scripting supports more complex models with Python logic, while tracing is simpler but less flexible.

Always test the scripted or traced model to make sure it behaves like the original.

Summary

TorchScript export saves PyTorch models for fast, standalone use.

Use scripting for models with conditions and tracing for simple models.

Saved TorchScript models can be loaded and run without Python.

Practice

1. What is the main purpose of exporting a PyTorch model using TorchScript?

easy

A. To increase the training speed of the model

B. To save the model so it can run independently without Python

C. To convert the model into a TensorFlow format

D. To visualize the model architecture

Solution

1. Step 1: Understand TorchScript export purpose

   TorchScript export saves PyTorch models in a format that can run without Python, making deployment easier.

2. Step 2: Compare options with purpose

   Only To save the model so it can run independently without Python correctly states the main purpose: saving for standalone use without Python.

3. Final Answer:

   To save the model so it can run independently without Python -> Option B

4. Quick Check:

   TorchScript export = standalone model saving [OK]

Hint: TorchScript export = run model without Python [OK]

Common Mistakes:

• Thinking it speeds up training
• Confusing with TensorFlow conversion
• Assuming it is for visualization

2. Which of the following is the correct way to export a PyTorch model using scripting in TorchScript?

easy

A. torch.jit.trace(model, example_input)

B. torch.load('model.pt')

C. torch.save(model.state_dict(), 'model.pt')

D. torch.jit.script(model)

Solution

1. Step 1: Identify scripting syntax

   Using scripting to export a model requires torch.jit.script(model).

2. Step 2: Differentiate from tracing and saving

   torch.jit.trace(model, example_input) is tracing, torch.save(model.state_dict(), 'model.pt') saves weights only, torch.load('model.pt') loads a model, so only torch.jit.script(model) is correct for scripting export.

3. Final Answer:

   torch.jit.script(model) -> Option D

4. Quick Check:

   Scripting export uses torch.jit.script [OK]

Hint: Scripting export uses torch.jit.script(model) [OK]

Common Mistakes:

• Confusing scripting with tracing
• Using torch.save instead of torch.jit.script
• Trying to load instead of export

3. Given the code below, what will be the output of print(traced_model(torch.tensor([2.0])))?

import torch
class SimpleModel(torch.nn.Module):
    def forward(self, x):
        return x * 3

model = SimpleModel()
example_input = torch.tensor([1.0])
traced_model = torch.jit.trace(model, example_input)
print(traced_model(torch.tensor([2.0])))

medium

A. tensor([2.0])

B. tensor([3.0])

C. tensor([6.0])

D. RuntimeError

Solution

1. Step 1: Understand model behavior

   The model multiplies input by 3, so input 2.0 becomes 6.0.

2. Step 2: Check traced model output

   Tracing records the multiply by 3 operation, so traced_model(2.0) outputs tensor([6.0]).

3. Final Answer:

   tensor([6.0]) -> Option C

4. Quick Check:

   Input 2.0 * 3 = 6.0 [OK]

Hint: Model multiplies input by 3, so output is input*3 [OK]

Common Mistakes:

• Confusing input with output
• Expecting tracing to fail
• Thinking output is unchanged input

4. What is the error in the following code snippet when exporting a model with TorchScript scripting?

import torch
class MyModel(torch.nn.Module):
    def forward(self, x):
        if x.sum() > 0:
            return x * 2
        else:
            return x - 2

model = MyModel()
scripted_model = torch.jit.trace(model, torch.tensor([1.0]))

medium

A. Using torch.jit.trace instead of torch.jit.script for model with conditions

B. Missing example input tensor

C. Model class missing __init__ method

D. Incorrect tensor datatype

Solution

1. Step 1: Identify model features

   The model has a condition (if statement) in forward, which tracing cannot capture correctly.

2. Step 2: Understand TorchScript export methods

   Tracing works only for simple models without control flow; scripting is needed for conditions.

3. Final Answer:

   Using torch.jit.trace instead of torch.jit.script for model with conditions -> Option A

4. Quick Check:

   Model with conditions requires scripting, not tracing [OK]

Hint: Use scripting for models with if/else, not tracing [OK]

Common Mistakes:

• Using trace on models with control flow
• Assuming missing input tensor causes error
• Thinking __init__ is mandatory here

5. You want to export a PyTorch model that uses a loop and conditional statements inside its forward method. Which approach should you use to export it with TorchScript, and why?

hard

A. Use torch.jit.script because it supports control flow like loops and conditions

B. Use torch.jit.trace because it records operations for any model

C. Use torch.save to save the model weights only

D. Use torch.jit.trace with multiple example inputs to cover all paths

Solution

1. Step 1: Analyze model features

   The model has loops and conditions, which require TorchScript to understand control flow.

2. Step 2: Choose correct export method

   torch.jit.script compiles the model including control flow, while tracing cannot handle dynamic paths.

3. Final Answer:

   Use torch.jit.script because it supports control flow like loops and conditions -> Option A

4. Quick Check:

   Loops and conditions need scripting export [OK]

Hint: Loops and conditions require torch.jit.script export [OK]

Common Mistakes:

• Using tracing for models with dynamic control flow
• Saving weights only instead of full model
• Trying to cover all paths with tracing