-
Notifications
You must be signed in to change notification settings - Fork 362
/
Copy pathinstallation.html
1075 lines (882 loc) · 54.7 KB
/
installation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Installation — Torch-TensorRT v1.3.0 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!-- <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> -->
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/collapsible-lists/css/tree_view.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Using Torch-TensorRT in Python" href="getting_started_with_python_api.html" />
<link rel="prev" title="Torch-TensorRT" href="../index.html" />
<!-- Google Analytics -->
<!-- End Google Analytics -->
<script src="../_static/js/modernizr.min.js"></script>
<!-- Preload the theme fonts -->
<link rel="preload" href="../_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="../_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="../_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="../_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="../_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="../_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<!-- Preload the katex fonts -->
<link rel="preload" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/fonts/KaTeX_Math-Italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/fonts/KaTeX_Main-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/fonts/KaTeX_Main-Bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/fonts/KaTeX_Size1-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/fonts/KaTeX_Size4-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/fonts/KaTeX_Size2-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/fonts/KaTeX_Size3-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/fonts/KaTeX_Caligraphic-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.15.2/css/all.css" integrity="sha384-vSIIfh2YWi9wW0r9iZe7RJPrKwp6bG+s9QZMoITbCckVJqGCCRhc+ccxNcdpHuYu" crossorigin="anonymous">
</head>
<div class="container-fluid header-holder tutorials-header" id="header-holder">
<div class="container">
<div class="header-container">
<a class="header-logo" href="https://pytorch.org/" aria-label="PyTorch"></a>
<div class="main-menu">
<ul>
<li>
<a href="https://pytorch.org/get-started">Get Started</a>
</li>
<li>
<a href="https://pytorch.org/ecosystem">Ecosystem</a>
</li>
<li>
<a href="https://pytorch.org/mobile">Mobile</a>
</li>
<li>
<a href="https://pytorch.org/blog/">Blog</a>
</li>
<li>
<a href="https://pytorch.org/tutorials">Tutorials</a>
</li>
<li>
<div id="resourcesDropdownButton" data-toggle="resources-dropdown" class="resources-dropdown">
<a class="resource-option with-down-orange-arrow">
Docs
</a>
<div class="resources-dropdown-menu">
<a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/docs/stable/index.html">
<span class="dropdown-title">PyTorch</span>
<p></p>
</a>
<a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/audio/stable/index.html">
<span class="dropdown-title">torchaudio</span>
<p></p>
</a>
<a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/text/stable/index.html">
<span class="dropdown-title">torchtext</span>
<p></p>
</a>
<a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/vision/stable/index.html">
<span class="dropdown-title">torchvision</span>
<p></p>
</a>
<a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/torcharrow">
<span class="dropdown-title">torcharrow</span>
<p></p>
</a>
<a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/data">
<span class="dropdown-title">TorchData</span>
<p></p>
</a>
<a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/torchrec">
<span class="dropdown-title">TorchRec</span>
<p></p>
</a>
<a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/serve/">
<span class="dropdown-title">TorchServe</span>
<p></p>
</a>
<a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/torchx/">
<span class="dropdown-title">TorchX</span>
<p></p>
</a>
<a class="doc-dropdown-option nav-dropdown-item" href="https://pytorch.org/xla">
<span class="dropdown-title">PyTorch on XLA Devices</span>
<p></p>
</a>
</div>
</li>
<li>
<div id="resourcesDropdownButton" data-toggle="resources-dropdown" class="resources-dropdown">
<a class="resource-option with-down-arrow">
Resources
</a>
<div class="resources-dropdown-menu">
<a class="nav-dropdown-item" href="https://pytorch.org/features">
<span class="dropdown-title">About</span>
<p>Learn about PyTorch’s features and capabilities</p>
</a>
<a class="nav-dropdown-item" href="https://pytorch.org/foundation">
<span class="dropdown-title">PyTorch Foundation</span>
<p>Learn about the PyTorch foundation</p>
</a>
<a class="nav-dropdown-item" href="https://pytorch.org/#community-module">
<span class="dropdown-title">Community</span>
<p>Join the PyTorch developer community to contribute, learn, and get your questions answered.</p>
</a>
<a class="nav-dropdown-item" href="https://pytorch.org/community-stories">
<span class="dropdown-title">Community Stories</span>
<p>Learn how our community solves real, everyday machine learning problems with PyTorch.</p>
</a>
<a class="nav-dropdown-item" href="https://pytorch.org/resources">
<span class="dropdown-title">Developer Resources</span>
<p>Find resources and get questions answered</p>
</a>
<a class="nav-dropdown-item" href="https://pytorch.org/events">
<span class="dropdown-title">Events</span>
<p>Find events, webinars, and podcasts</p>
</a>
<a class="nav-dropdown-item" href="https://discuss.pytorch.org/" target="_blank">
<span class="dropdown-title">Forums</span>
<p>A place to discuss PyTorch code, issues, install, research</p>
</a>
<a class="nav-dropdown-item" href="https://pytorch.org/hub">
<span class="dropdown-title">Models (Beta)</span>
<p>Discover, publish, and reuse pre-trained models</p>
</a>
</div>
</div>
</li>
<li>
<a href="https://github.com/pytorch/pytorch">GitHub</a>
</li>
</ul>
</div>
<a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
</div>
</div>
</div>
<body class="pytorch-body">
<div class="table-of-contents-link-wrapper">
<span>Table of Contents</span>
<a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
</div>
<nav data-toggle="wy-nav-shift" class="pytorch-left-menu" id="pytorch-left-menu">
<div class="pytorch-side-scroll">
<div class="pytorch-menu pytorch-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<div class="pytorch-left-menu-search">
<div class="version">
v1.3.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search Docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started_with_python_api.html">Using Torch-TensorRT in Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started_with_cpp_api.html">Using Torch-TensorRT in C++</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/creating_torchscript_module_in_python.html">Creating a TorchScript Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/creating_torchscript_module_in_python.html#working-with-torchscript-in-python">Working with TorchScript in Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/creating_torchscript_module_in_python.html#saving-torchscript-module-to-disk">Saving TorchScript Module to Disk</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/getting_started_with_fx_path.html">Torch-TensorRT (FX Frontend) User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/ptq.html">Post Training Quantization (PTQ)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/runtime.html">Deploying Torch-TensorRT Programs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/serving_torch_tensorrt_with_triton.html">Serving a Torch-TensorRT model with Triton</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/use_from_pytorch.html">Using Torch-TensorRT Directly From PyTorch</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/using_dla.html">DLA</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/notebooks.html">Example notebooks</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Python API Documenation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../py_api/torch_tensorrt.html">torch_tensorrt</a></li>
<li class="toctree-l1"><a class="reference internal" href="../py_api/logging.html">torch_tensorrt.logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="../py_api/ptq.html">torch_tensorrt.ptq</a></li>
<li class="toctree-l1"><a class="reference internal" href="../py_api/ts.html">torch_tensorrt.ts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../py_api/fx.html">torch_tensorrt.fx</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">C++ API Documenation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../_cpp_api/torch_tensort_cpp.html">Torch-TensorRT C++ API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../_cpp_api/namespace_torch_tensorrt.html">Namespace torch_tensorrt</a></li>
<li class="toctree-l1"><a class="reference internal" href="../_cpp_api/namespace_torch_tensorrt__logging.html">Namespace torch_tensorrt::logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="../_cpp_api/namespace_torch_tensorrt__torchscript.html">Namespace torch_tensorrt::torchscript</a></li>
<li class="toctree-l1"><a class="reference internal" href="../_cpp_api/namespace_torch_tensorrt__ptq.html">Namespace torch_tensorrt::ptq</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">CLI Documenation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cli/torchtrtc.html">torchtrtc</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Contributor Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../contributors/system_overview.html">System Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributors/writing_converters.html">Writing Converters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributors/useful_links.html">Useful Links for Torch-TensorRT Development</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Indices</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../indices/supported_ops.html">Operators Supported</a></li>
</ul>
</div>
</div>
</nav>
<div class="pytorch-container">
<div class="pytorch-page-level-bar" id="pytorch-page-level-bar">
<div class="pytorch-breadcrumbs-wrapper">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="pytorch-breadcrumbs">
<li>
<a href="../index.html">
Docs
</a> >
</li>
<li>Installation</li>
<li class="pytorch-breadcrumbs-aside">
<a href="../_sources/getting_started/installation.rst.txt" rel="nofollow"><img src="../_static/images/view-page-source-icon.svg"></a>
</li>
</ul>
</div>
</div>
<div class="pytorch-shortcuts-wrapper" id="pytorch-shortcuts-wrapper">
Shortcuts
</div>
</div>
<section data-toggle="wy-nav-shift" id="pytorch-content-wrap" class="pytorch-content-wrap">
<div class="pytorch-content-left">
<div class="rst-content">
<div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
<article itemprop="articleBody" id="pytorch-article" class="pytorch-article">
<section id="installation">
<span id="id1"></span><h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
<section id="precompiled-binaries">
<h2>Precompiled Binaries<a class="headerlink" href="#precompiled-binaries" title="Permalink to this headline">¶</a></h2>
<section id="dependencies">
<h3>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h3>
<p>You need to have either PyTorch or LibTorch installed based on if you are using Python or C++
and you must have CUDA, cuDNN and TensorRT installed.</p>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference external" href="https://www.pytorch.org">https://www.pytorch.org</a></p></li>
<li><p><a class="reference external" href="https://developer.nvidia.com/cuda">https://developer.nvidia.com/cuda</a></p></li>
<li><p><a class="reference external" href="https://developer.nvidia.com/cudnn">https://developer.nvidia.com/cudnn</a></p></li>
<li><p><a class="reference external" href="https://developer.nvidia.com/tensorrt">https://developer.nvidia.com/tensorrt</a></p></li>
</ul>
</div></blockquote>
</section>
<section id="python-package">
<h3>Python Package<a class="headerlink" href="#python-package" title="Permalink to this headline">¶</a></h3>
<p>You can install the python package using</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip3 install nvidia-pyindex
pip3 install nvidia-tensorrt
pip3 install torch-tensorrt<span class="o">==</span><VERSION> -f https://github.com/pytorch/TensorRT/releases/expanded_assets/<VERSION>
</pre></div>
</div>
</section>
<section id="c-binary-distribution">
<span id="bin-dist"></span><h3>C++ Binary Distribution<a class="headerlink" href="#c-binary-distribution" title="Permalink to this headline">¶</a></h3>
<p>Precompiled tarballs for releases are provided here: <a class="reference external" href="https://github.com/pytorch/TensorRT/releases">https://github.com/pytorch/TensorRT/releases</a></p>
</section>
</section>
<section id="compiling-from-source">
<span id="compile-from-source"></span><h2>Compiling From Source<a class="headerlink" href="#compiling-from-source" title="Permalink to this headline">¶</a></h2>
<section id="dependencies-for-compilation">
<span id="installing-deps"></span><h3>Dependencies for Compilation<a class="headerlink" href="#dependencies-for-compilation" title="Permalink to this headline">¶</a></h3>
<p>Torch-TensorRT is built with Bazel, so begin by installing it.</p>
<blockquote>
<div><ul class="simple">
<li><p>The easiest way is to install bazelisk using the method of your choosing <a class="reference external" href="https://github.com/bazelbuild/bazelisk">https://github.com/bazelbuild/bazelisk</a></p></li>
<li><p>Otherwise you can use the following instructions to install binaries <a class="reference external" href="https://docs.bazel.build/versions/master/install.html">https://docs.bazel.build/versions/master/install.html</a></p></li>
<li><p>Finally if you need to compile from source (e.g. aarch64 until bazel distributes binaries for the architecture) you can use these instructions</p></li>
</ul>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span> <span class="nv">BAZEL_VERSION</span><span class="o">=</span><span class="k">$(</span>cat <PATH_TO_TORCHTRT_ROOT>/.bazelversion<span class="k">)</span>
mkdir bazel
<span class="nb">cd</span> bazel
curl -fSsL -O https://github.com/bazelbuild/bazel/releases/download/<span class="nv">$BAZEL_VERSION</span>/bazel-<span class="nv">$BAZEL_VERSION</span>-dist.zip
unzip bazel-<span class="nv">$BAZEL_VERSION</span>-dist.zip
bash ./compile.sh
cp output/bazel /usr/local/bin/
</pre></div>
</div>
</div></blockquote>
<p>You will also need to have CUDA installed on the system (or if running in a container, the system must have
the CUDA driver installed and the container must have CUDA)</p>
<p>The correct LibTorch version will be pulled down for you by bazel.</p>
<blockquote>
<div><p>NOTE: For best compatability with official PyTorch, use torch==1.10.0+cuda113, TensorRT 8.0 and cuDNN 8.2 for CUDA 11.3 however Torch-TensorRT itself supports
TensorRT and cuDNN for other CUDA versions for usecases such as using NVIDIA compiled distributions of PyTorch that use other versions of CUDA
e.g. aarch64 or custom compiled version of PyTorch.</p>
</div></blockquote>
<section id="choosing-the-right-abi">
<span id="abis"></span><h4>Choosing the Right ABI<a class="headerlink" href="#choosing-the-right-abi" title="Permalink to this headline">¶</a></h4>
<p>Likely the most complicated thing about compiling Torch-TensorRT is selecting the correct ABI. There are two options
which are incompatible with each other, pre-cxx11-abi and the cxx11-abi. The complexity comes from the fact that while
the most popular distribution of PyTorch (wheels downloaded from pytorch.org/pypi directly) use the pre-cxx11-abi, most
other distributions you might encounter (e.g. ones from NVIDIA - NGC containers, and builds for Jetson as well as certain
libtorch builds and likely if you build PyTorch from source) use the cxx11-abi. It is important you compile Torch-TensorRT
using the correct ABI to function properly. Below is a table with general pairings of PyTorch distribution sources and the
recommended commands:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 31%" />
<col style="width: 36%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>PyTorch Source</p></th>
<th class="head"><p>Recommended C++ Compilation Command</p></th>
<th class="head"><p>Recommended Python Compilation Command</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>PyTorch whl file from PyTorch.org</p></td>
<td><p>bazel build //:libtorchtrt -c opt –config pre_cxx11_abi</p></td>
<td><p>python3 setup.py bdist_wheel</p></td>
</tr>
<tr class="row-odd"><td><p>libtorch-shared-with-deps-<a href="#id2"><span class="problematic" id="id3">*</span></a>.zip from PyTorch.org</p></td>
<td><p>bazel build //:libtorchtrt -c opt –config pre_cxx11_abi</p></td>
<td><p>python3 setup.py bdist_wheel</p></td>
</tr>
<tr class="row-even"><td><p>libtorch-cxx11-abi-shared-with-deps-<a href="#id4"><span class="problematic" id="id5">*</span></a>.zip from PyTorch.org</p></td>
<td><p>bazel build //:libtorchtrt -c opt</p></td>
<td><p>python3 setup.py bdist_wheel –use-cxx11-abi</p></td>
</tr>
<tr class="row-odd"><td><p>PyTorch preinstalled in an NGC container</p></td>
<td><p>bazel build //:libtorchtrt -c opt</p></td>
<td><p>python3 setup.py bdist_wheel –use-cxx11-abi</p></td>
</tr>
<tr class="row-even"><td><p>PyTorch from the NVIDIA Forums for Jetson</p></td>
<td><p>bazel build //:libtorchtrt -c opt</p></td>
<td><p>python3 setup.py bdist_wheel –jetpack-version 4.6 –use-cxx11-abi</p></td>
</tr>
<tr class="row-odd"><td><p>PyTorch built from Source</p></td>
<td><p>bazel build //:libtorchtrt -c opt</p></td>
<td><p>python3 setup.py bdist_wheel –use-cxx11-abi</p></td>
</tr>
</tbody>
</table>
<blockquote>
<div><p>NOTE: For all of the above cases you must correctly declare the source of PyTorch you intend to use in your WORKSPACE file for both Python and C++ builds. See below for more information</p>
</div></blockquote>
<p>You then have two compilation options:</p>
</section>
</section>
<section id="building-using-cudnn-tensorrt-tarball-distributions">
<span id="build-from-archive"></span><h3><strong>Building using cuDNN & TensorRT tarball distributions</strong><a class="headerlink" href="#building-using-cudnn-tensorrt-tarball-distributions" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><p>This is recommended so as to build Torch-TensorRT hermetically and insures any compilation errors are not caused by version issues</p>
<p>Make sure when running Torch-TensorRT that these versions of the libraries are prioritized in your <code class="docutils literal notranslate"><span class="pre">$LD_LIBRARY_PATH</span></code></p>
</div></blockquote>
<dl class="simple">
<dt>You need to download the tarball distributions of TensorRT and cuDNN from the NVIDIA website.</dt><dd><ul class="simple">
<li><p><a class="reference external" href="https://developer.nvidia.com/cudnn">https://developer.nvidia.com/cudnn</a></p></li>
<li><p><a class="reference external" href="https://developer.nvidia.com/tensorrt">https://developer.nvidia.com/tensorrt</a></p></li>
</ul>
</dd>
</dl>
<p>Place these files in a directory (the directories <code class="docutils literal notranslate"><span class="pre">third_party/distdir/[x86_64-linux-gnu</span> <span class="pre">|</span> <span class="pre">aarch64-linux-gnu]</span></code> exist for this purpose)</p>
<p>Then compile referencing the directory with the tarballs</p>
<blockquote>
<div><p>If you get errors regarding the packages, check their sha256 hashes and make sure they match the ones listed in <code class="docutils literal notranslate"><span class="pre">WORKSPACE</span></code></p>
</div></blockquote>
<section id="release-build">
<h4>Release Build<a class="headerlink" href="#release-build" title="Permalink to this headline">¶</a></h4>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>bazel build //:libtorchtrt -c opt --distdir third_party/distdir/<span class="o">[</span>x86_64-linux-gnu <span class="p">|</span> aarch64-linux-gnu<span class="o">]</span>
</pre></div>
</div>
<p>A tarball with the include files and library can then be found in <code class="docutils literal notranslate"><span class="pre">bazel-bin</span></code></p>
</section>
<section id="debug-build">
<span id="build-from-archive-debug"></span><h4>Debug Build<a class="headerlink" href="#debug-build" title="Permalink to this headline">¶</a></h4>
<p>To build with debug symbols use the following command</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>bazel build //:libtorchtrt -c dbg --distdir third_party/distdir/<span class="o">[</span>x86_64-linux-gnu <span class="p">|</span> aarch64-linux-gnu<span class="o">]</span>
</pre></div>
</div>
<p>A tarball with the include files and library can then be found in <code class="docutils literal notranslate"><span class="pre">bazel-bin</span></code></p>
</section>
<section id="pre-cxx11-abi-build">
<h4>Pre CXX11 ABI Build<a class="headerlink" href="#pre-cxx11-abi-build" title="Permalink to this headline">¶</a></h4>
<p>To build using the pre-CXX11 ABI use the <code class="docutils literal notranslate"><span class="pre">pre_cxx11_abi</span></code> config</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>bazel build //:libtorchtrt --config pre_cxx11_abi -c <span class="o">[</span>dbg/opt<span class="o">]</span> --distdir third_party/distdir/<span class="o">[</span>x86_64-linux-gnu <span class="p">|</span> aarch64-linux-gnu<span class="o">]</span>
</pre></div>
</div>
<p>A tarball with the include files and library can then be found in <code class="docutils literal notranslate"><span class="pre">bazel-bin</span></code></p>
</section>
</section>
<section id="building-using-locally-installed-cudnn-tensorrt">
<span id="build-from-local"></span><h3><strong>Building using locally installed cuDNN & TensorRT</strong><a class="headerlink" href="#building-using-locally-installed-cudnn-tensorrt" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><p>If you encounter bugs and you compiled using this method please disclose that you used local sources in the issue (an ldd dump would be nice too)</p>
</div></blockquote>
<p>Install TensorRT, CUDA and cuDNN on the system before starting to compile.</p>
<p>In WORKSPACE comment out:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Downloaded distributions to use with --distdir</span>
<span class="n">http_archive</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"cudnn"</span><span class="p">,</span>
<span class="n">urls</span><span class="o">=</span><span class="p">[</span>
<span class="s2">"<URL>"</span><span class="p">,</span>
<span class="p">],</span>
<span class="n">build_file</span><span class="o">=</span><span class="s2">"@//third_party/cudnn/archive:BUILD"</span><span class="p">,</span>
<span class="n">sha256</span><span class="o">=</span><span class="s2">"<TAR SHA256>"</span><span class="p">,</span>
<span class="n">strip_prefix</span><span class="o">=</span><span class="s2">"cuda"</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">http_archive</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"tensorrt"</span><span class="p">,</span>
<span class="n">urls</span><span class="o">=</span><span class="p">[</span>
<span class="s2">"<URL>"</span><span class="p">,</span>
<span class="p">],</span>
<span class="n">build_file</span><span class="o">=</span><span class="s2">"@//third_party/tensorrt/archive:BUILD"</span><span class="p">,</span>
<span class="n">sha256</span><span class="o">=</span><span class="s2">"<TAR SHA256>"</span><span class="p">,</span>
<span class="n">strip_prefix</span><span class="o">=</span><span class="s2">"TensorRT-<VERSION>"</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<p>and uncomment</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Locally installed dependencies</span>
<span class="n">new_local_repository</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"cudnn"</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="s2">"/usr/"</span><span class="p">,</span> <span class="n">build_file</span><span class="o">=</span><span class="s2">"@//third_party/cudnn/local:BUILD"</span>
<span class="p">)</span>
<span class="n">new_local_repository</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"tensorrt"</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="s2">"/usr/"</span><span class="p">,</span> <span class="n">build_file</span><span class="o">=</span><span class="s2">"@//third_party/tensorrt/local:BUILD"</span>
<span class="p">)</span>
</pre></div>
</div>
<section id="id6">
<h4>Release Build<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h4>
<p>Compile using:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>bazel build //:libtorchtrt -c opt
</pre></div>
</div>
<p>A tarball with the include files and library can then be found in <code class="docutils literal notranslate"><span class="pre">bazel-bin</span></code></p>
</section>
<section id="build-from-local-debug">
<span id="id7"></span><h4>Debug Build<a class="headerlink" href="#build-from-local-debug" title="Permalink to this headline">¶</a></h4>
<p>To build with debug symbols use the following command</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>bazel build //:libtorchtrt -c dbg
</pre></div>
</div>
<p>A tarball with the include files and library can then be found in <code class="docutils literal notranslate"><span class="pre">bazel-bin</span></code></p>
</section>
<section id="id8">
<h4>Pre CXX11 ABI Build<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h4>
<p>To build using the pre-CXX11 ABI use the <code class="docutils literal notranslate"><span class="pre">pre_cxx11_abi</span></code> config</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>bazel build //:libtorchtrt --config pre_cxx11_abi -c <span class="o">[</span>dbg/opt<span class="o">]</span>
</pre></div>
</div>
</section>
</section>
<section id="building-with-cmake">
<h3><strong>Building with CMake</strong><a class="headerlink" href="#building-with-cmake" title="Permalink to this headline">¶</a></h3>
<p>It is possible to build the API libraries (in cpp/) and the torchtrtc executable using CMake instead of Bazel.
Currently, the python API and the tests cannot be built with CMake.
Begin by installing CMake.</p>
<blockquote>
<div><ul class="simple">
<li><p>Latest releases of CMake and instructions on how to install are available for different platforms
[on their website](<a class="reference external" href="https://cmake.org/download/">https://cmake.org/download/</a>).</p></li>
</ul>
</div></blockquote>
<p>A few useful CMake options include:</p>
<blockquote>
<div><ul class="simple">
<li><p>CMake finders for TensorRT and cuDNN are provided in <cite>cmake/Modules</cite>. In order for CMake to use them, pass
<cite>-DCMAKE_MODULE_PATH=cmake/Modules</cite> when configuring the project with CMake.</p></li>
<li><p>Libtorch provides its own CMake finder. In case CMake doesn’t find it, pass the path to your install of
libtorch with <cite>-DTorch_DIR=<path to libtorch>/share/cmake/Torch</cite></p></li>
<li><p>If TensorRT is not found with the provided cmake finder, specify <cite>-DTensorRT_ROOT=<path to TensorRT></cite></p></li>
<li><p>Finally, configure and build the project in a build directory of your choice with the following command
from the root of Torch-TensorRT project:</p></li>
</ul>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>cmake -S. -B<build directory> <span class="se">\</span>
<span class="o">[</span>-DCMAKE_MODULE_PATH<span class="o">=</span>cmake/Module<span class="o">]</span> <span class="se">\</span>
<span class="o">[</span>-DTorch_DIR<span class="o">=</span><path to libtorch>/share/cmake/Torch<span class="o">]</span> <span class="se">\</span>
<span class="o">[</span>-DTensorRT_ROOT<span class="o">=</span><path to TensorRT><span class="o">]</span> <span class="se">\</span>
<span class="o">[</span>-DCMAKE_BUILD_TYPE<span class="o">=</span>Debug<span class="p">|</span>Release<span class="o">]</span>
cmake --build <build directory>
</pre></div>
</div>
</div></blockquote>
</section>
<section id="building-the-python-package">
<h3><strong>Building the Python package</strong><a class="headerlink" href="#building-the-python-package" title="Permalink to this headline">¶</a></h3>
<p>Begin by installing <code class="docutils literal notranslate"><span class="pre">ninja</span></code></p>
<p>You can build the Python package using <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> (this will also build the correct version of <code class="docutils literal notranslate"><span class="pre">libtorchtrt.so</span></code>)</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3 setup.py <span class="o">[</span>install/bdist_wheel<span class="o">]</span>
</pre></div>
</div>
<section id="id9">
<h4>Debug Build<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h4>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3 setup.py develop <span class="o">[</span>--user<span class="o">]</span>
</pre></div>
</div>
<p>This also compiles a debug build of <code class="docutils literal notranslate"><span class="pre">libtorchtrt.so</span></code></p>
</section>
</section>
<section id="building-natively-on-aarch64-jetson">
<h3><strong>Building Natively on aarch64 (Jetson)</strong><a class="headerlink" href="#building-natively-on-aarch64-jetson" title="Permalink to this headline">¶</a></h3>
<section id="prerequisites">
<h4>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h4>
<p>Install or compile a build of PyTorch/LibTorch for aarch64</p>
<p>NVIDIA hosts builds the latest release branch for Jetson here:</p>
<blockquote>
<div><p><a class="reference external" href="https://forums.developer.nvidia.com/t/pytorch-for-jetson-version-1-10-now-available/72048">https://forums.developer.nvidia.com/t/pytorch-for-jetson-version-1-10-now-available/72048</a></p>
</div></blockquote>
</section>
<section id="enviorment-setup">
<h4>Enviorment Setup<a class="headerlink" href="#enviorment-setup" title="Permalink to this headline">¶</a></h4>
<p>To build natively on aarch64-linux-gnu platform, configure the <code class="docutils literal notranslate"><span class="pre">WORKSPACE</span></code> with local available dependencies.</p>
<ol class="arabic">
<li><p>Replace <code class="docutils literal notranslate"><span class="pre">WORKSPACE</span></code> with the corresponding WORKSPACE file in <code class="docutils literal notranslate"><span class="pre">//toolchains/jp_workspaces</span></code></p></li>
<li><p>Configure the correct paths to directory roots containing local dependencies in the <code class="docutils literal notranslate"><span class="pre">new_local_repository</span></code> rules:</p>
<blockquote>
<div><p>NOTE: If you installed PyTorch using a pip package, the correct path is the path to the root of the python torch package.
In the case that you installed with <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">pip</span> <span class="pre">install</span></code> this will be <code class="docutils literal notranslate"><span class="pre">/usr/local/lib/python3.8/dist-packages/torch</span></code>.
In the case you installed with <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">--user</span></code> this will be <code class="docutils literal notranslate"><span class="pre">$HOME/.local/lib/python3.8/site-packages/torch</span></code>.</p>
</div></blockquote>
</li>
</ol>
<p>In the case you are using NVIDIA compiled pip packages, set the path for both libtorch sources to the same path. This is because unlike
PyTorch on x86_64, NVIDIA aarch64 PyTorch uses the CXX11-ABI. If you compiled for source using the pre_cxx11_abi and only would like to
use that library, set the paths to the same path but when you compile make sure to add the flag <code class="docutils literal notranslate"><span class="pre">--config=pre_cxx11_abi</span></code></p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>new_local_repository<span class="o">(</span>
<span class="nv">name</span> <span class="o">=</span> <span class="s2">"libtorch"</span>,
<span class="nv">path</span> <span class="o">=</span> <span class="s2">"/usr/local/lib/python3.8/dist-packages/torch"</span>,
<span class="nv">build_file</span> <span class="o">=</span> <span class="s2">"third_party/libtorch/BUILD"</span>
<span class="o">)</span>
new_local_repository<span class="o">(</span>
<span class="nv">name</span> <span class="o">=</span> <span class="s2">"libtorch_pre_cxx11_abi"</span>,
<span class="nv">path</span> <span class="o">=</span> <span class="s2">"/usr/local/lib/python3.8/dist-packages/torch"</span>,
<span class="nv">build_file</span> <span class="o">=</span> <span class="s2">"third_party/libtorch/BUILD"</span>
<span class="o">)</span>
</pre></div>
</div>
</section>
<section id="compile-c-library-and-compiler-cli">
<h4>Compile C++ Library and Compiler CLI<a class="headerlink" href="#compile-c-library-and-compiler-cli" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>NOTE: Due to shifting dependency locations between Jetpack 4.5 and 4.6 there is a now a flag to inform bazel of the Jetpack version</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>--platforms //toolchains:jetpack_x.x
</pre></div>
</div>
</div></blockquote>
<p>Compile Torch-TensorRT library using bazel command:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>bazel build //:libtorchtrt --platforms //toolchains:jetpack_5.0
</pre></div>
</div>
</section>
<section id="compile-python-api">
<h4>Compile Python API<a class="headerlink" href="#compile-python-api" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>NOTE: Due to shifting dependencies locations between Jetpack 4.5 and newer Jetpack verisons there is now a flag for <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> which sets the jetpack version (default: 5.0)</p>
</div></blockquote>
<p>Compile the Python API using the following command from the <code class="docutils literal notranslate"><span class="pre">//py</span></code> directory:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3 setup.py install --use-cxx11-abi
</pre></div>
</div>
<p>If you have a build of PyTorch that uses Pre-CXX11 ABI drop the <code class="docutils literal notranslate"><span class="pre">--use-cxx11-abi</span></code> flag</p>
<p>If you are building for Jetpack 4.5 add the <code class="docutils literal notranslate"><span class="pre">--jetpack-version</span> <span class="pre">5.0</span></code> flag</p>
</section>
</section>
</section>
</section>
</article>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="getting_started_with_python_api.html" class="btn btn-neutral float-right" title="Using Torch-TensorRT in Python" accesskey="n" rel="next">Next <img src="../_static/images/chevron-right-orange.svg" class="next-page"></a>
<a href="../index.html" class="btn btn-neutral" title="Torch-TensorRT" accesskey="p" rel="prev"><img src="../_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
</div>
<hr>
<div role="contentinfo">
<p>
© Copyright 2022, NVIDIA Corporation.
</p>
</div>
<div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</div>
</footer>
</div>
</div>
<div class="pytorch-content-right" id="pytorch-content-right">
<div class="pytorch-right-menu" id="pytorch-right-menu">
<div class="pytorch-side-scroll" id="pytorch-side-scroll-right">
<ul>
<li><a class="reference internal" href="#">Installation</a><ul>
<li><a class="reference internal" href="#precompiled-binaries">Precompiled Binaries</a><ul>
<li><a class="reference internal" href="#dependencies">Dependencies</a></li>
<li><a class="reference internal" href="#python-package">Python Package</a></li>
<li><a class="reference internal" href="#c-binary-distribution">C++ Binary Distribution</a></li>
</ul>
</li>
<li><a class="reference internal" href="#compiling-from-source">Compiling From Source</a><ul>
<li><a class="reference internal" href="#dependencies-for-compilation">Dependencies for Compilation</a><ul>
<li><a class="reference internal" href="#choosing-the-right-abi">Choosing the Right ABI</a></li>
</ul>
</li>
<li><a class="reference internal" href="#building-using-cudnn-tensorrt-tarball-distributions"><strong>Building using cuDNN & TensorRT tarball distributions</strong></a><ul>
<li><a class="reference internal" href="#release-build">Release Build</a></li>
<li><a class="reference internal" href="#debug-build">Debug Build</a></li>
<li><a class="reference internal" href="#pre-cxx11-abi-build">Pre CXX11 ABI Build</a></li>
</ul>
</li>
<li><a class="reference internal" href="#building-using-locally-installed-cudnn-tensorrt"><strong>Building using locally installed cuDNN & TensorRT</strong></a><ul>
<li><a class="reference internal" href="#id6">Release Build</a></li>
<li><a class="reference internal" href="#build-from-local-debug">Debug Build</a></li>
<li><a class="reference internal" href="#id8">Pre CXX11 ABI Build</a></li>
</ul>
</li>
<li><a class="reference internal" href="#building-with-cmake"><strong>Building with CMake</strong></a></li>
<li><a class="reference internal" href="#building-the-python-package"><strong>Building the Python package</strong></a><ul>
<li><a class="reference internal" href="#id9">Debug Build</a></li>
</ul>
</li>
<li><a class="reference internal" href="#building-natively-on-aarch64-jetson"><strong>Building Natively on aarch64 (Jetson)</strong></a><ul>
<li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
<li><a class="reference internal" href="#enviorment-setup">Enviorment Setup</a></li>
<li><a class="reference internal" href="#compile-c-library-and-compiler-cli">Compile C++ Library and Compiler CLI</a></li>
<li><a class="reference internal" href="#compile-python-api">Compile Python API</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</section>
</div>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/collapsible-lists/js/CollapsibleLists.compressed.js"></script>
<script src="../_static/collapsible-lists/js/apply-collapsible-lists.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script type="text/javascript" src="../_static/js/vendor/popper.min.js"></script>
<script type="text/javascript" src="../_static/js/vendor/bootstrap.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/list.js/1.5.0/list.min.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<!-- Begin Footer -->
<div class="container-fluid docs-tutorials-resources" id="docs-tutorials-resources">
<div class="container">
<div class="row">
<div class="col-md-4 text-center">
<h2>Docs</h2>
<p>Access comprehensive developer documentation for PyTorch</p>
<a class="with-right-arrow" href="https://pytorch.org/docs/stable/index.html">View Docs</a>
</div>
<div class="col-md-4 text-center">
<h2>Tutorials</h2>
<p>Get in-depth tutorials for beginners and advanced developers</p>
<a class="with-right-arrow" href="https://pytorch.org/tutorials">View Tutorials</a>
</div>
<div class="col-md-4 text-center">
<h2>Resources</h2>
<p>Find development resources and get your questions answered</p>
<a class="with-right-arrow" href="https://pytorch.org/resources">View Resources</a>
</div>
</div>
</div>
</div>
<footer class="site-footer">
<div class="container footer-container">
<div class="footer-logo-wrapper">
<a href="https://pytorch.org/" class="footer-logo"></a>
</div>
<div class="footer-links-wrapper">
<div class="footer-links-col">
<ul>
<li class="list-title"><a href="https://pytorch.org/">PyTorch</a></li>
<li><a href="https://pytorch.org/get-started">Get Started</a></li>
<li><a href="https://pytorch.org/features">Features</a></li>
<li><a href="https://pytorch.org/ecosystem">Ecosystem</a></li>
<li><a href="https://pytorch.org/blog/">Blog</a></li>
<li><a href="https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md">Contributing</a></li>
</ul>
</div>
<div class="footer-links-col">
<ul>
<li class="list-title"><a href="https://pytorch.org/resources">Resources</a></li>
<li><a href="https://pytorch.org/tutorials">Tutorials</a></li>
<li><a href="https://pytorch.org/docs/stable/index.html">Docs</a></li>
<li><a href="https://discuss.pytorch.org" target="_blank">Discuss</a></li>
<li><a href="https://github.com/pytorch/pytorch/issues" target="_blank">Github Issues</a></li>
<li><a href="https://pytorch.org/assets/brand-guidelines/PyTorch-Brand-Guidelines.pdf" target="_blank">Brand Guidelines</a></li>
</ul>
</div>
<div class="footer-links-col">
<ul>
<li class="list-title">Stay up to date</li>
<li><a href="https://www.facebook.com/pytorch" target="_blank">Facebook</a></li>
<li><a href="https://twitter.com/pytorch" target="_blank">Twitter</a></li>
<li><a href="https://www.youtube.com/pytorch" target="_blank">YouTube</a></li>
<li><a href="https://www.linkedin.com/company/pytorch" target="_blank">LinkedIn</a></li>
</ul>
</div>
<div class="footer-links-col">
<ul>
<li class="list-title">PyTorch Podcasts</li>
<li><a href="https://open.spotify.com/show/6UzHKeiy368jKfQMKKvJY5" target="_blank">Spotify</a></li>
<li><a href="https://podcasts.apple.com/us/podcast/pytorch-developer-podcast/id1566080008" target="_blank">Apple</a></li>
<li><a href="https://www.google.com/podcasts?feed=aHR0cHM6Ly9mZWVkcy5zaW1wbGVjYXN0LmNvbS9PQjVGa0lsOA%3D%3D" target="_blank">Google</a></li>
<li><a href="https://music.amazon.com/podcasts/7a4e6f0e-26c2-49e9-a478-41bd244197d0/PyTorch-Developer-Podcast?" target="_blank">Amazon</a></li>
</ul>
</div>
</div>
<div class="privacy-policy">
<ul>
<li class="privacy-policy-links"><a href="https://www.linuxfoundation.org/terms/" target="_blank">Terms</a></li>
<li class="privacy-policy-links">|</li>
<li class="privacy-policy-links"><a href="https://www.linuxfoundation.org/privacy-policy/" target="_blank">Privacy</a></li>
</ul>
</div>
<div class="copyright">
<p>© Copyright The Linux Foundation. The PyTorch Foundation is a project of The Linux Foundation.
For web site terms of use, trademark policy and other policies applicable to The PyTorch Foundation please see
<a href="www.linuxfoundation.org/policies/">www.linuxfoundation.org/policies/</a>. The PyTorch Foundation supports the PyTorch open source
project, which has been established as PyTorch Project a Series of LF Projects, LLC. For policies applicable to the PyTorch Project a Series of LF Projects, LLC,
please see <a href="www.lfprojects.org/policies/">www.lfprojects.org/policies/</a>.</p>
</div>
</div>
</footer>
<div class="cookie-banner-wrapper">
<div class="container">
<p class="gdpr-notice">To analyze traffic and optimize your experience, we serve cookies on this site. By clicking or navigating, you agree to allow our usage of cookies. As the current maintainers of this site, Facebook’s Cookies Policy applies. Learn more, including about available controls: <a href="https://www.facebook.com/policies/cookies/">Cookies Policy</a>.</p>
<img class="close-button" src="../_static/images/pytorch-x.svg">
</div>
</div>
<!-- End Footer -->
<!-- Begin Mobile Menu -->
<div class="mobile-main-menu">
<div class="container-fluid">
<div class="container">
<div class="mobile-main-menu-header-container">
<a class="header-logo" href="https://pytorch.org/" aria-label="PyTorch"></a>
<a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
</div>
</div>
</div>
<div class="mobile-main-menu-links-container">
<div class="main-menu">
<ul>
<li>
<a href="https://pytorch.org/get-started">Get Started</a>
</li>
<li>
<a href="https://pytorch.org/ecosystem">Ecosystem</a>
</li>
<li>
<a href="https://pytorch.org/mobile">Mobile</a>
</li>
<li>
<a href="https://pytorch.org/blog/">Blog</a>
</li>
<li>
<a href="https://pytorch.org/tutorials">Tutorials</a>
</li>
<li class="resources-mobile-menu-title">
Docs
</li>
<ul class="resources-mobile-menu-items">
<li>
<a href="https://pytorch.org/docs/stable/index.html">PyTorch</a>
</li>
<li>
<a href="https://pytorch.org/audio/stable/index.html">torchaudio</a>
</li>
<li>
<a href="https://pytorch.org/text/stable/index.html">torchtext</a>
</li>
<li>
<a href="https://pytorch.org/vision/stable/index.html">torchvision</a>
</li>
<li>
<a href="https://pytorch.org/torcharrow">torcharrow</a>
</li>
<li>
<a href="https://pytorch.org/data">TorchData</a>
</li>
<li>
<a href="https://pytorch.org/torchrec">TorchRec</a>
</li>
<li>
<a href="https://pytorch.org/serve/">TorchServe</a>
</li>
<li>
<a href="https://pytorch.org/torchx/">TorchX</a>
</li>