Skip to content

torch.jit.trace_module documentation refers example_inputs as an argument.  #39328

@DNXie

Description

@DNXie

📚 Documentation

Link

https://pytorch.org/docs/stable/jit.html#torch.jit.trace_module

API

torch.jit.trace_module

Issue

In the "Parameters" section, there is an input example_inputs, but it is not in the signature, and it is not accepted by the function. It should be inputs

Running the example code from the document:

import torch.nn as nn

class Net(nn.Module):
    def __init__(self):
        super(Net, self).__init__()
        self.conv = nn.Conv2d(1, 1, 3)

    def forward(self, x):
        return self.conv(x)

    def weighted_kernel_sum(self, weight):
        return weight * self.conv.weight


n = Net()
example_weight = torch.rand(1, 1, 3, 3)
example_forward_input = torch.rand(1, 1, 3, 3)

# Trace a specific method and construct `ScriptModule` with
# a single `forward` method
module = torch.jit.trace(n.forward, example_forward_input)

# Trace a module (implicitly traces `forward`) and construct a
# `ScriptModule` with a single `forward` method
module = torch.jit.trace(n, example_forward_input)

# Trace specific methods on a module (specified in `inputs`), constructs
# a `ScriptModule` with `forward` and `weighted_kernel_sum` methods
inputs = {'forward' : example_forward_input, 'weighted_kernel_sum' : example_weight}

and calls the function:

module = torch.jit.trace_module(n, example_inputs=inputs)

gives exception

TypeError: trace_module() got an unexpected keyword argument 'example_inputs'

System information

  • OS: macOS Mojave 10.14
  • PyTorch version: 1.5.0
  • Python version: 3.8.2

cc @suo

Metadata

Metadata

Assignees

No one assigned

    Labels

    module: docsRelated to our documentation, both in docs/ and docblocksoncall: jitAdd this issue/PR to JIT oncall triage queuetriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate module

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions