11
2+
23<!DOCTYPE html>
34
45
5- < html lang =" en " data-content_root =" ../ " >
6+ < html >
67
78 < head >
89 < meta charset ="utf-8 " />
1314
1415 < script data-cfasync ="false ">
1516 document . documentElement . dataset . mode = localStorage . getItem ( "mode" ) || "" ;
16- document . documentElement . dataset . theme = localStorage . getItem ( "theme" ) || "" ;
17+ document . documentElement . dataset . theme = localStorage . getItem ( "theme" ) || "light " ;
1718 </ script >
1819
1920 <!-- Loaded before other Sphinx assets -->
20- < link href ="../_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b " rel ="stylesheet " />
21- < link href ="../_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b " rel ="stylesheet " />
22- < link href ="../_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b " rel ="stylesheet " />
21+ < link href ="../_static/styles/theme.css?digest=e353d410970836974a52 " rel ="stylesheet " />
22+ < link href ="../_static/styles/bootstrap.css?digest=e353d410970836974a52 " rel ="stylesheet " />
23+ < link href ="../_static/styles/pydata-sphinx-theme.css?digest=e353d410970836974a52 " rel ="stylesheet " />
2324
2425
25- < link href ="../_static/vendor/fontawesome/6.5 .2/css/all.min.css?digest=dfe6caa3a7d634c4db9b " rel ="stylesheet " />
26- < link rel ="preload " as ="font " type ="font/woff2 " crossorigin href ="../_static/vendor/fontawesome/6.5 .2/webfonts/fa-solid-900.woff2 " />
27- < link rel ="preload " as ="font " type ="font/woff2 " crossorigin href ="../_static/vendor/fontawesome/6.5 .2/webfonts/fa-brands-400.woff2 " />
28- < link rel ="preload " as ="font " type ="font/woff2 " crossorigin href ="../_static/vendor/fontawesome/6.5 .2/webfonts/fa-regular-400.woff2 " />
26+ < link href ="../_static/vendor/fontawesome/6.1 .2/css/all.min.css?digest=e353d410970836974a52 " rel ="stylesheet " />
27+ < link rel ="preload " as ="font " type ="font/woff2 " crossorigin href ="../_static/vendor/fontawesome/6.1 .2/webfonts/fa-solid-900.woff2 " />
28+ < link rel ="preload " as ="font " type ="font/woff2 " crossorigin href ="../_static/vendor/fontawesome/6.1 .2/webfonts/fa-brands-400.woff2 " />
29+ < link rel ="preload " as ="font " type ="font/woff2 " crossorigin href ="../_static/vendor/fontawesome/6.1 .2/webfonts/fa-regular-400.woff2 " />
2930
30- < link rel ="stylesheet " type ="text/css " href ="../_static/pygments.css?v=8f2a1f02 " />
31- < link rel ="stylesheet " type =" text/css " href ="../_static/styles/sphinx-book-theme.css?v=eba8b062 " />
31+ < link rel ="stylesheet " type ="text/css " href ="../_static/pygments.css " />
32+ < link rel ="stylesheet " href ="../_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285 " type =" text/css " />
3233
3334 <!-- Pre-loaded scripts that we'll load fully later -->
34- < link rel ="preload " as ="script " href ="../_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b " />
35- < link rel ="preload " as ="script " href ="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b " />
36- < script src =" ../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b " > </ script >
37-
38- < script src ="../_static/documentation_options .js?v=9eb32ce0 "> </ script >
39- < script src ="../_static/doctools .js?v=9a2dae69 "> </ script >
40- < script src ="../_static/sphinx_highlight .js?v=dc90522c "> </ script >
41- < script src ="../_static/scripts/sphinx-book-theme.js?v=887ef09a "> </ script >
35+ < link rel ="preload " as ="script " href ="../_static/scripts/bootstrap.js?digest=e353d410970836974a52 " />
36+ < link rel ="preload " as ="script " href ="../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52 " />
37+
38+ < script data-url_root =" ../ " id =" documentation_options " src =" ../_static/documentation_options.js " > </ script >
39+ < script src ="../_static/jquery .js "> </ script >
40+ < script src ="../_static/underscore .js "> </ script >
41+ < script src ="../_static/doctools .js "> </ script >
42+ < script src ="../_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824 "> </ script >
4243 < script > DOCUMENTATION_OPTIONS . pagename = '_modules/compressai' ; </ script >
4344 < link rel ="index " title ="Index " href ="../genindex.html " />
4445 < link rel ="search " title ="Search " href ="../search.html " />
4546 < meta name ="viewport " content ="width=device-width, initial-scale=1 "/>
46- < meta name ="docsearch:language " content ="en "/>
47+ < meta name ="docsearch:language " content ="None "/>
4748 </ head >
4849
4950
5051 < body data-bs-spy ="scroll " data-bs-target =".bd-toc-nav " data-offset ="180 " data-bs-root-margin ="0px 0px -60% " data-default-mode ="">
5152
5253
5354
54- < div id ="pst-skip-link " class ="skip-link d-print-none "> < a href ="#main-content "> Skip to main content</ a > </ div >
55-
56- < div id ="pst-scroll-pixel-helper "> </ div >
57-
58- < button type ="button " class ="btn rounded-pill " id ="pst-back-to-top ">
59- < i class ="fa-solid fa-arrow-up "> </ i > Back to top</ button >
60-
55+ < a class ="skip-link " href ="#main-content "> Skip to main content</ a >
6156
6257 < input type ="checkbox "
6358 class ="sidebar-toggle "
64- id ="pst-primary-sidebar-checkbox "/>
65- < label class ="overlay overlay-primary " for ="pst-primary-sidebar-checkbox "> </ label >
59+ name ="__primary "
60+ id ="__primary "/>
61+ < label class ="overlay overlay-primary " for ="__primary "> </ label >
6662
6763 < input type ="checkbox "
6864 class ="sidebar-toggle "
69- id ="pst-secondary-sidebar-checkbox "/>
70- < label class ="overlay overlay-secondary " for ="pst-secondary-sidebar-checkbox "> </ label >
65+ name ="__secondary "
66+ id ="__secondary "/>
67+ < label class ="overlay overlay-secondary " for ="__secondary "> </ label >
7168
7269 < div class ="search-button__wrapper ">
7370 < div class ="search-button__overlay "> </ div >
8986 < span class ="search-button__kbd-shortcut "> < kbd class ="kbd-shortcut__modifier "> Ctrl</ kbd > +< kbd > K</ kbd > </ span >
9087</ form > </ div >
9188 </ div >
92-
93- < div class ="pst-async-banner-revealer d-none ">
94- < aside id ="bd-header-version-warning " class ="d-none d-print-none " aria-label ="Version warning "> </ aside >
95- </ div >
96-
9789
98- < header class ="bd-header navbar navbar-expand-lg bd-navbar d-print-none ">
99- </ header >
90+ < nav class ="bd-header navbar navbar-expand-lg bd-navbar ">
91+ </ nav >
10092
101-
10293 < div class ="bd-container ">
10394 < div class ="bd-container__inner bd-page-width ">
10495
105-
106-
107-
108-
10996 < div class ="bd-sidebar-primary bd-sidebar ">
11097
11198
119106
120107 < div class ="sidebar-primary-items__start sidebar-primary__section ">
121108 < div class ="sidebar-primary-item ">
122-
123-
124-
125109
126110
127111< a class ="navbar-brand logo " href ="../index.html ">
128112
129113
130114
131115
132-
133116
134117
135118
136119
137120
138- < img src ="../_static/logo.svg " class ="logo__image only-light " alt ="CompressAI - Home "/>
139- < script > document . write ( `<img src="../_static/logo.svg" class="logo__image only-dark" alt="CompressAI - Home "/>` ) ; </ script >
121+ < img src ="../_static/logo.svg " class ="logo__image only-light " alt ="Logo image "/>
122+ < script > document . write ( `<img src="../_static/logo.svg" class="logo__image only-dark" alt="Logo image "/>` ) ; </ script >
140123
141124
142125</ a > </ div >
143- < div class ="sidebar-primary-item ">
144-
145- < script >
146- document . write ( `
147- <button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
148- <i class="fa-solid fa-magnifying-glass"></i>
149- <span class="search-button__default-text">Search</span>
150- <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
151- </button>
152- ` ) ;
153- </ script > </ div >
154- < div class ="sidebar-primary-item "> < nav class ="bd-links bd-docs-nav " aria-label ="Main ">
126+ < div class ="sidebar-primary-item "> < nav class ="bd-links " id ="bd-docs-nav " aria-label ="Main ">
155127 < div class ="bd-toc-item navbar-nav active ">
156128 < ul class ="nav bd-sidenav ">
157129< li class ="toctree-l1 "> < a class ="reference internal " href ="../intro.html "> Introduction</ a > </ li >
202174
203175 </ div >
204176
205- < main id ="main-content " class ="bd-main " role =" main " >
177+ < main id ="main-content " class ="bd-main ">
206178
207179
208180
211183 < div class ="bd-content ">
212184 < div class ="bd-article-container ">
213185
214- < div class ="bd-header-article d-print-none ">
186+ < div class ="bd-header-article ">
215187< div class ="header-article-items header-article__inner ">
216188
217189 < div class ="header-article-items__start ">
218190
219- < div class ="header-article-item "> < button class ="sidebar-toggle primary-toggle btn btn-sm " title ="Toggle primary sidebar " data-bs-placement ="bottom " data-bs-toggle ="tooltip ">
191+ < div class ="header-article-item "> < label class ="sidebar-toggle primary-toggle btn btn-sm " for =" __primary " title ="Toggle primary sidebar " data-bs-placement ="bottom " data-bs-toggle ="tooltip ">
220192 < span class ="fa-solid fa-bars "> </ span >
221- </ button > </ div >
193+ </ label > </ div >
222194
223195 </ div >
224196
244216</ a >
245217
246218
247-
248219< script >
249220document . write ( `
250- <button class="btn btn-sm nav-link pst- navbar-icon theme-switch-button " title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
251- <i class="theme-switch fa-solid fa-sun fa-lg " data-mode="light"></i >
252- <i class="theme-switch fa-solid fa-moon fa-lg " data-mode="dark"></i >
253- <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" ></i>
221+ <button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle " title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
222+ <span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span >
223+ <span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span >
224+ <span class="theme-switch" data-mode="auto"><i class=" fa-solid fa-circle-half-stroke" ></i></span >
254225 </button>
255226` ) ;
256227</ script >
257228
258-
259229< script >
260230document . write ( `
261- <button class="btn btn-sm pst- navbar-icon search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
262- <i class="fa-solid fa-magnifying-glass fa-lg "></i>
231+ <button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
232+ <i class="fa-solid fa-magnifying-glass"></i>
263233 </button>
264234` ) ;
265235</ script >
@@ -286,7 +256,7 @@ <h1></h1>
286256
287257
288258< div id ="searchbox "> </ div >
289- < article class ="bd-article ">
259+ < article class ="bd-article " role =" main " >
290260
291261 < h1 > Source code for compressai</ h1 > < div class ="highlight "> < pre >
292262< span > </ span > < span class ="c1 "> # Copyright (c) 2021-2024, InterDigital Communications, Inc</ span >
@@ -349,9 +319,7 @@ <h1>Source code for compressai</h1><div class="highlight"><pre>
349319 < span class ="k "> pass</ span >
350320
351321
352- < div class ="viewcode-block " id ="set_entropy_coder ">
353- < a class ="viewcode-back " href ="../compressai.html#compressai.set_entropy_coder "> [docs]</ a >
354- < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> set_entropy_coder</ span > < span class ="p "> (</ span > < span class ="n "> entropy_coder</ span > < span class ="p "> ):</ span >
322+ < div class ="viewcode-block " id ="set_entropy_coder "> < a class ="viewcode-back " href ="../compressai.html#compressai.set_entropy_coder "> [docs]</ a > < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> set_entropy_coder</ span > < span class ="p "> (</ span > < span class ="n "> entropy_coder</ span > < span class ="p "> ):</ span >
355323< span class ="w "> </ span > < span class ="sd "> """</ span >
356324< span class ="sd "> Specifies the default entropy coder used to encode the bit-streams.</ span >
357325
@@ -369,27 +337,20 @@ <h1>Source code for compressai</h1><div class="highlight"><pre>
369337 < span class ="n "> _entropy_coder</ span > < span class ="o "> =</ span > < span class ="n "> entropy_coder</ span > </ div >
370338
371339
372-
373- < div class ="viewcode-block " id ="get_entropy_coder ">
374- < a class ="viewcode-back " href ="../compressai.html#compressai.get_entropy_coder "> [docs]</ a >
375- < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> get_entropy_coder</ span > < span class ="p "> ():</ span >
340+ < div class ="viewcode-block " id ="get_entropy_coder "> < a class ="viewcode-back " href ="../compressai.html#compressai.get_entropy_coder "> [docs]</ a > < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> get_entropy_coder</ span > < span class ="p "> ():</ span >
376341< span class ="w "> </ span > < span class ="sd "> """</ span >
377342< span class ="sd "> Return the name of the default entropy coder used to encode the bit-streams.</ span >
378343< span class ="sd "> """</ span >
379344 < span class ="k "> return</ span > < span class ="n "> _entropy_coder</ span > </ div >
380345
381346
382-
383- < div class ="viewcode-block " id ="available_entropy_coders ">
384- < a class ="viewcode-back " href ="../compressai.html#compressai.available_entropy_coders "> [docs]</ a >
385- < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> available_entropy_coders</ span > < span class ="p "> ():</ span >
347+ < div class ="viewcode-block " id ="available_entropy_coders "> < a class ="viewcode-back " href ="../compressai.html#compressai.available_entropy_coders "> [docs]</ a > < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> available_entropy_coders</ span > < span class ="p "> ():</ span >
386348< span class ="w "> </ span > < span class ="sd "> """</ span >
387349< span class ="sd "> Return the list of available entropy coders.</ span >
388350< span class ="sd "> """</ span >
389351 < span class ="k "> return</ span > < span class ="n "> _available_entropy_coders</ span > </ div >
390352
391353
392-
393354< span class ="n "> __all__</ span > < span class ="o "> =</ span > < span class ="p "> [</ span >
394355 < span class ="s2 "> "datasets"</ span > < span class ="p "> ,</ span >
395356 < span class ="s2 "> "entropy_models"</ span > < span class ="p "> ,</ span >
@@ -414,12 +375,16 @@ <h1>Source code for compressai</h1><div class="highlight"><pre>
414375
415376
416377
417-
418-
419- < footer class ="prev-next-footer d-print-none ">
378+ < footer class ="bd-footer-article ">
420379
380+ < div class ="footer-article-items footer-article__inner ">
381+
382+ < div class ="footer-article-item "> <!-- Previous / next buttons -->
421383< div class ="prev-next-area ">
384+ </ div > </ div >
385+
422386</ div >
387+
423388 </ footer >
424389
425390 </ div >
@@ -442,7 +407,6 @@ <h1>Source code for compressai</h1><div class="highlight"><pre>
442407
443408 < div class ="footer-item ">
444409
445-
446410 < p class ="copyright ">
447411
448412 © Copyright 2021, InterDigital Communications, Inc.
@@ -469,8 +433,8 @@ <h1>Source code for compressai</h1><div class="highlight"><pre>
469433 </ div >
470434
471435 <!-- Scripts loaded after <body> so the DOM is not blocked -->
472- < script src ="../_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b "> </ script >
473- < script src ="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b "> </ script >
436+ < script src ="../_static/scripts/bootstrap.js?digest=e353d410970836974a52 "> </ script >
437+ < script src ="../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52 "> </ script >
474438
475439 < footer class ="bd-footer ">
476440 </ footer >
0 commit comments