TorchScript for production in PyTorch

Introduction

TorchScript helps you turn PyTorch models into a form that runs fast and works well in real apps.

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

You need faster model execution for real-time predictions.

You want to share your model with others without sharing Python code.

You want to deploy your model on mobile devices or embedded systems.

You want to save your model in a format that is easy to load and run anywhere.

Syntax

PyTorch

import torch

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

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

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

# Use the loaded model for prediction
output = loaded_model(input_tensor)

torch.jit.script converts your model to TorchScript by analyzing the code.

You can save and load the scripted model easily for production use.

Examples

This example shows a simple model doubled input, then scripted and run.

PyTorch

import torch
import torch.nn as nn

class SimpleModel(nn.Module):
    def forward(self, x):
        return x * 2

model = SimpleModel()
scripted = torch.jit.script(model)
print(scripted(torch.tensor(3)))

Tracing records operations from example input, useful for simple models.

PyTorch

import torch

# Using tracing instead of scripting
model = torch.nn.ReLU()
example_input = torch.randn(1)
traced_model = torch.jit.trace(model, example_input)
print(traced_model(torch.tensor([-1.0])))

Sample Model

This program creates a simple model, converts it to TorchScript, saves and loads it, then runs a prediction.

PyTorch

import torch
import torch.nn as nn

# Define a simple model
class MyModel(nn.Module):
    def forward(self, x):
        return x * 3 + 1

# Create model instance
model = MyModel()

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

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

# Load the scripted model
loaded_model = torch.jit.load('mymodel.pt')

# Test input
input_tensor = torch.tensor(4)

# Get output from loaded model
output = loaded_model(input_tensor)
print(f'Output: {output.item()}')

Important Notes

TorchScript models run faster and can be used without Python.

Use scripting for models with control flow; use tracing for simple, straight-line models.

Always test the scripted model to ensure it behaves like the original.

Summary

TorchScript converts PyTorch models for fast, production-ready use.

You can save and load TorchScript models easily.

Use scripting or tracing depending on your model's complexity.

Practice

1. What is the main purpose of using TorchScript in PyTorch?

easy

A. To increase the size of the model for better accuracy

B. To visualize model training progress

C. To convert PyTorch models into a format optimized for production use

D. To automatically generate training data

Solution

1. Step 1: Understand TorchScript's role

   TorchScript is designed to convert PyTorch models into a form that can run faster and be deployed easily in production environments.

2. Step 2: Compare options

   Options A, B, and D describe unrelated tasks like visualization, model size increase, or data generation, which are not the purpose of TorchScript.

3. Final Answer:

   To convert PyTorch models into a format optimized for production use -> Option C

4. Quick Check:

   TorchScript purpose = convert for production [OK]

Hint: TorchScript = production-ready model format [OK]

Common Mistakes:

• Confusing TorchScript with visualization tools
• Thinking TorchScript generates data
• Assuming TorchScript increases model size

2. Which of the following is the correct way to save a TorchScript model after scripting?

easy

A. torch.save(model, 'model.pt')

B. torchscript.save_model(model, 'model.pt')

C. model.save('model.pt')

D. scripted_model.save('model.pt')

Solution

1. Step 1: Recall TorchScript saving method

   After scripting a model, the resulting scripted model object has a save() method to save it to disk.

2. Step 2: Evaluate options

   torch.save(model, 'model.pt') uses torch.save which is for regular PyTorch models, not scripted ones. model.save('model.pt') is invalid as model.save() does not exist. torchscript.save_model(model, 'model.pt') is not a valid PyTorch API.

3. Final Answer:

   scripted_model.save('model.pt') -> Option D

4. Quick Check:

   Use scripted_model.save() to save TorchScript [OK]

Hint: Use scripted_model.save() to save TorchScript models [OK]

Common Mistakes:

• Using torch.save() instead of scripted_model.save()
• Calling save() on the original model
• Assuming torchscript.save_model() exists

3. Given the code below, what will be the output printed?

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

model = MyModule()
scripted = torch.jit.script(model)
print(scripted(torch.tensor(3)))

medium

A. tensor(6)

B. tensor(3)

C. 6

D. Error: scripting failed

Solution

1. Step 1: Understand the model's forward method

   The model multiplies input by 2, so input 3 becomes 6.

2. Step 2: Check scripting and output

   The model is scripted successfully, so calling scripted(torch.tensor(3)) returns tensor(6).

3. Final Answer:

   tensor(6) -> Option A

4. Quick Check:

   Input 3 * 2 = tensor(6) [OK]

Hint: Model doubles input; output = input * 2 [OK]

Common Mistakes:

• Confusing tensor(6) with integer 6
• Expecting error from scripting simple model
• Ignoring tensor wrapper in output

4. What is the error in the following code snippet when trying to trace a model?

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

model = MyModel()
example_input = torch.tensor([1.0, -1.0])
traced = torch.jit.trace(model, example_input)

medium

A. Syntax error in model definition

B. Tracing fails because the model has data-dependent control flow

C. example_input must be a scalar tensor

D. No error, tracing works fine

Solution

1. Step 1: Identify model control flow

   The model uses an if-statement depending on input data (x.sum() > 0), which is data-dependent control flow.

2. Step 2: Understand tracing limitation

   Tracing records operations from example input but cannot capture data-dependent branches, so it will not handle this correctly.

3. Final Answer:

   Tracing fails because the model has data-dependent control flow -> Option B

4. Quick Check:

   Tracing can't handle data-dependent control flow [OK]

Hint: Tracing fails if model has if/else based on input data [OK]

Common Mistakes:

• Assuming tracing works with all control flow
• Thinking example_input shape causes error
• Ignoring data-dependent branching

5. You want to deploy a PyTorch model with dynamic control flow and save it for production. Which approach is best to create a TorchScript model that handles this correctly?

hard

A. Use torch.jit.script() to convert the model

B. Rewrite the model to remove all control flow before tracing

C. Save the original PyTorch model with torch.save()

D. Use torch.jit.trace() with a fixed example input

Solution

1. Step 1: Identify model characteristics

   The model has dynamic control flow, meaning decisions depend on input data during execution.

2. Step 2: Choose correct TorchScript method

   torch.jit.script() analyzes the model code and supports dynamic control flow, unlike tracing which only records fixed operations.

3. Step 3: Evaluate other options

   Use torch.jit.trace() with a fixed example input (tracing) fails with dynamic control flow. Save the original PyTorch model with torch.save() saves the model but not in optimized TorchScript form. Rewrite the model to remove all control flow before tracing is impractical and changes model logic.

4. Final Answer:

   Use torch.jit.script() to convert the model -> Option A

5. Quick Check:

   Dynamic control flow needs scripting, not tracing [OK]

Hint: Use scripting for models with dynamic control flow [OK]

Common Mistakes:

• Using tracing for dynamic control flow models
• Saving without TorchScript conversion
• Trying to remove control flow instead of scripting