Skip to content

fix confusion w.r.t. which model to serialize and use in cpp_export tutorial #609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 12, 2019
Merged

fix confusion w.r.t. which model to serialize and use in cpp_export tutorial #609

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0cf0c68
fix confusion w.r.t. which model to serialize and use
Krovatkin Aug 12, 2019
747b3bc
more clarifications
Krovatkin Aug 12, 2019
0a78351
Merge branch 'master' into krovatkin/seth_feedback
brianjo Aug 12, 2019
06343d7
Update cpp_export.rst
SethHWeidman Aug 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions advanced_source/cpp_export.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Loading a PyTorch Model in C++
==============================

**This tutorial was updated to work with PyTorch 1.2**

As its name suggests, the primary interface to PyTorch is the Python
programming language. While Python is a suitable and preferred language for
many scenarios requiring dynamism and ease of iteration, there are equally many
Expand Down Expand Up @@ -129,10 +131,11 @@ earlier in the tracing example. To perform this serialization, simply call
`save <https://pytorch.org/docs/master/jit.html#torch.jit.ScriptModule.save>`_
on the module and pass it a filename::

traced_script_module.save("model.pt")
traced_script_module.save("traced_resnet_model.pt")

This will produce a ``model.pt`` file in your working directory. We have now
officially left the realm of Python and are ready to cross over to the sphere
This will produce a ``traced_resnet_model.pt`` file in your working directory.
If you also would like to serialize ``my_module``, call ``my_module.save("my_module_model.pt")``
We have now officially left the realm of Python and are ready to cross over to the sphere
of C++.

Step 3: Loading Your Script Module in C++
Expand Down Expand Up @@ -285,13 +288,14 @@ distribution. If all goes well, it will look something like this:
[100%] Linking CXX executable example-app
[100%] Built target example-app

If we supply the path to the serialized ``ResNet18`` model we created earlier
If we supply the path to the traced ``ResNet18`` model ``traced_resnet_model.pt`` we created earlier
to the resulting ``example-app`` binary, we should be rewarded with a friendly
"ok":
"ok". Please note, if try to run this example with ``my_module_model.pt`` you will get an error saying that
your input is of an incompatible shape. ``my_module_model.pt`` expects 1D instead of 4D.

.. code-block:: sh

root@4b5a67132e81:/example-app/build# ./example-app model.pt
root@4b5a67132e81:/example-app/build# ./example-app <path_to_model>/traced_resnet_model.pt
ok

Step 4: Executing the Script Module in C++
Expand Down Expand Up @@ -338,7 +342,7 @@ application and running it with the same serialized model:
[ 50%] Building CXX object CMakeFiles/example-app.dir/example-app.cpp.o
[100%] Linking CXX executable example-app
[100%] Built target example-app
root@4b5a67132e81:/example-app/build# ./example-app model.pt
root@4b5a67132e81:/example-app/build# ./example-app traced_resnet_model.pt
-0.2698 -0.0381 0.4023 -0.3010 -0.0448
[ Variable[CPUFloatType]{1,5} ]

Expand Down