-
-
Notifications
You must be signed in to change notification settings - Fork 636
/
Copy pathutils.html
880 lines (690 loc) · 56.6 KB
/
utils.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
<!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="author" content="PyTorch-Ignite Contributors">
<meta name="creator" content="PyTorch-Ignite Contributors">
<meta name="publisher" content="PyTorch-Ignite Contributors">
<meta name="generator" content="Sphinx 5.3.0">
<meta name="description" content="High-level library to help with training and evaluating neural networks in PyTorch flexibly and transparently.">
<meta name="keywords" content="pytorch, pytorch ignite, ignite, engine, events, handlers, metrics">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="theme-color" content="#ee4c2c">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@pytorch_ignite">
<meta name="twitter:creator" content="@pytorch_ignite">
<meta name="twitter:description" content="High-level library to help with training and evaluating neural networks in PyTorch flexibly and transparently.">
<meta name="twitter:title" content="ignite.utils — PyTorch-Ignite v0.5.1 Documentation">
<meta name="twitter:image" content="https://raw.githubusercontent.com/pytorch/ignite/master/assets/logo/ignite_logo.png">
<meta name="twitter:image:alt" content="PyTorch-Ignite logo">
<meta property="og:title" content="ignite.utils — PyTorch-Ignite v0.5.1 Documentation">
<meta property="og:type" content="website">
<meta property="og:url" content="https://pytorch.org/ignite/">
<meta property="og:site_name" content="PyTorch-Ignite">
<meta property="og:image" content="https://raw.githubusercontent.com/pytorch/ignite/master/assets/logo/ignite_logo.png">
<meta property="og:image:alt" content="PyTorch-Ignite logo">
<meta property="og:description" content="High-level library to help with training and evaluating neural networks in PyTorch flexibly and transparently.">
<link rel="preconnect" href="https://BH4D9OD16A-dsn.algolia.net" crossorigin />
<title>ignite.utils — PyTorch-Ignite v0.5.1 Documentation</title>
<link rel="shortcut icon" type="image/svg+xml" href="_static/ignite_logomark.svg"/>
<link rel="canonical" href="https://pytorch.org/ignite/utils.html"/>
<link rel="preload" href="_static/css/theme.css" as="style" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
<link rel="preload" href="_static/pygments.css" as="style" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="preload" href="_static/css/theme.css" as="style" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="preload" href="_static/copybutton.css" as="style" />
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
<link rel="preload" href="_static/togglebutton.css" as="style" />
<link rel="stylesheet" href="_static/togglebutton.css" type="text/css" />
<link rel="preload" href="_static/banner.css" as="style" />
<link rel="stylesheet" href="_static/banner.css" type="text/css" />
<link rel="preload" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" as="style" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" type="text/css" />
<link rel="preload" href="_static/katex-math.css" as="style" />
<link rel="stylesheet" href="_static/katex-math.css" type="text/css" />
<link rel="preload" href="_static/sphinx-design.5ea377869091fd0449014c60fc090103.min.css" as="style" />
<link rel="stylesheet" href="_static/sphinx-design.5ea377869091fd0449014c60fc090103.min.css" type="text/css" />
<link rel="preload" href="_static/css/ignite_theme.css" as="style" />
<link rel="stylesheet" href="_static/css/ignite_theme.css" type="text/css" />
<link rel="preload" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3" as="style" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="ignite.contrib.engines" href="contrib/engines.html" />
<link rel="prev" title="ignite.exceptions" href="exceptions.html" />
<!-- katex links / this needs to be loaded before fonts.html -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" crossorigin="anonymous">
<script async src="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js" crossorigin="anonymous"></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">
<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Regular.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">
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-5FELLLFHCP"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-5FELLLFHCP');
</script>
</head>
<div class="container-fluid header-holder tutorials-header" id="header-holder">
<div class="container">
<a class="header-logo" href="/ignite" aria-label="PyTorch-Ignite"></a>
<div class="header-container">
<div class="main-menu">
<ul>
<li>
<a href="https://pytorch-ignite.ai/tutorials/beginner/01-getting-started/">Quickstart</a>
</li>
<li>
<a href="https://pytorch-ignite.ai/concepts/">Concepts</a>
</li>
<!-- <li>
<a href="https://pytorch-ignite.ai/tutorials/beginner/01-getting-started/#complete-code">Examples</a>
</li> -->
<li>
<a href="https://pytorch-ignite.ai/how-to-guides/">FAQ</a>
</li>
<li>
<a href="https://github.com/pytorch/ignite" target="_blank" rel="noopener noreferrer">GitHub</a>
</li>
<li>
<a href="https://pytorch-ignite.ai/about/community/">About us</a>
</li>
<li>
<a href="https://pytorch-ignite.ai">⊳ pytorch-ignite.ai</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>
<div class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></div>
</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">
v0.5.1
</div>
<div id="docsearch"></div>
</div>
<p class="caption" role="heading"><span class="caption-text">Package Reference</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="engine.html">ignite.engine</a></li>
<li class="toctree-l1"><a class="reference internal" href="handlers.html">ignite.handlers</a></li>
<li class="toctree-l1"><a class="reference internal" href="metrics.html">ignite.metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="distributed.html">ignite.distributed</a></li>
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">ignite.exceptions</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">ignite.utils</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Contrib Package Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="contrib/engines.html">ignite.contrib.engines</a></li>
<li class="toctree-l1"><a class="reference internal" href="contrib/metrics.html">ignite.contrib.metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="contrib/handlers.html">ignite.contrib.handlers</a></li>
</ul>
</div>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Other Versions</span>
v: v0.5.1
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="v0.3.0/utils.html">v0.3.0</a></dd>
<dd><a href="v0.4.0.post1/utils.html">v0.4.0.post1</a></dd>
<dd><a href="v0.4.1/utils.html">v0.4.1</a></dd>
<dd><a href="v0.4.10/utils.html">v0.4.10</a></dd>
<dd><a href="v0.4.11/utils.html">v0.4.11</a></dd>
<dd><a href="v0.4.12/utils.html">v0.4.12</a></dd>
<dd><a href="v0.4.13/utils.html">v0.4.13</a></dd>
<dd><a href="v0.4.2/utils.html">v0.4.2</a></dd>
<dd><a href="v0.4.3/utils.html">v0.4.3</a></dd>
<dd><a href="v0.4.4.post1/utils.html">v0.4.4.post1</a></dd>
<dd><a href="v0.4.5/utils.html">v0.4.5</a></dd>
<dd><a href="v0.4.6/utils.html">v0.4.6</a></dd>
<dd><a href="v0.4.7/utils.html">v0.4.7</a></dd>
<dd><a href="v0.4.8/utils.html">v0.4.8</a></dd>
<dd><a href="v0.4.9/utils.html">v0.4.9</a></dd>
<dd><a href="v0.4rc.0.post1/utils.html">v0.4rc.0.post1</a></dd>
<dd><a href="v0.5.0.post2/utils.html">v0.5.0.post2</a></dd>
<dd><a href="v0.5.1/utils.html">v0.5.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="master/utils.html">master</a></dd>
</dl>
</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>ignite.utils</li>
<li class="pytorch-breadcrumbs-aside">
<a href="_sources/utils.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="ignite-utils">
<h1>ignite.utils<a class="headerlink" href="#ignite-utils" title="Permalink to this heading">#</a></h1>
<p>Module with helper methods</p>
<table class="autosummary longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#ignite.utils.convert_tensor" title="ignite.utils.convert_tensor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">convert_tensor</span></code></a></p></td>
<td><p>Move tensors to relevant device.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#ignite.utils.apply_to_tensor" title="ignite.utils.apply_to_tensor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">apply_to_tensor</span></code></a></p></td>
<td><p>Apply a function on a tensor or mapping, or sequence of tensors.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ignite.utils.apply_to_type" title="ignite.utils.apply_to_type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">apply_to_type</span></code></a></p></td>
<td><p>Apply a function on an object of <cite>input_type</cite> or mapping, or sequence of objects of <cite>input_type</cite>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#ignite.utils.to_onehot" title="ignite.utils.to_onehot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_onehot</span></code></a></p></td>
<td><p>Convert a tensor of indices of any shape <cite>(N, ...)</cite> to a tensor of one-hot indicators of shape <cite>(N, num_classes, ...)</cite> and of type uint8.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ignite.utils.setup_logger" title="ignite.utils.setup_logger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setup_logger</span></code></a></p></td>
<td><p>Setups logger: name, level, format etc.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#ignite.utils.manual_seed" title="ignite.utils.manual_seed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">manual_seed</span></code></a></p></td>
<td><p>Setup random state from a seed for <cite>torch</cite>, <cite>random</cite> and optionally <cite>numpy</cite> (if can be imported).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ignite.utils.hash_checkpoint" title="ignite.utils.hash_checkpoint"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hash_checkpoint</span></code></a></p></td>
<td><p>Hash the checkpoint file in the format of <code class="docutils literal notranslate"><span class="pre"><filename>-<hash>.<ext></span></code> to be used with <code class="docutils literal notranslate"><span class="pre">check_hash</span></code> of <a class="reference external" href="https://pytorch.org/docs/stable/hub.html#torch.hub.load_state_dict_from_url" title="(in PyTorch v2.6)"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.hub.load_state_dict_from_url()</span></code></a>.</p></td>
</tr>
</tbody>
</table>
<span class="target" id="module-ignite.utils"></span><dl class="py function">
<dt class="sig sig-object py" id="ignite.utils.apply_to_tensor">
<span class="sig-prename descclassname"><span class="pre">ignite.utils.</span></span><span class="sig-name descname"><span class="pre">apply_to_tensor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ignite/utils.html#apply_to_tensor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ignite.utils.apply_to_tensor" title="Permalink to this definition">#</a></dt>
<dd><p>Apply a function on a tensor or mapping, or sequence of tensors.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.13)"><em>Union</em></a><em>[</em><a class="reference external" href="https://pytorch.org/docs/stable/tensors.html#torch.Tensor" title="(in PyTorch v2.6)"><em>Tensor</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><em>Sequence</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.13)"><em>Mapping</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.13)"><em>bytes</em></a><em>]</em>) – input tensor or mapping, or sequence of tensors.</p></li>
<li><p><strong>func</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><em>Callable</em></a>) – the function to apply on <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.13)"><em>Union</em></a>[<a class="reference external" href="https://pytorch.org/docs/stable/tensors.html#torch.Tensor" title="(in PyTorch v2.6)"><em>Tensor</em></a>, <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><em>Sequence</em></a>, <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.13)"><em>Mapping</em></a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.13)">bytes</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ignite.utils.apply_to_type">
<span class="sig-prename descclassname"><span class="pre">ignite.utils.</span></span><span class="sig-name descname"><span class="pre">apply_to_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ignite/utils.html#apply_to_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ignite.utils.apply_to_type" title="Permalink to this definition">#</a></dt>
<dd><p>Apply a function on an object of <cite>input_type</cite> or mapping, or sequence of objects of <cite>input_type</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.13)"><em>Union</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><em>Any</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><em>Sequence</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.13)"><em>Mapping</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.13)"><em>bytes</em></a><em>]</em>) – object or mapping or sequence.</p></li>
<li><p><strong>input_type</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.13)"><em>Union</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Type" title="(in Python v3.13)"><em>Type</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.13)"><em>Tuple</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Type" title="(in Python v3.13)"><em>Type</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><em>Any</em></a><em>]</em><em>, </em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><em>Any</em></a><em>]</em><em>]</em>) – data type of <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p></li>
<li><p><strong>func</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><em>Callable</em></a>) – the function to apply on <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.13)"><em>Union</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><em>Any</em></a>, <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><em>Sequence</em></a>, <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.13)"><em>Mapping</em></a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.13)">bytes</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ignite.utils.convert_tensor">
<span class="sig-prename descclassname"><span class="pre">ignite.utils.</span></span><span class="sig-name descname"><span class="pre">convert_tensor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">non_blocking</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ignite/utils.html#convert_tensor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ignite.utils.convert_tensor" title="Permalink to this definition">#</a></dt>
<dd><p>Move tensors to relevant device.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.13)"><em>Union</em></a><em>[</em><a class="reference external" href="https://pytorch.org/docs/stable/tensors.html#torch.Tensor" title="(in PyTorch v2.6)"><em>Tensor</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><em>Sequence</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.13)"><em>Mapping</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.13)"><em>bytes</em></a><em>]</em>) – input tensor or mapping, or sequence of tensors.</p></li>
<li><p><strong>device</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.13)"><em>Union</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><a class="reference external" href="https://pytorch.org/docs/stable/tensor_attributes.html#torch.device" title="(in PyTorch v2.6)"><em>device</em></a><em>]</em><em>]</em>) – device type to move <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p></li>
<li><p><strong>non_blocking</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – convert a CPU Tensor with pinned memory to a CUDA Tensor
asynchronously with respect to the host if possible</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.13)"><em>Union</em></a>[<a class="reference external" href="https://pytorch.org/docs/stable/tensors.html#torch.Tensor" title="(in PyTorch v2.6)"><em>Tensor</em></a>, <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><em>Sequence</em></a>, <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.13)"><em>Mapping</em></a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.13)">bytes</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ignite.utils.hash_checkpoint">
<span class="sig-prename descclassname"><span class="pre">ignite.utils.</span></span><span class="sig-name descname"><span class="pre">hash_checkpoint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">checkpoint_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ignite/utils.html#hash_checkpoint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ignite.utils.hash_checkpoint" title="Permalink to this definition">#</a></dt>
<dd><p>Hash the checkpoint file in the format of <code class="docutils literal notranslate"><span class="pre"><filename>-<hash>.<ext></span></code>
to be used with <code class="docutils literal notranslate"><span class="pre">check_hash</span></code> of <a class="reference external" href="https://pytorch.org/docs/stable/hub.html#torch.hub.load_state_dict_from_url" title="(in PyTorch v2.6)"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.hub.load_state_dict_from_url()</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>checkpoint_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.13)"><em>Union</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.13)"><em>Path</em></a><em>]</em>) – Path to the checkpoint file.</p></li>
<li><p><strong>output_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.13)"><em>Union</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.13)"><em>Path</em></a><em>]</em>) – Output directory to store the hashed checkpoint file
(will be created if not exist).</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Path to the hashed checkpoint file, the first 8 digits of SHA256 hash.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.13)"><em>Tuple</em></a>[<a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.13)"><em>Path</em></a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>]</p>
</dd>
</dl>
<div class="versionadded">
<p><span class="versionmodified added">New in version 0.4.8.</span></p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ignite.utils.manual_seed">
<span class="sig-prename descclassname"><span class="pre">ignite.utils.</span></span><span class="sig-name descname"><span class="pre">manual_seed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ignite/utils.html#manual_seed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ignite.utils.manual_seed" title="Permalink to this definition">#</a></dt>
<dd><p>Setup random state from a seed for <cite>torch</cite>, <cite>random</cite> and optionally <cite>numpy</cite> (if can be imported).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – Random state seed</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>None</p>
</dd>
</dl>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 0.4.3: </span>Added <code class="docutils literal notranslate"><span class="pre">torch.cuda.manual_seed_all(seed)</span></code>.</p>
</div>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 0.4.5: </span>Added <code class="docutils literal notranslate"><span class="pre">torch_xla.core.xla_model.set_rng_state(seed)</span></code>.</p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ignite.utils.setup_logger">
<span class="sig-prename descclassname"><span class="pre">ignite.utils.</span></span><span class="sig-name descname"><span class="pre">setup_logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'ignite'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'%(asctime)s</span> <span class="pre">%(name)s</span> <span class="pre">%(levelname)s:</span> <span class="pre">%(message)s'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filepath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">distributed_rank</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'utf-8'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ignite/utils.html#setup_logger"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ignite.utils.setup_logger" title="Permalink to this definition">#</a></dt>
<dd><p>Setups logger: name, level, format etc.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>]</em>) – new name for the logger. If None, the standard logger is used.</p></li>
<li><p><strong>level</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – logging level, e.g. CRITICAL, ERROR, WARNING, INFO, DEBUG.</p></li>
<li><p><strong>stream</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TextIO" title="(in Python v3.13)"><em>TextIO</em></a><em>]</em>) – logging stream. If None, the standard stream is used (sys.stderr).</p></li>
<li><p><strong>format</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – logging format. By default, <cite>%(asctime)s %(name)s %(levelname)s: %(message)s</cite>.</p></li>
<li><p><strong>filepath</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>]</em>) – Optional logging file path. If not None, logs are written to the file.</p></li>
<li><p><strong>distributed_rank</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em>) – Optional, rank in distributed configuration to avoid logger setup for workers.
If None, distributed_rank is initialized to the rank of process.</p></li>
<li><p><strong>reset</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – if True, reset an existing logger rather than keep format, handlers, and level.</p></li>
<li><p><strong>encoding</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>]</em>) – open the file with the encoding. By default, ‘utf-8’.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>logging.Logger</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.13)"><em>Logger</em></a></p>
</dd>
</dl>
<p class="rubric">Examples</p>
<p>Improve logs readability when training with a trainer and evaluator:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">ignite.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">setup_logger</span>
<span class="n">trainer</span> <span class="o">=</span> <span class="o">...</span>
<span class="n">evaluator</span> <span class="o">=</span> <span class="o">...</span>
<span class="n">trainer</span><span class="o">.</span><span class="n">logger</span> <span class="o">=</span> <span class="n">setup_logger</span><span class="p">(</span><span class="s2">"trainer"</span><span class="p">)</span>
<span class="n">evaluator</span><span class="o">.</span><span class="n">logger</span> <span class="o">=</span> <span class="n">setup_logger</span><span class="p">(</span><span class="s2">"evaluator"</span><span class="p">)</span>
<span class="n">trainer</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">max_epochs</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
<span class="c1"># Logs will look like</span>
<span class="c1"># 2020-01-21 12:46:07,356 trainer INFO: Engine run starting with max_epochs=5.</span>
<span class="c1"># 2020-01-21 12:46:07,358 trainer INFO: Epoch[1] Complete. Time taken: 00:5:23</span>
<span class="c1"># 2020-01-21 12:46:07,358 evaluator INFO: Engine run starting with max_epochs=1.</span>
<span class="c1"># 2020-01-21 12:46:07,358 evaluator INFO: Epoch[1] Complete. Time taken: 00:01:02</span>
<span class="c1"># ...</span>
</pre></div>
</div>
<p>Every existing logger can be reset if needed</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">logger</span> <span class="o">=</span> <span class="n">setup_logger</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"my-logger"</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s2">"=== </span><span class="si">%(name)s</span><span class="s2"> </span><span class="si">%(message)s</span><span class="s2">"</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"first message"</span><span class="p">)</span>
<span class="n">setup_logger</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"my-logger"</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s2">"+++ </span><span class="si">%(name)s</span><span class="s2"> </span><span class="si">%(message)s</span><span class="s2">"</span><span class="p">,</span> <span class="n">reset</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"second message"</span><span class="p">)</span>
<span class="c1"># Logs will look like</span>
<span class="c1"># === my-logger first message</span>
<span class="c1"># +++ my-logger second message</span>
</pre></div>
</div>
<p>Change the level of an existing internal logger</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">setup_logger</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"ignite.distributed.launcher.Parallel"</span><span class="p">,</span>
<span class="n">level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">WARNING</span>
<span class="p">)</span>
</pre></div>
</div>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 0.4.3: </span>Added <code class="docutils literal notranslate"><span class="pre">stream</span></code> parameter.</p>
</div>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 0.4.5: </span>Added <code class="docutils literal notranslate"><span class="pre">reset</span></code> parameter.</p>
</div>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 0.5.1: </span>Argument <code class="docutils literal notranslate"><span class="pre">encoding</span></code> added to correctly handle special characters in the file, default “utf-8”.</p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ignite.utils.to_onehot">
<span class="sig-prename descclassname"><span class="pre">ignite.utils.</span></span><span class="sig-name descname"><span class="pre">to_onehot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indices</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_classes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ignite/utils.html#to_onehot"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ignite.utils.to_onehot" title="Permalink to this definition">#</a></dt>
<dd><p>Convert a tensor of indices of any shape <cite>(N, …)</cite> to a
tensor of one-hot indicators of shape <cite>(N, num_classes, …)</cite> and of type uint8. Output’s device is equal to the
input’s device`.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>indices</strong> (<a class="reference external" href="https://pytorch.org/docs/stable/tensors.html#torch.Tensor" title="(in PyTorch v2.6)"><em>Tensor</em></a>) – input tensor to convert.</p></li>
<li><p><strong>num_classes</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – number of classes for one-hot tensor.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://pytorch.org/docs/stable/tensors.html#torch.Tensor" title="(in PyTorch v2.6)"><em>Tensor</em></a></p>
</dd>
</dl>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 0.4.3: </span>This functions is now torchscriptable.</p>
</div>
</dd></dl>
</section>
</article>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="contrib/engines.html" class="btn btn-neutral float-right" title="ignite.contrib.engines" accesskey="n" rel="next">Next
<img src="_static/images/chevron-right-orange.svg" alt="right arrow" class="next-page">
</a>
<a href="exceptions.html" class="btn btn-neutral" title="ignite.exceptions" accesskey="p" rel="prev">
<img src="_static/images/chevron-right-orange.svg" alt="left arrow" class="previous-page"> Previous
</a>
</div>
<hr>
<div role="contentinfo">
<table>
<tr>
<td>
<p>
© Copyright 2025, PyTorch-Ignite Contributors.
Last updated on 03/13/2021, 9:35:51 PM.
</p>
<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>
</td>
<td>
<div>
<a href="https://www.netlify.com" target="_blank" rel="noopener noreferrer">
<img
src="_static/img/netlify-light.svg"
alt="Deploys by Netlify"
width=114
height=51 />
</a>
</div>
</td>
</tr>
</table>
</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="#">ignite.utils</a><ul>
<li><a class="reference internal" href="#ignite.utils.apply_to_tensor"><code class="docutils literal notranslate"><span class="pre">apply_to_tensor()</span></code></a></li>
<li><a class="reference internal" href="#ignite.utils.apply_to_type"><code class="docutils literal notranslate"><span class="pre">apply_to_type()</span></code></a></li>
<li><a class="reference internal" href="#ignite.utils.convert_tensor"><code class="docutils literal notranslate"><span class="pre">convert_tensor()</span></code></a></li>
<li><a class="reference internal" href="#ignite.utils.hash_checkpoint"><code class="docutils literal notranslate"><span class="pre">hash_checkpoint()</span></code></a></li>
<li><a class="reference internal" href="#ignite.utils.manual_seed"><code class="docutils literal notranslate"><span class="pre">manual_seed()</span></code></a></li>
<li><a class="reference internal" href="#ignite.utils.setup_logger"><code class="docutils literal notranslate"><span class="pre">setup_logger()</span></code></a></li>
<li><a class="reference internal" href="#ignite.utils.to_onehot"><code class="docutils literal notranslate"><span class="pre">to_onehot()</span></code></a></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/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script>let toggleHintShow = 'Show default setup';</script>
<script>let toggleHintHide = 'Hide default setup';</script>
<script>let toggleOpenOnPrint = 'true';</script>
<script src="_static/togglebutton.js"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script src="_static/design-tabs.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 type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<!-- Begin Footer -->
<!-- commented out for Ignite -->
<div class="container-fluid docs-tutorials-resources" id="docs-tutorials-resources">
<!-- <div class="container">
<div class="row">
<div class="text-center col-md-4">
<h2>Docs</h2>
<p>Access comprehensive developer documentation for PyTorch</p>
<a class="with-right-arrow" href="https://pytorch.org/ignite/index.html">View Docs</a>
</div>
<div class="text-center col-md-4">
<h2>Tutorials</h2>
<p>Get in-depth tutorials for beginners and advanced developers</p>
<a class="with-right-arrow" href="">View Tutorials</a>
</div>
<div class="text-center col-md-4">
<h2>Resources</h2>
<p>Find development resources and get your questions answered</p>
<a class="with-right-arrow" href="">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-ignite.ai" class="footer-logo"></a>
</div>
<div class="footer-links-wrapper">
<div class="footer-links-col">
<ul>
<li class="list-title"><a href="https://pytorch-ignite.ai">PyTorch</a></li>
<li><a href="">Get Started</a></li>
<li><a href="">Features</a></li>
<li><a href="">Ecosystem</a></li>
<li><a href="">Blog</a></li>
<li><a href="">Resources</a></li>
</ul>
</div>
<div class="footer-links-col">
<ul>
<li class="list-title"><a href="">Support</a></li>
<li><a href="">Tutorials</a></li>
<li><a href="https://pytorch.org/ignite/index.html">Docs</a></li>
<li><a href="" target="_blank">Discuss</a></li>
<li><a href="https://github.com/pytorch/ignite/issues" target="_blank">Github Issues</a></li>
<li><a href="" target="_blank">Slack</a></li>
<li><a href="https://github.com/pytorch/ignite/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
</ul>
</div>
<div class="footer-links-col follow-us-col">
<ul>
<li class="list-title">Follow Us</li>
<li>
<div id="mc_embed_signup">
<form
action="https://twitter.us14.list-manage.com/subscribe/post?u=75419c71fe0a935e53dfa4a3f&id=91d0dccd39"
method="post"
id="mc-embedded-subscribe-form"
name="mc-embedded-subscribe-form"
class="email-subscribe-form validate"
target="_blank"
novalidate>
<div id="mc_embed_signup_scroll" class="email-subscribe-form-fields-wrapper">
<div class="mc-field-group">
<label for="mce-EMAIL" style="display:none;">Email Address</label>
<input type="email" value="" name="EMAIL" class="required email" id="mce-EMAIL" placeholder="Email Address">
</div>
<div id="mce-responses" class="clear">
<div class="response" id="mce-error-response" style="display:none"></div>
<div class="response" id="mce-success-response" style="display:none"></div>
</div> <!~~ real people should not fill this in and expect good things - do not remove this or risk form bot signups ~~>
<div style="position: absolute; left: -5000px;" aria-hidden="true"><input type="text" name="b_75419c71fe0a935e53dfa4a3f_91d0dccd39" tabindex="-1" value=""></div>
<div class="clear">
<input type="submit" value="" name="subscribe" id="mc-embedded-subscribe" class="button email-subscribe-button">
</div>
</div>
</form>
</div>
</li>
</ul>
<div class="footer-social-icons">
<a href="" target="_blank" class="facebook"></a>
<a href="" target="_blank" class="twitter"></a>
</div>
</div>
</div>
</div>
</footer> -->
<!-- end of commented out for Ignite -->
<!-- <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-ignite.ai" 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="#">Get Started</a>
</li>
<li>
<a href="#">Features</a>
</li>
<li>
<a href="#">Ecosystem</a>
</li>
<li>
<a href="">Blog</a>
</li>
<li>
<a href="">Tutorials</a>
</li>
<li>
<a href="https://pytorch.org/ignite/index.html">Docs</a>
</li>
<li>
<a href="">Resources</a>
</li>
<li>
<a href="https://github.com/pytorch/ignite">Github</a>
</li>
</ul>
</div>
</div>
</div>
-->
<!-- End Mobile Menu -->
<script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
<script type="text/javascript">
var collapsedSections = []
$(document).ready(function() {
mobileMenu.bind();
mobileTOC.bind();
pytorchAnchors.bind();
sideMenus.bind();
scrollToAnchor.bind();
highlightNavigation.bind();
// Add class to links that have code blocks, since we cannot create links in code blocks
$("article.pytorch-article a span.pre").each(function(e) {
$(this).closest("a").addClass("has-code");
});
})
</script>
<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3"></script>
<script type="text/javascript">
let VERSION
if ('v0.5.1'.startsWith('v')) {
VERSION = 'v0.5.1'
} else {
VERSION = 'master'
}
docsearch({
container: '#docsearch',
appId: '7EWYE1JCT3',
apiKey: '841e93e60c16975ba1bd8c7c716eed82',
indexName: 'pytorch-ignite',
placeholder: 'Search PyTorch-Ignite docs',
searchParameters: {
facetFilters: [`version:${VERSION}`, 'tags:API-reference'],
}
});
</script>
</body>
</html>