From 8ab4b3c257048480868bc3c0e6d30291cb2475f5 Mon Sep 17 00:00:00 2001 From: Dave Welsch Date: Tue, 5 Nov 2024 15:50:05 -0800 Subject: [PATCH 1/4] Set up folder structure and stubs for beta doc site using furo theme. Squash merge Includes: - Fill out folder structure for all TOC sections. Complete AdaRound example. - Make beta doc build optional for agile development. - Stripped beta piccolo theme CSS down to only modifications of the stock theme CSS. - Swap in furo theme for look & feel and right-side menu. - Refine furo theme options. - More mods to furo theme. Set up index for API ref. Signed-off-by: Dave Welsch --- Docs/beta/_static/aimet-furo.css | 32 + Docs/beta/_static/furo-extensions.css | 154 ++ Docs/beta/_static/furo.css | 2402 +++++++++++++++++ Docs/beta/_static/style.css | 1221 --------- Docs/beta/_templates/brand.html | 31 + Docs/beta/_templates/ethical-ads.html | 10 + Docs/beta/_templates/navigation.html | 3 + Docs/beta/_templates/rtd-versions.html | 34 + Docs/beta/_templates/scroll-end.html | 1 + Docs/beta/_templates/scroll-start.html | 1 + Docs/beta/_templates/search.html | 6 + Docs/beta/_templates/variant-selector.html | 33 + Docs/beta/apiref/index.rst | 100 +- Docs/beta/apiref/onnx/adaround.rst | 1 - Docs/beta/apiref/tensorflow/adaround.rst | 1 - Docs/beta/apiref/torch/adaround.rst | 16 +- Docs/beta/conf.py | 62 +- Docs/beta/featureguide/adaround.rst | 77 +- Docs/beta/featureguide/index.rst | 6 +- Docs/beta/images/brain_logo.png | Bin 0 -> 10266 bytes Docs/beta/install/index.rst | 4 +- Docs/beta/rn/index.rst | 4 +- Docs/beta/snippets/torch/apply_adaround.py | 37 - .../torch/create_quantizationsimmodel.py | 39 +- Docs/beta/snippets/torch/evaluate.py | 43 +- Docs/beta/snippets/torch/export.py | 45 +- .../snippets/torch/pass_calibration_data.py | 37 - Docs/beta/snippets/torch/prepare_model.py | 39 +- 28 files changed, 2923 insertions(+), 1516 deletions(-) create mode 100644 Docs/beta/_static/aimet-furo.css create mode 100644 Docs/beta/_static/furo-extensions.css create mode 100644 Docs/beta/_static/furo.css delete mode 100644 Docs/beta/_static/style.css create mode 100644 Docs/beta/_templates/brand.html create mode 100644 Docs/beta/_templates/ethical-ads.html create mode 100644 Docs/beta/_templates/navigation.html create mode 100644 Docs/beta/_templates/rtd-versions.html create mode 100644 Docs/beta/_templates/scroll-end.html create mode 100644 Docs/beta/_templates/scroll-start.html create mode 100644 Docs/beta/_templates/search.html create mode 100644 Docs/beta/_templates/variant-selector.html create mode 100644 Docs/beta/images/brain_logo.png diff --git a/Docs/beta/_static/aimet-furo.css b/Docs/beta/_static/aimet-furo.css new file mode 100644 index 00000000000..be23ee1a89b --- /dev/null +++ b/Docs/beta/_static/aimet-furo.css @@ -0,0 +1,32 @@ + + aside.toc-drawer ul ul ul ul { + display: none; +} + +.toctree-l3 { + display: none; +} + +[for^="toctree-checkbox-"], [id^="toctree-checkbox-"] { + visibility: hidden; +} + +/* +
  • +AIMET Feature Guide + + + +*/ \ No newline at end of file diff --git a/Docs/beta/_static/furo-extensions.css b/Docs/beta/_static/furo-extensions.css new file mode 100644 index 00000000000..d97e9c3765c --- /dev/null +++ b/Docs/beta/_static/furo-extensions.css @@ -0,0 +1,154 @@ +#furo-sidebar-ad-placement{ + padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) +} + +#furo-sidebar-ad-placement .ethical-sidebar{ + background:var(--color-background-secondary);border:none;box-shadow:none +} + +#furo-sidebar-ad-placement .ethical-sidebar:hover{ + background:var(--color-background-hover) +} + +#furo-sidebar-ad-placement .ethical-sidebar a{ + color:var(--color-foreground-primary) +} + +#furo-sidebar-ad-placement .ethical-callout a{ + color:var(--color-foreground-secondary)!important +} + +#furo-readthedocs-versions{ + background:transparent;display:block;position:static;width:100% +} + +#furo-readthedocs-versions .rst-versions{ + background:#1a1c1e +} + +#furo-readthedocs-versions .rst-current-version{ + background:var(--color-sidebar-item-background);cursor:unset +} + +#furo-readthedocs-versions .rst-current-version:hover{ + background:var(--color-sidebar-item-background) +} + +#furo-readthedocs-versions .rst-current-version .fa-book{ + color:var(--color-foreground-primary) +} + +#furo-readthedocs-versions>.rst-other-versions{ + padding:0 +} + +#furo-readthedocs-versions>.rst-other-versions small{ + opacity:1 +} + +#furo-readthedocs-versions .injected .rst-versions{ + position:unset +} + +#furo-readthedocs-versions:focus-within,#furo-readthedocs-versions:hover{ + box-shadow:0 0 0 1px var(--color-sidebar-background-border) +} + +#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:hover .rst-current-version{ + background:#1a1c1e;font-size:inherit;height:auto;line-height:inherit;padding:12px;text-align:right +} + +#furo-readthedocs-versions:focus-within .rst-current-version .fa-book,#furo-readthedocs-versions:hover .rst-current-version .fa-book{ + color:#fff;float:left +} + +#furo-readthedocs-versions:focus-within .fa-caret-down,#furo-readthedocs-versions:hover .fa-caret-down{ + display:none +} + +#furo-readthedocs-versions:focus-within .injected,#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:focus-within .rst-other-versions,#furo-readthedocs-versions:hover .injected,#furo-readthedocs-versions:hover .rst-current-version,#furo-readthedocs-versions:hover .rst-other-versions{ + display:block +} + +#furo-readthedocs-versions:focus-within>.rst-current-version,#furo-readthedocs-versions:hover>.rst-current-version{ + display:none +} + +.highlight:hover button.copybtn{ + color:var(--color-code-foreground) +} + +.highlight button.copybtn{ + align-items:center;background-color:var(--color-code-background);border:none;color:var(--color-background-item);cursor:pointer;height:1.25em;right:.5rem;top:.625rem;transition:color .3s,opacity .3s;width:1.25em +} + +.highlight button.copybtn:hover{ + background-color:var(--color-code-background);color:var(--color-brand-content) +} + +.highlight button.copybtn:after{ + background-color:transparent;color:var(--color-code-foreground);display:none +} + +.highlight button.copybtn.success{ + color:#22863a;transition:color 0ms +} + +.highlight button.copybtn.success:after{ + display:block +} + +.highlight button.copybtn svg{ + padding:0 +} + +body{ + --sd-color-primary:var(--color-brand-primary);--sd-color-primary-highlight:var(--color-brand-content);--sd-color-primary-text:var(--color-background-primary);--sd-color-shadow:rgba(0,0,0,.05);--sd-color-card-border:var(--color-card-border);--sd-color-card-border-hover:var(--color-brand-content);--sd-color-card-background:var(--color-card-background);--sd-color-card-text:var(--color-foreground-primary);--sd-color-card-header:var(--color-card-marginals-background);--sd-color-card-footer:var(--color-card-marginals-background);--sd-color-tabs-label-active:var(--color-brand-content);--sd-color-tabs-label-hover:var(--color-foreground-muted);--sd-color-tabs-label-inactive:var(--color-foreground-muted);--sd-color-tabs-underline-active:var(--color-brand-content);--sd-color-tabs-underline-hover:var(--color-foreground-border);--sd-color-tabs-underline-inactive:var(--color-background-border);--sd-color-tabs-overline:var(--color-background-border);--sd-color-tabs-underline:var(--color-background-border) +} + +.sd-tab-content{ + box-shadow:0 -2px var(--sd-color-tabs-overline),0 1px var(--sd-color-tabs-underline) +} + +.sd-card{ + box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1) +} + +.sd-shadow-sm{ + box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important +} + +.sd-shadow-md{ + box-shadow:0 .3rem .75rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important +} + +.sd-shadow-lg{ + box-shadow:0 .6rem 1.5rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important +} + +.sd-card-hover:hover{ + transform:none +} + +.sd-cards-carousel{ + gap:.25rem;padding:.25rem +} + +body{ + --tabs--label-text:var(--color-foreground-muted);--tabs--label-text--hover:var(--color-foreground-muted);--tabs--label-text--active:var(--color-brand-content);--tabs--label-text--active--hover:var(--color-brand-content);--tabs--label-background:transparent;--tabs--label-background--hover:transparent;--tabs--label-background--active:transparent;--tabs--label-background--active--hover:transparent;--tabs--padding-x:0.25em;--tabs--margin-x:1em;--tabs--border:var(--color-background-border);--tabs--label-border:transparent;--tabs--label-border--hover:var(--color-foreground-muted);--tabs--label-border--active:var(--color-brand-content);--tabs--label-border--active--hover:var(--color-brand-content) +} + +[role=main] .container{ + max-width:none;padding-left:0;padding-right:0 +} + +.shadow.docutils{ + border:none;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)!important +} + +.sphinx-bs .card{ + background-color:var(--color-background-secondary);color:var(--color-foreground) +} + + +/*# sourceMappingURL=furo-extensions.css.map*/ \ No newline at end of file diff --git a/Docs/beta/_static/furo.css b/Docs/beta/_static/furo.css new file mode 100644 index 00000000000..f2010167a15 --- /dev/null +++ b/Docs/beta/_static/furo.css @@ -0,0 +1,2402 @@ +/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */ +html { + line-height: 1.15; + -webkit-text-size-adjust: 100% +} + + body { + margin: 0 +} + + main { + display: block +} + + h1 { + font-size: 2em; + margin: .67em 0 +} + + hr { + box-sizing: content-box; + height: 0; + overflow: visible +} + + pre { + font-family: monospace,monospace; + font-size: 1em +} + + a { + background-color: transparent +} + + abbr[title] { + border-bottom: none; + text-decoration: underline; + text-decoration: underline dotted +} + + b,strong { + font-weight: bolder +} + + code,kbd,samp { + font-family: monospace,monospace; + font-size: 1em +} + + sub,sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline +} + + sub { + bottom: -.25em +} + + sup { + top: -.5em +} + + img { + border-style: none +} + + button,input,optgroup,select,textarea { + font-family: inherit; + font-size: 100%; + line-height: 1.15; + margin: 0 +} + + button,input { + overflow: visible +} + + button,select { + text-transform: none +} + + [type=button],[type=reset],[type=submit],button { + -webkit-appearance: button +} + + [type=button]: :-moz-focus-inner,[type=reset]: :-moz-focus-inner,[type=submit]: :-moz-focus-inner,button: :-moz-focus-inner { + border-style: none; + padding: 0 +} + + [type=button]: -moz-focusring,[type=reset]: -moz-focusring,[type=submit]: -moz-focusring,button: -moz-focusring { + outline: 1px dotted ButtonText +} + + fieldset { + padding: .35em .75em .625em +} + + legend { + box-sizing: border-box; + color: inherit; + display: table; + max-width: 100%; + padding: 0; + white-space: normal +} + + progress { + vertical-align: baseline +} + + textarea { + overflow: auto +} + + [type=checkbox],[type=radio] { + box-sizing: border-box; + padding: 0 +} + + [type=number]: :-webkit-inner-spin-button,[type=number]: :-webkit-outer-spin-button { + height: auto +} + + [type=search] { + -webkit-appearance: textfield; + outline-offset: -2px +} + + [type=search]: :-webkit-search-decoration { + -webkit-appearance: none +} + + : :-webkit-file-upload-button { + -webkit-appearance: button; + font: inherit +} + + details { + display: block +} + + summary { + display: list-item +} + + [hidden],template { + display: none +} + + @media print { + .content-icon-container,.headerlink,.mobile-header,.related-pages { + display: none!important + } + + .highlight { + border: .1pt solid var(--color-foreground-border) + } + + a,blockquote,dl,ol,p,pre,table,ul { + page-break-inside: avoid + } + + caption,figure,h1,h2,h3,h4,h5,h6,img { + page-break-after: avoid; + page-break-inside: avoid + } + + dl,ol,ul { + page-break-before: avoid + } + +} + + .visually-hidden { + height: 1px!important; + margin: -1px!important; + overflow: hidden!important; + padding: 0!important; + position: absolute!important; + width: 1px!important; + clip: rect(0,0,0,0)!important; + background: var(--color-background-primary); + border: 0!important; + color: var(--color-foreground-primary); + white-space: nowrap!important +} + + : -moz-focusring { + outline: auto +} + + body { + --font-stack: -apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji; + --font-stack--monospace: "SFMono-Regular",Menlo,Consolas,Monaco,Liberation Mono,Lucida Console,monospace; + --font-stack--headings: var(--font-stack); + --font-size--normal: 100%; + --font-size--small: 87.5%; + --font-size--small--2: 81.25%; + --font-size--small--3: 75%; + --font-size--small--4: 62.5%; + --sidebar-caption-font-size: var(--font-size--small--2); + --sidebar-item-font-size: var(--font-size--small); + --sidebar-search-input-font-size: var(--font-size--small); + --toc-font-size: var(--font-size--small--3); + --toc-font-size--mobile: var(--font-size--normal); + --toc-title-font-size: var(--font-size--small--4); + --admonition-font-size: 0.8125rem; + --admonition-title-font-size: 0.8125rem; + --code-font-size: var(--font-size--small--2); + --api-font-size: var(--font-size--small); + --header-height: calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*4); + --header-padding: 0.5rem; + --sidebar-tree-space-above: 1.5rem; + --sidebar-caption-space-above: 1rem; + --sidebar-item-line-height: 1rem; + --sidebar-item-spacing-vertical: 0.5rem; + --sidebar-item-spacing-horizontal: 1rem; + --sidebar-item-height: calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*2); + --sidebar-expander-width: var(--sidebar-item-height); + --sidebar-search-space-above: 0.5rem; + --sidebar-search-input-spacing-vertical: 0.5rem; + --sidebar-search-input-spacing-horizontal: 0.5rem; + --sidebar-search-input-height: 1rem; + --sidebar-search-icon-size: var(--sidebar-search-input-height); + --toc-title-padding: 0.25rem 0; + --toc-spacing-vertical: 1.5rem; + --toc-spacing-horizontal: 1.5rem; + --toc-item-spacing-vertical: 0.4rem; + --toc-item-spacing-horizontal: 1rem; + --icon-search: url('data: image/svg+xml; + charset=utf-8,'); + --icon-pencil: url('data: image/svg+xml; + charset=utf-8,'); + --icon-abstract: url('data: image/svg+xml; + charset=utf-8,'); + --icon-info: url('data: image/svg+xml; + charset=utf-8,'); + --icon-flame: url('data: image/svg+xml; + charset=utf-8,'); + --icon-question: url('data: image/svg+xml; + charset=utf-8,'); + --icon-warning: url('data: image/svg+xml; + charset=utf-8,'); + --icon-failure: url('data: image/svg+xml; + charset=utf-8,'); + --icon-spark: url('data: image/svg+xml; + charset=utf-8,'); + --color-admonition-title--caution: #ff9100; + --color-admonition-title-background--caution: rgba(255,145,0,.2); + --color-admonition-title--warning: #ff9100; + --color-admonition-title-background--warning: rgba(255,145,0,.2); + --color-admonition-title--danger: #ff5252; + --color-admonition-title-background--danger: rgba(255,82,82,.2); + --color-admonition-title--attention: #ff5252; + --color-admonition-title-background--attention: rgba(255,82,82,.2); + --color-admonition-title--error: #ff5252; + --color-admonition-title-background--error: rgba(255,82,82,.2); + --color-admonition-title--hint: #00c852; + --color-admonition-title-background--hint: rgba(0,200,82,.2); + --color-admonition-title--tip: #00c852; + --color-admonition-title-background--tip: rgba(0,200,82,.2); + --color-admonition-title--important: #00bfa5; + --color-admonition-title-background--important: rgba(0,191,165,.2); + --color-admonition-title--note: #00b0ff; + --color-admonition-title-background--note: rgba(0,176,255,.2); + --color-admonition-title--seealso: #448aff; + --color-admonition-title-background--seealso: rgba(68,138,255,.2); + --color-admonition-title--admonition-todo: grey; + --color-admonition-title-background--admonition-todo: hsla(0,0%,50%,.2); + --color-admonition-title: #651fff; + --color-admonition-title-background: rgba(101,31,255,.2); + --icon-admonition-default: var(--icon-abstract); + --color-topic-title: #14b8a6; + --color-topic-title-background: rgba(20,184,166,.2); + --icon-topic-default: var(--icon-pencil); + --color-problematic: #b30000; + --color-foreground-primary: #000; + --color-foreground-secondary: #5a5c63; + --color-foreground-muted: #6b6f76; + --color-foreground-border: #878787; + --color-background-primary: #fff; + --color-background-secondary: #f8f9fb; + --color-background-hover: #efeff4; + --color-background-hover--transparent: #efeff400; + --color-background-border: #eeebee; + --color-background-item: #ccc; + --color-announcement-background: #000000dd; + --color-announcement-text: #eeebee; + --color-brand-primary: #0a4bff; + --color-brand-content: #2757dd; + --color-brand-visited: #872ee0; + --color-api-background: var(--color-background-hover--transparent); + --color-api-background-hover: var(--color-background-hover); + --color-api-overall: var(--color-foreground-secondary); + --color-api-name: var(--color-problematic); + --color-api-pre-name: var(--color-problematic); + --color-api-paren: var(--color-foreground-secondary); + --color-api-keyword: var(--color-foreground-primary); + --color-api-added: #21632c; + --color-api-added-border: #38a84d; + --color-api-changed: #046172; + --color-api-changed-border: #06a1bc; + --color-api-deprecated: #605706; + --color-api-deprecated-border: #f0d90f; + --color-api-removed: #b30000; + --color-api-removed-border: #ff5c5c; + --color-highlight-on-target: #ffc; + --color-inline-code-background: var(--color-background-secondary); + --color-highlighted-background: #def; + --color-highlighted-text: var(--color-foreground-primary); + --color-guilabel-background: #ddeeff80; + --color-guilabel-border: #bedaf580; + --color-guilabel-text: var(--color-foreground-primary); + --color-admonition-background: transparent; + --color-table-header-background: var(--color-background-secondary); + --color-table-border: var(--color-background-border); + --color-card-border: var(--color-background-secondary); + --color-card-background: transparent; + --color-card-marginals-background: var(--color-background-secondary); + --color-header-background: var(--color-background-primary); + --color-header-border: var(--color-background-border); + --color-header-text: var(--color-foreground-primary); + --color-sidebar-background: var(--color-background-secondary); + --color-sidebar-background-border: var(--color-background-border); + --color-sidebar-brand-text: var(--color-foreground-primary); + --color-sidebar-caption-text: var(--color-foreground-muted); + --color-sidebar-link-text: var(--color-foreground-secondary); + --color-sidebar-link-text--top-level: var(--color-brand-primary); + --color-sidebar-item-background: var(--color-sidebar-background); + --color-sidebar-item-background--current: var( --color-sidebar-item-background ); + --color-sidebar-item-background--hover: linear-gradient(90deg,var(--color-background-hover--transparent) 0%,var(--color-background-hover) var(--sidebar-item-spacing-horizontal),var(--color-background-hover) 100%); + --color-sidebar-item-expander-background: transparent; + --color-sidebar-item-expander-background--hover: var( --color-background-hover ); + --color-sidebar-search-text: var(--color-foreground-primary); + --color-sidebar-search-background: var(--color-background-secondary); + --color-sidebar-search-background--focus: var(--color-background-primary); + --color-sidebar-search-border: var(--color-background-border); + --color-sidebar-search-icon: var(--color-foreground-muted); + --color-toc-background: var(--color-background-primary); + --color-toc-title-text: var(--color-foreground-muted); + --color-toc-item-text: var(--color-foreground-secondary); + --color-toc-item-text--hover: var(--color-foreground-primary); + --color-toc-item-text--active: var(--color-brand-primary); + --color-content-foreground: var(--color-foreground-primary); + --color-content-background: transparent; + --color-link: var(--color-brand-content); + --color-link-underline: var(--color-background-border); + --color-link--hover: var(--color-brand-content); + --color-link-underline--hover: var(--color-foreground-border); + --color-link--visited: var(--color-brand-visited); + --color-link-underline--visited: var(--color-background-border); + --color-link--visited--hover: var(--color-brand-visited); + --color-link-underline--visited--hover: var(--color-foreground-border) +} + + .only-light { + display: block!important +} + + html body .only-dark { + display: none!important +} + + @media not print { + body[data-theme=dark] { + --color-problematic: #ee5151; + --color-foreground-primary: #cfd0d0; + --color-foreground-secondary: #9ca0a5; + --color-foreground-muted: #81868d; + --color-foreground-border: #666; + --color-background-primary: #131416; + --color-background-secondary: #1a1c1e; + --color-background-hover: #1e2124; + --color-background-hover--transparent: #1e212400; + --color-background-border: #303335; + --color-background-item: #444; + --color-announcement-background: #000000dd; + --color-announcement-text: #eeebee; + --color-brand-primary: #3d94ff; + --color-brand-content: #5ca5ff; + --color-brand-visited: #b27aeb; + --color-highlighted-background: #083563; + --color-guilabel-background: #08356380; + --color-guilabel-border: #13395f80; + --color-api-keyword: var(--color-foreground-secondary); + --color-highlight-on-target: #330; + --color-api-added: #3db854; + --color-api-added-border: #267334; + --color-api-changed: #09b0ce; + --color-api-changed-border: #056d80; + --color-api-deprecated: #b1a10b; + --color-api-deprecated-border: #6e6407; + --color-api-removed: #ff7575; + --color-api-removed-border: #b03b3b; + --color-admonition-background: #18181a; + --color-card-border: var(--color-background-secondary); + --color-card-background: #18181a; + --color-card-marginals-background: var(--color-background-hover) + } + + html body[data-theme=dark] .only-light { + display: none!important + } + + body[data-theme=dark] .only-dark { + display: block!important + } + + @media(prefers-color-scheme: dark) { + body: not([data-theme=light]) {--color-problematic: #ee5151; + --color-foreground-primary: #cfd0d0; + --color-foreground-secondary: #9ca0a5; + --color-foreground-muted: #81868d; + --color-foreground-border: #666; + --color-background-primary: #131416; + --color-background-secondary: #1a1c1e; + --color-background-hover: #1e2124; + --color-background-hover--transparent: #1e212400; + --color-background-border: #303335; + --color-background-item: #444; + --color-announcement-background: #000000dd; + --color-announcement-text: #eeebee; + --color-brand-primary: #3d94ff; + --color-brand-content: #5ca5ff; + --color-brand-visited: #b27aeb; + --color-highlighted-background: #083563; + --color-guilabel-background: #08356380; + --color-guilabel-border: #13395f80; + --color-api-keyword: var(--color-foreground-secondary); + --color-highlight-on-target: #330; + --color-api-added: #3db854; + --color-api-added-border: #267334; + --color-api-changed: #09b0ce; + --color-api-changed-border: #056d80; + --color-api-deprecated: #b1a10b; + --color-api-deprecated-border: #6e6407; + --color-api-removed: #ff7575; + --color-api-removed-border: #b03b3b; + --color-admonition-background: #18181a; + --color-card-border: var(--color-background-secondary); + --color-card-background: #18181a; + --color-card-marginals-background: var(--color-background-hover) +} + + html body: not([data-theme=light]) .only-light { + display: none!important +} + + body: not([data-theme=light]) .only-dark { + display: block!important +} + + +} + + +} + + body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto-light { + display: block +} + + @media(prefers-color-scheme: dark) { + body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto-dark {display: block +} + + body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto-light { + display: none +} + + +} + + body[data-theme=dark] .theme-toggle svg.theme-icon-when-dark,body[data-theme=light] .theme-toggle svg.theme-icon-when-light { + display: block +} + + body { + font-family: var(--font-stack) +} + + code,kbd,pre,samp { + font-family: var(--font-stack--monospace) +} + + body { + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale +} + + article { + line-height: 1.5 +} + + h1,h2,h3,h4,h5,h6 { + border-radius: .5rem; + font-family: var(--font-stack--headings); + font-weight: 700; + line-height: 1.25; + margin: .5rem -.5rem; + padding-left: .5rem; + padding-right: .5rem +} + + h1+p,h2+p,h3+p,h4+p,h5+p,h6+p { + margin-top: 0 +} + + h1 { + font-size: 2.5em; + margin-bottom: 1rem +} + + h1,h2 { + margin-top: 1.75rem +} + + h2 { + font-size: 2em +} + + h3 { + font-size: 1.5em +} + + h4 { + font-size: 1.25em +} + + h5 { + font-size: 1.125em +} + + h6 { + font-size: 1em +} + + small { + font-size: 80%; + opacity: 75% +} + + p { + margin-bottom: .75rem; + margin-top: .5rem +} + + hr.docutils { + background-color: var(--color-background-border); + border: 0; + height: 1px; + margin: 2rem 0; + padding: 0 +} + + .centered { + text-align: center +} + + a { + color: var(--color-link); + text-decoration: underline; + text-decoration-color: var(--color-link-underline) +} + + a: visited { + color: var(--color-link--visited); + text-decoration-color: var(--color-link-underline--visited) +} + + a: visited: hover { + color: var(--color-link--visited--hover); + text-decoration-color: var(--color-link-underline--visited--hover) +} + + a: hover { + color: var(--color-link--hover); + text-decoration-color: var(--color-link-underline--hover) +} + + a.muted-link { + color: inherit +} + + a.muted-link: hover { + color: var(--color-link--hover); + text-decoration-color: var(--color-link-underline--hover) +} + + a.muted-link: hover: visited { + color: var(--color-link--visited--hover); + text-decoration-color: var(--color-link-underline--visited--hover) +} + + html { + overflow-x: hidden; + overflow-y: scroll; + scroll-behavior: smooth +} + + .sidebar-scroll,.toc-scroll,article[role=main] * { + scrollbar-color: var(--color-foreground-border) transparent; + scrollbar-width: thin +} + + .sidebar-scroll: :-webkit-scrollbar,.toc-scroll: :-webkit-scrollbar,article[role=main] : :-webkit-scrollbar { + height: .25rem; + width: .25rem +} + + .sidebar-scroll: :-webkit-scrollbar-thumb,.toc-scroll: :-webkit-scrollbar-thumb,article[role=main] : :-webkit-scrollbar-thumb { + background-color: var(--color-foreground-border); + border-radius: .125rem +} + + body,html { + height: 100% +} + + .skip-to-content,body,html { + background: var(--color-background-primary); + color: var(--color-foreground-primary) +} + + .skip-to-content { + border-radius: 1rem; + left: .25rem; + padding: 1rem; + position: fixed; + top: .25rem; + transform: translateY(-200%); + transition: transform .3s ease-in-out; + z-index: 40 +} + + .skip-to-content: focus-within { + transform: translateY(0) +} + + article { + background: var(--color-content-background); + color: var(--color-content-foreground); + overflow-wrap: break-word +} + + .page { + display: flex; + min-height: 100% +} + + .mobile-header { + background-color: var(--color-header-background); + border-bottom: 1px solid var(--color-header-border); + color: var(--color-header-text); + display: none; + height: var(--header-height); + width: 100%; + z-index: 10 +} + + .mobile-header.scrolled { + border-bottom: none; + box-shadow: 0 0 .2rem rgba(0,0,0,.1),0 .2rem .4rem rgba(0,0,0,.2) +} + + .mobile-header .header-center a { + color: var(--color-header-text); + text-decoration: none +} + + .main { + display: flex; + flex: 1 +} + + .sidebar-drawer { + background: var(--color-sidebar-background); + border-right: 1px solid var(--color-sidebar-background-border); + box-sizing: border-box; + display: flex; + justify-content: flex-end; + min-width: 15em; + width: calc(50% - 26em) +} + + .sidebar-container,.toc-drawer { + box-sizing: border-box; + width: 15em +} + + .toc-drawer { + background: var(--color-toc-background); + padding-right: 1rem +} + + .sidebar-sticky,.toc-sticky { + display: flex; + flex-direction: column; + height: min(100%,100vh); + height: 100vh; + position: sticky; + top: 0 +} + + .sidebar-scroll,.toc-scroll { + flex-grow: 1; + flex-shrink: 1; + overflow: auto; + scroll-behavior: smooth +} + + .content { + display: flex; + flex-direction: column; + justify-content: space-between; + padding: 0 3em; + width: 46em +} + + .icon { + display: inline-block; + height: 1rem; + width: 1rem +} + + .icon svg { + height: 100%; + width: 100% +} + + .announcement { + align-items: center; + background-color: var(--color-announcement-background); + color: var(--color-announcement-text); + display: flex; + height: var(--header-height); + overflow-x: auto +} + + .announcement+.page { + min-height: calc(100% - var(--header-height)) +} + + .announcement-content { + box-sizing: border-box; + min-width: 100%; + padding: .5rem; + text-align: center; + white-space: nowrap +} + + .announcement-content a { + color: var(--color-announcement-text); + text-decoration-color: var(--color-announcement-text) +} + + .announcement-content a: hover { + color: var(--color-announcement-text); + text-decoration-color: var(--color-link--hover) +} + + .no-js .theme-toggle-container { + display: none +} + + .theme-toggle-container { + display: flex +} + + .theme-toggle { + background: transparent; + border: none; + cursor: pointer; + display: flex; + padding: 0 +} + + .theme-toggle svg { + color: var(--color-foreground-primary); + display: none; + height: 1.25rem; + width: 1.25rem +} + + .theme-toggle-header { + align-items: center; + display: flex; + justify-content: center +} + + .nav-overlay-icon,.toc-overlay-icon { + cursor: pointer; + display: none +} + + .nav-overlay-icon .icon,.toc-overlay-icon .icon { + color: var(--color-foreground-secondary); + height: 1.5rem; + width: 1.5rem +} + + .nav-overlay-icon,.toc-header-icon { + align-items: center; + justify-content: center +} + + .toc-content-icon { + height: 1.5rem; + width: 1.5rem +} + + .content-icon-container { + display: flex; + float: right; + gap: .5rem; + margin-bottom: 1rem; + margin-left: 1rem; + margin-top: 1.5rem +} + + .content-icon-container .edit-this-page svg,.content-icon-container .view-this-page svg { + color: inherit; + height: 1.25rem; + width: 1.25rem +} + + .sidebar-toggle { + display: none; + position: absolute +} + + .sidebar-toggle[name=__toc] { + left: 20px +} + + .sidebar-toggle: checked { + left: 40px +} + + .overlay { + background-color: rgba(0,0,0,.54); + height: 0; + opacity: 0; + position: fixed; + top: 0; + transition: width 0ms,height 0ms,opacity .25s ease-out; + width: 0 +} + + .sidebar-overlay { + z-index: 20 +} + + .toc-overlay { + z-index: 40 +} + + .sidebar-drawer { + transition: left .25s ease-in-out; + z-index: 30 +} + + .toc-drawer { + transition: right .25s ease-in-out; + z-index: 50 +} + + #__navigation: checked~.sidebar-overlay { + height: 100%; + opacity: 1; + width: 100% +} + + #__navigation: checked~.page .sidebar-drawer { + left: 0; + top: 0 +} + + #__toc: checked~.toc-overlay { + height: 100%; + opacity: 1; + width: 100% +} + + #__toc: checked~.page .toc-drawer { + right: 0; + top: 0 +} + + .back-to-top { + background: var(--color-background-primary); + border-radius: 1rem; + box-shadow: 0 .2rem .5rem rgba(0,0,0,.05),0 0 1px 0 hsla(220,9%,46%,.502); + display: none; + font-size: .8125rem; + left: 0; + margin-left: 50%; + padding: .5rem .75rem .5rem .5rem; + position: fixed; + text-decoration: none; + top: 1rem; + transform: translateX(-50%); + z-index: 10 +} + + .back-to-top svg { + height: 1rem; + width: 1rem; + fill: currentColor; + display: inline-block +} + + .back-to-top span { + margin-left: .25rem +} + + .show-back-to-top .back-to-top { + align-items: center; + display: flex +} + + @media(min-width: 97em) { + html {font-size: 110% +} + + +} + + @media(max-width: 82em) { + .toc-content-icon {display: flex +} + + .toc-drawer { + border-left: 1px solid var(--color-background-muted); + height: 100vh; + position: fixed; + right: -15em; + top: 0 +} + + .toc-tree { + border-left: none; + font-size: var(--toc-font-size--mobile) +} + + .sidebar-drawer { + width: calc(50% - 18.5em) +} + + +} + + @media(max-width: 67em) { + .content {margin-left: auto; + margin-right: auto; + padding: 0 1em +} + + +} + + @media(max-width: 63em) { + .nav-overlay-icon {display: flex +} + + .sidebar-drawer { + height: 100vh; + left: -15em; + position: fixed; + top: 0; + width: 15em +} + + .theme-toggle-header,.toc-header-icon { + display: flex +} + + .theme-toggle-content,.toc-content-icon { + display: none +} + + .mobile-header { + align-items: center; + display: flex; + justify-content: space-between; + position: sticky; + top: 0 +} + + .mobile-header .header-left,.mobile-header .header-right { + display: flex; + height: var(--header-height); + padding: 0 var(--header-padding) +} + + .mobile-header .header-left label,.mobile-header .header-right label { + height: 100%; + -webkit-user-select: none; + -moz-user-select: none; + user-select: none; + width: 100% +} + + .nav-overlay-icon .icon,.theme-toggle svg { + height: 1.5rem; + width: 1.5rem +} + + : target { + scroll-margin-top: calc(var(--header-height) + 2.5rem) +} + + .back-to-top { + top: calc(var(--header-height) + .5rem) +} + + .page { + flex-direction: column; + justify-content: center +} + + +} + + @media(max-width: 48em) { + .content {overflow-x: auto; + width: 100% +} + + +} + + @media(max-width: 46em) { + article[role=main] aside.sidebar {float: none; + margin: 1rem 0; + width: 100% +} + + +} + + .admonition,.topic { + background: var(--color-admonition-background); + border-radius: .2rem; + box-shadow: 0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1); + font-size: var(--admonition-font-size); + margin: 1rem auto; + overflow: hidden; + padding: 0 .5rem .5rem; + page-break-inside: avoid +} + + .admonition>: nth-child(2),.topic>: nth-child(2) { + margin-top: 0 +} + + .admonition>: last-child,.topic>: last-child { + margin-bottom: 0 +} + + .admonition p.admonition-title,p.topic-title { + font-size: var(--admonition-title-font-size); + font-weight: 500; + line-height: 1.3; + margin: 0 -.5rem .5rem; + padding: .4rem .5rem .4rem 2rem; + position: relative +} + + .admonition p.admonition-title: before,p.topic-title: before { + content: ""; + height: 1rem; + left: .5rem; + position: absolute; + width: 1rem +} + + p.admonition-title { + background-color: var(--color-admonition-title-background) +} + + p.admonition-title: before { + background-color: var(--color-admonition-title); + -webkit-mask-image: var(--icon-admonition-default); + mask-image: var(--icon-admonition-default); + -webkit-mask-repeat: no-repeat; + mask-repeat: no-repeat +} + + p.topic-title { + background-color: var(--color-topic-title-background) +} + + p.topic-title: before { + background-color: var(--color-topic-title); + -webkit-mask-image: var(--icon-topic-default); + mask-image: var(--icon-topic-default); + -webkit-mask-repeat: no-repeat; + mask-repeat: no-repeat +} + + .admonition { + border-left: .2rem solid var(--color-admonition-title) +} + + .admonition.caution { + border-left-color: var(--color-admonition-title--caution) +} + + .admonition.caution>.admonition-title { + background-color: var(--color-admonition-title-background--caution) +} + + .admonition.caution>.admonition-title: before { + background-color: var(--color-admonition-title--caution); + -webkit-mask-image: var(--icon-spark); + mask-image: var(--icon-spark) +} + + .admonition.warning { + border-left-color: var(--color-admonition-title--warning) +} + + .admonition.warning>.admonition-title { + background-color: var(--color-admonition-title-background--warning) +} + + .admonition.warning>.admonition-title: before { + background-color: var(--color-admonition-title--warning); + -webkit-mask-image: var(--icon-warning); + mask-image: var(--icon-warning) +} + + .admonition.danger { + border-left-color: var(--color-admonition-title--danger) +} + + .admonition.danger>.admonition-title { + background-color: var(--color-admonition-title-background--danger) +} + + .admonition.danger>.admonition-title: before { + background-color: var(--color-admonition-title--danger); + -webkit-mask-image: var(--icon-spark); + mask-image: var(--icon-spark) +} + + .admonition.attention { + border-left-color: var(--color-admonition-title--attention) +} + + .admonition.attention>.admonition-title { + background-color: var(--color-admonition-title-background--attention) +} + + .admonition.attention>.admonition-title: before { + background-color: var(--color-admonition-title--attention); + -webkit-mask-image: var(--icon-warning); + mask-image: var(--icon-warning) +} + + .admonition.error { + border-left-color: var(--color-admonition-title--error) +} + + .admonition.error>.admonition-title { + background-color: var(--color-admonition-title-background--error) +} + + .admonition.error>.admonition-title: before { + background-color: var(--color-admonition-title--error); + -webkit-mask-image: var(--icon-failure); + mask-image: var(--icon-failure) +} + + .admonition.hint { + border-left-color: var(--color-admonition-title--hint) +} + + .admonition.hint>.admonition-title { + background-color: var(--color-admonition-title-background--hint) +} + + .admonition.hint>.admonition-title: before { + background-color: var(--color-admonition-title--hint); + -webkit-mask-image: var(--icon-question); + mask-image: var(--icon-question) +} + + .admonition.tip { + border-left-color: var(--color-admonition-title--tip) +} + + .admonition.tip>.admonition-title { + background-color: var(--color-admonition-title-background--tip) +} + + .admonition.tip>.admonition-title: before { + background-color: var(--color-admonition-title--tip); + -webkit-mask-image: var(--icon-info); + mask-image: var(--icon-info) +} + + .admonition.important { + border-left-color: var(--color-admonition-title--important) +} + + .admonition.important>.admonition-title { + background-color: var(--color-admonition-title-background--important) +} + + .admonition.important>.admonition-title: before { + background-color: var(--color-admonition-title--important); + -webkit-mask-image: var(--icon-flame); + mask-image: var(--icon-flame) +} + + .admonition.note { + border-left-color: var(--color-admonition-title--note) +} + + .admonition.note>.admonition-title { + background-color: var(--color-admonition-title-background--note) +} + + .admonition.note>.admonition-title: before { + background-color: var(--color-admonition-title--note); + -webkit-mask-image: var(--icon-pencil); + mask-image: var(--icon-pencil) +} + + .admonition.seealso { + border-left-color: var(--color-admonition-title--seealso) +} + + .admonition.seealso>.admonition-title { + background-color: var(--color-admonition-title-background--seealso) +} + + .admonition.seealso>.admonition-title: before { + background-color: var(--color-admonition-title--seealso); + -webkit-mask-image: var(--icon-info); + mask-image: var(--icon-info) +} + + .admonition.admonition-todo { + border-left-color: var(--color-admonition-title--admonition-todo) +} + + .admonition.admonition-todo>.admonition-title { + background-color: var(--color-admonition-title-background--admonition-todo) +} + + .admonition.admonition-todo>.admonition-title: before { + background-color: var(--color-admonition-title--admonition-todo); + -webkit-mask-image: var(--icon-pencil); + mask-image: var(--icon-pencil) +} + + .admonition-todo>.admonition-title { + text-transform: uppercase +} + + dl[class]: not(.option-list): not(.field-list): not(.footnote): not(.glossary): not(.simple) dd { + margin-left: 2rem +} + + dl[class]: not(.option-list): not(.field-list): not(.footnote): not(.glossary): not(.simple) dd>: first-child { + margin-top: .125rem +} + + dl[class]: not(.option-list): not(.field-list): not(.footnote): not(.glossary): not(.simple) .field-list,dl[class]: not(.option-list): not(.field-list): not(.footnote): not(.glossary): not(.simple) dd>: last-child { + margin-bottom: .75rem +} + + dl[class]: not(.option-list): not(.field-list): not(.footnote): not(.glossary): not(.simple) .field-list>dt { + font-size: var(--font-size--small); + text-transform: uppercase +} + + dl[class]: not(.option-list): not(.field-list): not(.footnote): not(.glossary): not(.simple) .field-list dd: empty { + margin-bottom: .5rem +} + + dl[class]: not(.option-list): not(.field-list): not(.footnote): not(.glossary): not(.simple) .field-list dd>ul { + margin-left: -1.2rem +} + + dl[class]: not(.option-list): not(.field-list): not(.footnote): not(.glossary): not(.simple) .field-list dd>ul>li>p: nth-child(2) { + margin-top: 0 +} + + dl[class]: not(.option-list): not(.field-list): not(.footnote): not(.glossary): not(.simple) .field-list dd>ul>li>p+p: last-child: empty { + margin-bottom: 0; + margin-top: 0 +} + + dl[class]: not(.option-list): not(.field-list): not(.footnote): not(.glossary): not(.simple)>dt { + color: var(--color-api-overall) +} + + .sig: not(.sig-inline) { + background: var(--color-api-background); + border-radius: .25rem; + font-family: var(--font-stack--monospace); + font-size: var(--api-font-size); + font-weight: 700; + margin-left: -.25rem; + margin-right: -.25rem; + padding: .25rem .5rem .25rem 3em; + text-indent: -2.5em; + transition: background .1s ease-out +} + + .sig: not(.sig-inline): hover { + background: var(--color-api-background-hover) +} + + .sig: not(.sig-inline) a.reference .viewcode-link { + font-weight: 400; + width: 4.25rem +} + + em.property { + font-style: normal +} + + em.property: first-child { + color: var(--color-api-keyword) +} + + .sig-name { + color: var(--color-api-name) +} + + .sig-prename { + color: var(--color-api-pre-name); + font-weight: 400 +} + + .sig-paren { + color: var(--color-api-paren) +} + + .sig-param { + font-style: normal +} + + div.deprecated,div.versionadded,div.versionchanged,div.versionremoved { + border-left: .1875rem solid; + border-radius: .125rem; + padding-left: .75rem +} + + div.deprecated p,div.versionadded p,div.versionchanged p,div.versionremoved p { + margin-bottom: .125rem; + margin-top: .125rem +} + + div.versionadded { + border-color: var(--color-api-added-border) +} + + div.versionadded .versionmodified { + color: var(--color-api-added) +} + + div.versionchanged { + border-color: var(--color-api-changed-border) +} + + div.versionchanged .versionmodified { + color: var(--color-api-changed) +} + + div.deprecated { + border-color: var(--color-api-deprecated-border) +} + + div.deprecated .versionmodified { + color: var(--color-api-deprecated) +} + + div.versionremoved { + border-color: var(--color-api-removed-border) +} + + div.versionremoved .versionmodified { + color: var(--color-api-removed) +} + + .viewcode-back,.viewcode-link { + float: right; + text-align: right +} + + .line-block { + margin-bottom: .75rem; + margin-top: .5rem +} + + .line-block .line-block { + margin-bottom: 0; + margin-top: 0; + padding-left: 1rem +} + + .code-block-caption,article p.caption,table>caption { + font-size: var(--font-size--small); + text-align: center +} + + .toctree-wrapper.compound .caption,.toctree-wrapper.compound : not(.caption)>.caption-text { + font-size: var(--font-size--small); + margin-bottom: 0; + text-align: initial; + text-transform: uppercase +} + + .toctree-wrapper.compound>ul { + margin-bottom: 0; + margin-top: 0 +} + + .sig-inline,code.literal { + background: var(--color-inline-code-background); + border-radius: .2em; + font-size: var(--font-size--small--2); + padding: .1em .2em +} + + pre.literal-block .sig-inline,pre.literal-block code.literal { + font-size: inherit; + padding: 0 +} + + p .sig-inline,p code.literal { + border: 1px solid var(--color-background-border) +} + + .sig-inline { + font-family: var(--font-stack--monospace) +} + + div[class*=" highlight-"],div[class^=highlight-] { + display: flex; + margin: 1em 0 +} + + div[class*=" highlight-"] .table-wrapper,div[class^=highlight-] .table-wrapper,pre { + margin: 0; + padding: 0 +} + + pre { + overflow: auto +} + + article[role=main] .highlight pre { + line-height: 1.5 +} + + .highlight pre,pre.literal-block { + font-size: var(--code-font-size); + padding: .625rem .875rem +} + + pre.literal-block { + background-color: var(--color-code-background); + border-radius: .2rem; + color: var(--color-code-foreground); + margin-bottom: 1rem; + margin-top: 1rem +} + + .highlight { + border-radius: .2rem; + width: 100% +} + + .highlight .gp,.highlight span.linenos { + pointer-events: none; + -webkit-user-select: none; + -moz-user-select: none; + user-select: none +} + + .highlight .hll { + display: block; + margin-left: -.875rem; + margin-right: -.875rem; + padding-left: .875rem; + padding-right: .875rem +} + + .code-block-caption { + background-color: var(--color-code-background); + border-bottom: 1px solid; + border-radius: .25rem; + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; + border-color: var(--color-background-border); + color: var(--color-code-foreground); + display: flex; + font-weight: 300; + padding: .625rem .875rem +} + + .code-block-caption+div[class] { + margin-top: 0 +} + + .code-block-caption+div[class] pre { + border-top-left-radius: 0; + border-top-right-radius: 0 +} + + .highlighttable { + display: block; + width: 100% +} + + .highlighttable tbody { + display: block +} + + .highlighttable tr { + display: flex +} + + .highlighttable td.linenos { + background-color: var(--color-code-background); + border-bottom-left-radius: .2rem; + border-top-left-radius: .2rem; + color: var(--color-code-foreground); + padding: .625rem 0 .625rem .875rem +} + + .highlighttable .linenodiv { + box-shadow: -.0625rem 0 var(--color-foreground-border) inset; + font-size: var(--code-font-size); + padding-right: .875rem +} + + .highlighttable td.code { + display: block; + flex: 1; + overflow: hidden; + padding: 0 +} + + .highlighttable td.code .highlight { + border-bottom-left-radius: 0; + border-top-left-radius: 0 +} + + .highlight span.linenos { + box-shadow: -.0625rem 0 var(--color-foreground-border) inset; + display: inline-block; + margin-right: .875rem; + padding-left: 0; + padding-right: .875rem +} + + .footnote-reference { + font-size: var(--font-size--small--4); + vertical-align: super +} + + dl.footnote.brackets { + color: var(--color-foreground-secondary); + display: grid; + font-size: var(--font-size--small); + grid-template-columns: max-content auto +} + + dl.footnote.brackets dt { + margin: 0 +} + + dl.footnote.brackets dt>.fn-backref { + margin-left: .25rem +} + + dl.footnote.brackets dt: after { + content: ": " +} + + dl.footnote.brackets dt .brackets: before { + content: "[" +} + + dl.footnote.brackets dt .brackets: after { + content: "]" +} + + dl.footnote.brackets dd { + margin: 0; + padding: 0 1rem +} + + aside.footnote { + color: var(--color-foreground-secondary); + font-size: var(--font-size--small) +} + + aside.footnote>span,div.citation>span { + float: left; + font-weight: 500; + padding-right: .25rem +} + + aside.footnote>: not(span),div.citation>p { + margin-left: 2rem +} + + img { + box-sizing: border-box; + height: auto; + max-width: 100% +} + + article .figure,article figure { + border-radius: .2rem; + margin: 0 +} + + article .figure : last-child,article figure : last-child { + margin-bottom: 0 +} + + article .align-left { + clear: left; + float: left; + margin: 0 1rem 1rem +} + + article .align-right { + clear: right; + float: right; + margin: 0 1rem 1rem +} + + article .align-center,article .align-default { + display: block; + margin-left: auto; + margin-right: auto; + text-align: center +} + + article table.align-default { + display: table; + text-align: initial +} + + .domainindex-jumpbox,.genindex-jumpbox { + border-bottom: 1px solid var(--color-background-border); + border-top: 1px solid var(--color-background-border); + padding: .25rem +} + + .domainindex-section h2,.genindex-section h2 { + margin-bottom: .5rem; + margin-top: .75rem +} + + .domainindex-section ul,.genindex-section ul { + margin-bottom: 0; + margin-top: 0 +} + + ol,ul { + margin-bottom: 1rem; + margin-top: 1rem; + padding-left: 1.2rem +} + + ol li>p: first-child,ul li>p: first-child { + margin-bottom: .25rem; + margin-top: .25rem +} + + ol li>p: last-child,ul li>p: last-child { + margin-top: .25rem +} + + ol li>ol,ol li>ul,ul li>ol,ul li>ul { + margin-bottom: .5rem; + margin-top: .5rem +} + + ol.arabic { + list-style: decimal +} + + ol.loweralpha { + list-style: lower-alpha +} + + ol.upperalpha { + list-style: upper-alpha +} + + ol.lowerroman { + list-style: lower-roman +} + + ol.upperroman { + list-style: upper-roman +} + + .simple li>ol,.simple li>ul,.toctree-wrapper li>ol,.toctree-wrapper li>ul { + margin-bottom: 0; + margin-top: 0 +} + + .field-list dt,.option-list dt,dl.footnote dt,dl.glossary dt,dl.simple dt,dl: not([class]) dt { + font-weight: 500; + margin-top: .25rem +} + + .field-list dt+dt,.option-list dt+dt,dl.footnote dt+dt,dl.glossary dt+dt,dl.simple dt+dt,dl: not([class]) dt+dt { + margin-top: 0 +} + + .field-list dt .classifier: before,.option-list dt .classifier: before,dl.footnote dt .classifier: before,dl.glossary dt .classifier: before,dl.simple dt .classifier: before,dl: not([class]) dt .classifier: before { + content: ": "; + margin-left: .2rem; + margin-right: .2rem +} + + .field-list dd ul,.field-list dd>p: first-child,.option-list dd ul,.option-list dd>p: first-child,dl.footnote dd ul,dl.footnote dd>p: first-child,dl.glossary dd ul,dl.glossary dd>p: first-child,dl.simple dd ul,dl.simple dd>p: first-child,dl: not([class]) dd ul,dl: not([class]) dd>p: first-child { + margin-top: .125rem +} + + .field-list dd ul,.option-list dd ul,dl.footnote dd ul,dl.glossary dd ul,dl.simple dd ul,dl: not([class]) dd ul { + margin-bottom: .125rem +} + + .math-wrapper { + overflow-x: auto; + width: 100% +} + + div.math { + position: relative; + text-align: center +} + + div.math .headerlink,div.math: focus .headerlink { + display: none +} + + div.math: hover .headerlink { + display: inline-block +} + + div.math span.eqno { + position: absolute; + right: .5rem; + top: 50%; + transform: translateY(-50%); + z-index: 1 +} + + abbr[title] { + cursor: help +} + + .problematic { + color: var(--color-problematic) +} + + kbd: not(.compound) { + background-color: var(--color-background-secondary); + border: 1px solid var(--color-foreground-border); + border-radius: .2rem; + box-shadow: 0 .0625rem 0 rgba(0,0,0,.2),inset 0 0 0 .125rem var(--color-background-primary); + color: var(--color-foreground-primary); + display: inline-block; + font-size: var(--font-size--small--3); + margin: 0 .2rem; + padding: 0 .2rem; + vertical-align: text-bottom +} + + blockquote { + background: var(--color-background-secondary); + border-left: 4px solid var(--color-background-border); + margin-left: 0; + margin-right: 0; + padding: .5rem 1rem +} + + blockquote .attribution { + font-weight: 600; + text-align: right +} + + blockquote.highlights,blockquote.pull-quote { + font-size: 1.25em +} + + blockquote.epigraph,blockquote.pull-quote { + border-left-width: 0; + border-radius: .5rem +} + + blockquote.highlights { + background: transparent; + border-left-width: 0 +} + + p .reference img { + vertical-align: middle +} + + p.rubric { + font-size: 1.125em; + font-weight: 700; + line-height: 1.25 +} + + dd p.rubric { + font-size: var(--font-size--small); + font-weight: inherit; + line-height: inherit; + text-transform: uppercase +} + + article .sidebar { + background-color: var(--color-background-secondary); + border: 1px solid var(--color-background-border); + border-radius: .2rem; + clear: right; + float: right; + margin-left: 1rem; + margin-right: 0; + width: 30% +} + + article .sidebar>* { + padding-left: 1rem; + padding-right: 1rem +} + + article .sidebar>ol,article .sidebar>ul { + padding-left: 2.2rem +} + + article .sidebar .sidebar-title { + border-bottom: 1px solid var(--color-background-border); + font-weight: 500; + margin: 0; + padding: .5rem 1rem +} + + [role=main] .table-wrapper.container { + margin-bottom: .5rem; + margin-top: 1rem; + overflow-x: auto; + padding: .2rem .2rem .75rem; + width: 100% +} + + table.docutils { + border-collapse: collapse; + border-radius: .2rem; + border-spacing: 0; + box-shadow: 0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1) +} + + table.docutils th { + background: var(--color-table-header-background) +} + + table.docutils td,table.docutils th { + border-bottom: 1px solid var(--color-table-border); + border-left: 1px solid var(--color-table-border); + border-right: 1px solid var(--color-table-border); + padding: 0 .25rem +} + + table.docutils td p,table.docutils th p { + margin: .25rem +} + + table.docutils td: first-child,table.docutils th: first-child { + border-left: none +} + + table.docutils td: last-child,table.docutils th: last-child { + border-right: none +} + + table.docutils td.text-left,table.docutils th.text-left { + text-align: left +} + + table.docutils td.text-right,table.docutils th.text-right { + text-align: right +} + + table.docutils td.text-center,table.docutils th.text-center { + text-align: center +} + + : target { + scroll-margin-top: 2.5rem +} + + @media(max-width: 67em) { + : target {scroll-margin-top: calc(2.5rem + var(--header-height)) +} + + section>span: target { + scroll-margin-top: calc(2.8rem + var(--header-height)) +} + + +} + + .headerlink { + font-weight: 100; + -webkit-user-select: none; + -moz-user-select: none; + user-select: none +} + + .code-block-caption>.headerlink,dl dt>.headerlink,figcaption p>.headerlink,h1>.headerlink,h2>.headerlink,h3>.headerlink,h4>.headerlink,h5>.headerlink,h6>.headerlink,p.caption>.headerlink,table>caption>.headerlink { + margin-left: .5rem; + visibility: hidden +} + + .code-block-caption: hover>.headerlink,dl dt: hover>.headerlink,figcaption p: hover>.headerlink,h1: hover>.headerlink,h2: hover>.headerlink,h3: hover>.headerlink,h4: hover>.headerlink,h5: hover>.headerlink,h6: hover>.headerlink,p.caption: hover>.headerlink,table>caption: hover>.headerlink { + visibility: visible +} + + .code-block-caption>.toc-backref,dl dt>.toc-backref,figcaption p>.toc-backref,h1>.toc-backref,h2>.toc-backref,h3>.toc-backref,h4>.toc-backref,h5>.toc-backref,h6>.toc-backref,p.caption>.toc-backref,table>caption>.toc-backref { + color: inherit; + text-decoration-line: none +} + + figure: hover>figcaption>p>.headerlink,table: hover>caption>.headerlink { + visibility: visible +} + + : target>h1: first-of-type,: target>h2: first-of-type,: target>h3: first-of-type,: target>h4: first-of-type,: target>h5: first-of-type,: target>h6: first-of-type,span: target~h1: first-of-type,span: target~h2: first-of-type,span: target~h3: first-of-type,span: target~h4: first-of-type,span: target~h5: first-of-type,span: target~h6: first-of-type { + background-color: var(--color-highlight-on-target) +} + + : target>h1: first-of-type code.literal,: target>h2: first-of-type code.literal,: target>h3: first-of-type code.literal,: target>h4: first-of-type code.literal,: target>h5: first-of-type code.literal,: target>h6: first-of-type code.literal,span: target~h1: first-of-type code.literal,span: target~h2: first-of-type code.literal,span: target~h3: first-of-type code.literal,span: target~h4: first-of-type code.literal,span: target~h5: first-of-type code.literal,span: target~h6: first-of-type code.literal { + background-color: transparent +} + + .literal-block-wrapper: target .code-block-caption,.this-will-duplicate-information-and-it-is-still-useful-here li : target,figure: target,table: target>caption { + background-color: var(--color-highlight-on-target) +} + + dt: target { + background-color: var(--color-highlight-on-target)!important +} + + .footnote-reference: target,.footnote>dt: target+dd { + background-color: var(--color-highlight-on-target) +} + + .guilabel { + background-color: var(--color-guilabel-background); + border: 1px solid var(--color-guilabel-border); + border-radius: .5em; + color: var(--color-guilabel-text); + font-size: .9em; + padding: 0 .3em +} + + footer { + display: flex; + flex-direction: column; + font-size: var(--font-size--small); + margin-top: 2rem +} + + .bottom-of-page { + align-items: center; + border-top: 1px solid var(--color-background-border); + color: var(--color-foreground-secondary); + display: flex; + justify-content: space-between; + line-height: 1.5; + margin-top: 1rem; + padding-bottom: 1rem; + padding-top: 1rem +} + + @media(max-width: 46em) { + .bottom-of-page {flex-direction: column-reverse; + gap: .25rem; + text-align: center +} + + +} + + .bottom-of-page .left-details { + font-size: var(--font-size--small) +} + + .bottom-of-page .right-details { + display: flex; + flex-direction: column; + gap: .25rem; + text-align: right +} + + .bottom-of-page .icons { + display: flex; + font-size: 1rem; + gap: .25rem; + justify-content: flex-end +} + + .bottom-of-page .icons a { + text-decoration: none +} + + .bottom-of-page .icons img,.bottom-of-page .icons svg { + font-size: 1.125rem; + height: 1em; + width: 1em +} + + .related-pages a { + align-items: center; + display: flex; + text-decoration: none +} + + .related-pages a: hover .page-info .title { + color: var(--color-link); + text-decoration: underline; + text-decoration-color: var(--color-link-underline) +} + + .related-pages a svg.furo-related-icon,.related-pages a svg.furo-related-icon>use { + color: var(--color-foreground-border); + flex-shrink: 0; + height: .75rem; + margin: 0 .5rem; + width: .75rem +} + + .related-pages a.next-page { + clear: right; + float: right; + max-width: 50%; + text-align: right +} + + .related-pages a.prev-page { + clear: left; + float: left; + max-width: 50% +} + + .related-pages a.prev-page svg { + transform: rotate(180deg) +} + + .page-info { + display: flex; + flex-direction: column; + overflow-wrap: anywhere +} + + .next-page .page-info { + align-items: flex-end +} + + .page-info .context { + align-items: center; + color: var(--color-foreground-muted); + display: flex; + font-size: var(--font-size--small); + padding-bottom: .1rem; + text-decoration: none +} + + ul.search { + list-style: none; + padding-left: 0 +} + + ul.search li { + border-bottom: 1px solid var(--color-background-border); + padding: 1rem 0 +} + + [role=main] .highlighted { + background-color: var(--color-highlighted-background); + color: var(--color-highlighted-text) +} + + .sidebar-brand { + display: flex; + flex-direction: column; + flex-shrink: 0; + padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal); + text-decoration: none +} + + .sidebar-brand-text { + color: var(--color-sidebar-brand-text); + font-size: 1.5rem; + overflow-wrap: break-word +} + + .sidebar-brand-text,.sidebar-logo-container { + margin: var(--sidebar-item-spacing-vertical) 0 +} + + .sidebar-logo { + display: block; + margin: 0 auto; + max-width: 100% +} + + .sidebar-search-container { + align-items: center; + background: var(--color-sidebar-search-background); + display: flex; + margin-top: var(--sidebar-search-space-above); + position: relative +} + + .sidebar-search-container: focus-within,.sidebar-search-container: hover { + background: var(--color-sidebar-search-background--focus) +} + + .sidebar-search-container: before { + background-color: var(--color-sidebar-search-icon); + content: ""; + height: var(--sidebar-search-icon-size); + left: var(--sidebar-item-spacing-horizontal); + -webkit-mask-image: var(--icon-search); + mask-image: var(--icon-search); + position: absolute; + width: var(--sidebar-search-icon-size) +} + + .sidebar-search { + background: transparent; + border: none; + border-bottom: 1px solid var(--color-sidebar-search-border); + border-top: 1px solid var(--color-sidebar-search-border); + box-sizing: border-box; + color: var(--color-sidebar-search-foreground); + padding: var(--sidebar-search-input-spacing-vertical) var(--sidebar-search-input-spacing-horizontal) var(--sidebar-search-input-spacing-vertical) calc(var(--sidebar-item-spacing-horizontal) + var(--sidebar-search-input-spacing-horizontal) + var(--sidebar-search-icon-size)); + width: 100%; + z-index: 10 +} + + .sidebar-search: focus { + outline: none +} + + .sidebar-search: :-moz-placeholder { + font-size: var(--sidebar-search-input-font-size) +} + + .sidebar-search: :placeholder { + font-size: var(--sidebar-search-input-font-size) +} + + #searchbox .highlight-link { + margin: 0; + padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0; + text-align: center +} + + #searchbox .highlight-link a { + color: var(--color-sidebar-search-icon); + font-size: var(--font-size--small--2) +} + + .sidebar-tree { + font-size: var(--sidebar-item-font-size); + margin-bottom: var(--sidebar-item-spacing-vertical); + margin-top: var(--sidebar-tree-space-above) +} + + .sidebar-tree ul { + display: flex; + flex-direction: column; + list-style: none; + margin-bottom: 0; + margin-top: 0; + padding: 0 +} + + .sidebar-tree li { + margin: 0; + position: relative +} + + .sidebar-tree li>ul { + margin-left: var(--sidebar-item-spacing-horizontal) +} + + .sidebar-tree .icon,.sidebar-tree .reference { + color: var(--color-sidebar-link-text) +} + + .sidebar-tree .reference { + box-sizing: border-box; + display: inline-block; + height: 100%; + line-height: var(--sidebar-item-line-height); + overflow-wrap: anywhere; + padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal); + text-decoration: none; + width: 100% +} + + .sidebar-tree .reference: hover { + background: var(--color-sidebar-item-background--hover); + color: var(--color-sidebar-link-text) +} + + .sidebar-tree .reference.external: after { + color: var(--color-sidebar-link-text); + content: url("data: image/svg+xml; + charset=utf-8,%3Csvg xmlns='http: //www.w3.org/2000/svg' width='12' height='12' fill='none' stroke='%23607D8B' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' viewBox='0 0 24 24'%3E%3Cpath stroke='none' d='M0 0h24v24H0z'/%3E%3Cpath d='M11 7H6a2 2 0 0 0-2 2v9a2 2 0 0 0 2 2h9a2 2 0 0 0 2-2v-5M10 14 20 4M15 4h5v5'/%3E%3C/svg%3E"); + margin: 0 .25rem; + vertical-align: middle +} + + .sidebar-tree .current-page>.reference { + font-weight: 700 +} + + .sidebar-tree label { + align-items: center; + cursor: pointer; + display: flex; + height: var(--sidebar-item-height); + justify-content: center; + position: absolute; + right: 0; + top: 0; + -webkit-user-select: none; + -moz-user-select: none; + user-select: none; + width: var(--sidebar-expander-width) +} + + .sidebar-tree .caption,.sidebar-tree : not(.caption)>.caption-text { + color: var(--color-sidebar-caption-text); + font-size: var(--sidebar-caption-font-size); + font-weight: 700; + margin: var(--sidebar-caption-space-above) 0 0 0; + padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal); + text-transform: uppercase +} + + .sidebar-tree li.has-children>.reference { + padding-right: var(--sidebar-expander-width) +} + + .sidebar-tree .toctree-l1>.reference,.sidebar-tree .toctree-l1>label .icon { + color: var(--color-sidebar-link-text--top-level) +} + + .sidebar-tree label { + background: var(--color-sidebar-item-expander-background) +} + + .sidebar-tree label: hover { + background: var(--color-sidebar-item-expander-background--hover) +} + + .sidebar-tree .current>.reference { + background: var(--color-sidebar-item-background--current) +} + + .sidebar-tree .current>.reference: hover { + background: var(--color-sidebar-item-background--hover) +} + + .toctree-checkbox { + display: none; + position: absolute +} + + .toctree-checkbox~ul { + display: none +} + + .toctree-checkbox~label .icon svg { + transform: rotate(90deg) +} + + .toctree-checkbox: checked~ul { + display: block +} + + .toctree-checkbox: checked~label .icon svg { + transform: rotate(-90deg) +} + + .toc-title-container { + padding: var(--toc-title-padding); + padding-top: var(--toc-spacing-vertical) +} + + .toc-title { + color: var(--color-toc-title-text); + font-size: var(--toc-title-font-size); + padding-left: var(--toc-spacing-horizontal); + text-transform: uppercase +} + + .no-toc { + display: none +} + + .toc-tree-container { + padding-bottom: var(--toc-spacing-vertical) +} + + .toc-tree { + border-left: 1px solid var(--color-background-border); + font-size: var(--toc-font-size); + line-height: 1.3; + padding-left: calc(var(--toc-spacing-horizontal) - var(--toc-item-spacing-horizontal)) +} + + .toc-tree>ul>li: first-child { + padding-top: 0 +} + + .toc-tree>ul>li: first-child>ul { + padding-left: 0 +} + + .toc-tree>ul>li: first-child>a { + display: none +} + + .toc-tree ul { + list-style-type: none; + margin-bottom: 0; + margin-top: 0; + padding-left: var(--toc-item-spacing-horizontal) +} + + .toc-tree li { + padding-top: var(--toc-item-spacing-vertical) +} + + .toc-tree li.scroll-current>.reference { + color: var(--color-toc-item-text--active); + font-weight: 700 +} + + .toc-tree a.reference { + color: var(--color-toc-item-text); + overflow-wrap: anywhere; + text-decoration: none +} + + .toc-scroll { + max-height: 100vh; + overflow-y: scroll +} + + .contents: not(.this-will-duplicate-information-and-it-is-still-useful-here) { + background: rgba(255,0,0,.25); + color: var(--color-problematic) +} + + .contents: not(.this-will-duplicate-information-and-it-is-still-useful-here): before { + content: "ERROR: Adding a table of contents in Furo-based documentation is unnecessary, and does not work well with existing styling. Add a 'this-will-duplicate-information-and-it-is-still-useful-here' class, if you want an escape hatch." +} + + .text-align\: left>p { + text-align: left +} + + .text-align\: center>p { + text-align: center +} + + .text-align\: right>p { + text-align: right +} + + +/*# sourceMappingURL=furo.css.map*/ \ No newline at end of file diff --git a/Docs/beta/_static/style.css b/Docs/beta/_static/style.css deleted file mode 100644 index 76652d136b1..00000000000 --- a/Docs/beta/_static/style.css +++ /dev/null @@ -1,1221 +0,0 @@ -@font-face { - font-family: Roboto; - font-style: normal; - font-weight: 400; - src: local("Roboto"), local("Roboto-Regular"), url(fonts/roboto/roboto.woff2) format("woff2"); -} -@font-face { - font-family: Roboto; - font-style: italic; - font-weight: 400; - src: local("Roboto Italic"), local("Roboto-Italic"), url(fonts/roboto/roboto-italic.woff2) format("woff2"); -} -@font-face { - font-family: Roboto; - font-style: normal; - font-weight: 700; - src: local("Roboto Bold"), local("Roboto-Bold"), url(fonts/roboto/roboto-bold.woff2) format("woff2"); -} -@font-face { - font-family: Roboto Mono; - font-style: normal; - font-weight: 400; - src: local("Roboto Mono Regular"), local("RobotoMono-Regular"), url(fonts/roboto-mono/roboto-mono.woff2) format("woff2"); -} -@font-face { - font-family: Roboto Mono; - font-style: italic; - font-weight: 400; - src: local("Roboto Mono Italic"), local("RobotoMono-Italic"), url(fonts/roboto-mono/roboto-mono-italic.woff2) format("woff2"); -} -@font-face { - font-family: Roboto Mono; - font-style: normal; - font-weight: 700; - src: local("Roboto Mono Bold"), local("RobotoMono-Bold"), url(fonts/roboto-mono/roboto-mono-bold.woff2) format("woff2"); -} -@font-face { - font-family: Roboto Mono; - font-style: italic; - font-weight: 700; - src: local("Roboto Mono Bold Italic"), local("RobotoMono-BoldItalic"), url(fonts/roboto-mono/roboto-mono-bold-italic.woff2) format("woff2"); -} -/*****************************************************************************/ -/* Typography */ -:root { - --codeBackgroundColor: #f8f8f8; - --inlineCodeBackgroundColor: #f8f8f8; - --codeBlue: #0000ff; - --codeGreen: #008000; - --dividerColor: rgba(0, 0, 0, 0.08); - --faintFontColor: rgba(0, 0, 0, 0.6); - --fontColor: #252630; - --linkColor: #2980b9; - --mainBackgroundColor: white; - --mainNavColor: #3889ce; - --notificationBannerColor: #176bb0; - --searchHighlightColor: #fff150; - --sidebarColor: white; - --navbarHeight: 4rem; -} -:root[data-mode=darkest] { - --mainBackgroundColor: black; - --sidebarColor: black; - --codeBackgroundColor: rgba(255, 255, 255, 0.1); - --inlineCodeBackgroundColor: rgba(255, 255, 255, 0.1); -} -:root[data-mode=dark] { - --mainBackgroundColor: #242429; - --sidebarColor: #242429; - --codeBackgroundColor: rgba(0, 0, 0, 0.1); - --inlineCodeBackgroundColor: rgba(255, 255, 255, 0.06); -} -:root[data-mode=dark], :root[data-mode=darkest] { - --codeBlue: #77baff; - --codeGreen: #38c038; - --dividerColor: rgba(255, 255, 255, 0.1); - --faintFontColor: rgba(255, 255, 255, 0.6); - --fontColor: white; - --linkColor: #319be0; - --searchHighlightColor: #fe8e04; -} - -body { - font-family: Roboto, "OpenSans", sans-serif; - background-color: var(--mainBackgroundColor); - color: var(--fontColor); -} - -h1 { - font-size: 2rem; -} - -h2 { - font-size: 1.5rem; -} - -h3 { - font-size: 1.17rem; -} - -a { - color: var(--linkColor); - text-decoration: none; -} - -/*****************************************************************************/ -html { - height: 100%; - scroll-padding-top: var(--navbarHeight); -} - -html, -body { - padding: 0; - margin: 0; - min-height: 100%; -} - -body { - display: flex; - flex-direction: column; -} - -/*****************************************************************************/ -/* Top nav */ -#searchbox h3#searchlabel { - display: none; -} -#searchbox form.search { - display: flex; - flex-direction: row; -} -#searchbox form.search input { - display: block; - box-sizing: border-box; - padding: 0.3rem; - color: rgba(0, 0, 0, 0.7); - border-radius: 0.2rem; -} -#searchbox form.search input[type=text] { - border: none; - background-color: rgba(255, 255, 255, 0.6); - flex-grow: 1; - margin-right: 0.2rem; -} -#searchbox form.search input[type=text]::placeholder { - color: rgba(0, 0, 0, 0.6); -} -#searchbox form.search input[type=submit] { - cursor: pointer; - color: var(--mainNavColor); - flex-grow: 0; - border: none; - background-color: white; -} - -div#top_nav { - position: fixed; - top: 0; - left: 0; - right: 0; - color: white; - z-index: 100; -} -div#top_nav div#notification_banner { - background-color: var(--notificationBannerColor); - box-sizing: border-box; - padding: 0.1rem 1rem; - display: flex; - flex-direction: row; - align-items: center; - justify-content: right; -} -div#top_nav div#notification_banner a.close { - flex-grow: 0; - flex-shrink: 0; - color: rgba(255, 255, 255, 0.85); - text-align: right; - font-size: 0.6rem; - text-transform: uppercase; - display: block; - text-decoration: none; - margin-left: 0.5rem; -} -div#top_nav div#notification_banner a.close:hover { - color: white; -} -div#top_nav div#notification_banner p { - flex-grow: 1; - margin: 0; - text-align: center; - font-size: 0.9rem; - line-height: 1.2; - padding: 0.4rem 0; -} -div#top_nav div#notification_banner p a { - color: white; - text-decoration: underline; -} -div#top_nav nav { - background-color: var(--mainNavColor); - box-sizing: border-box; - padding: 1rem; - display: flex; - flex-direction: row; - align-items: center; -} -div#top_nav nav h1 { - flex-grow: 1; - font-size: 1.2rem; - margin: 0; - padding: 0 0 0 0.8rem; - line-height: 1; -} -div#top_nav nav h1 a { - color: white; -} -div#top_nav nav h1 img { - height: 1.3rem; - width: auto; -} -div#top_nav nav p#toggle_sidebar { - transform: rotate(90deg); - letter-spacing: 0.1rem; - flex-grow: 0; - margin: 0; - padding: 0; -} -div#top_nav nav p#toggle_sidebar a { - color: white; - font-weight: bold; -} -div#top_nav nav a#mode_toggle, div#top_nav nav a#source_link { - margin-right: 1rem; - display: block; - flex-grow: 0; -} -div#top_nav nav a#mode_toggle svg, div#top_nav nav a#source_link svg { - height: 1.3rem; - width: 1.3rem; - vertical-align: middle; -} -div#top_nav nav p.mobile_search_link { - margin: 0; -} -@media (min-width: 50rem) { - div#top_nav nav p.mobile_search_link { - display: none; - } -} -div#top_nav nav p.mobile_search_link a { - color: white; -} -div#top_nav nav p.mobile_search_link a svg { - height: 1rem; - vertical-align: middle; -} -@media (max-width: 50rem) { - div#top_nav nav div.searchbox_wrapper { - display: none; - } -} -div#top_nav nav div.searchbox_wrapper #searchbox { - align-items: center; - display: flex !important; - flex-direction: row-reverse; -} -div#top_nav nav div.searchbox_wrapper #searchbox p.highlight-link { - margin: 0 0.5rem 0 0; -} -div#top_nav nav div.searchbox_wrapper #searchbox p.highlight-link a { - color: rgba(255, 255, 255, 0.8); - font-size: 0.8em; - padding-right: 0.5rem; - text-decoration: underline; -} -div#top_nav nav div.searchbox_wrapper #searchbox p.highlight-link a:hover { - color: white; -} - -/*****************************************************************************/ -/* Main content */ -div.document { - flex-grow: 1; - margin-top: 2rem; - margin-bottom: 5rem; - margin-left: 15rem; - margin-right: 15rem; - padding-top: var(--navbarHeight); - /***************************************************************************/ - /***************************************************************************/ -} -@media (max-width: 50rem) { - div.document { - margin-left: 0px; - margin-right: 0px; - } -} -div.document section, -div.document div.section { - margin: 2rem 0; -} -div.document section:first-child, -div.document div.section:first-child { - margin-top: 0; -} -div.document section > section, -div.document div.section > div.section { - margin: 2rem 0; -} -div.document section > section > section, -div.document div.section > div.section > div.section { - margin: 2rem 0 0 0; -} -div.document section > section > section > section, -div.document div.section > div.section > div.section > div.section { - margin: 1.5rem 0 0 0; -} -div.document h1 + section, -div.document h1 + div.section { - margin-top: 2.5rem !important; -} -div.document h2 + section, -div.document h2 + div.section { - margin-top: 1.5rem !important; -} -div.document img { - max-width: 100%; -} -div.document code { - padding: 2px 4px; - background-color: var(--inlineCodeBackgroundColor); - border-radius: 0.2rem; - font-family: "Roboto Mono", monospace, Monaco, Consolas, Andale Mono; - font-size: 0.9em; -} -div.document div.documentwrapper { - max-width: 45rem; - margin: 0 auto; - flex-grow: 1; - box-sizing: border-box; - padding: 1rem; -} -div.document div.highlight { - color: #252630; - box-sizing: border-box; - padding: 0.2rem 1rem; - margin: 0.5rem 0; - border-radius: 0.2rem; - font-size: 0.9rem; -} -div.document div.highlight pre { - font-family: "Roboto Mono", monospace, Monaco, Consolas, Andale Mono; -} -div.document div[class*=highlight] { - overflow-x: auto; -} -div.document a.headerlink { - font-size: 0.6em; - display: none; - padding-left: 0.5rem; - vertical-align: middle; -} -div.document h1, -div.document h2, -div.document h3, -div.document h4, -div.document h5, -div.document h6, -div.document str, -div.document b { - font-weight: 700; -} -div.document h1 { - margin: 0.8rem 0 0.5rem 0; -} -div.document h2 { - margin: 0.8rem 0 0.5rem 0; -} -div.document h3, div.document h4 { - margin: 1rem 0 0.5rem 0; -} -div.document h1:hover a.headerlink, -div.document h2:hover a.headerlink, -div.document h3:hover a.headerlink, -div.document h4:hover a.headerlink { - display: inline-block; -} -div.document p, -div.document li { - font-size: 1rem; - line-height: 1.5; -} -div.document li p { - margin: 0 0 0.5rem 0; -} -div.document ul, div.document ol { - padding-left: 2rem; -} -div.document ol.loweralpha { - list-style: lower-alpha; -} -div.document ol.arabic { - list-style: decimal; -} -div.document ol.lowerroman { - list-style: lower-roman; -} -div.document ol.upperalpha { - list-style: upper-alpha; -} -div.document ol.upperroman { - list-style: upper-roman; -} -div.document dd { - margin-left: 1.5rem; -} -div.document hr { - border: none; - height: 1px; - background-color: var(--dividerColor); - margin: 2rem 0; -} -div.document table.docutils { - border-collapse: collapse; -} -div.document table.docutils th, div.document table.docutils td { - border: 1px solid var(--dividerColor); - box-sizing: border-box; - padding: 0.5rem 1rem; -} -div.document table.docutils th p, div.document table.docutils th ul, div.document table.docutils td p, div.document table.docutils td ul { - margin: 0.3rem 0; -} -div.document table.docutils th ul, div.document table.docutils td ul { - padding-left: 1rem; -} -div.document form input { - padding: 0.5rem; -} -div.document form input[type=submit], div.document form button { - border: none; - background-color: var(--mainNavColor); - color: white; - padding: 0.5rem 1rem; - border-radius: 0.2rem; -} -div.document span.highlighted { - background-color: var(--searchHighlightColor); - padding: 0 0.1em; -} -div.document div#search-results { - padding-top: 2rem; -} -div.document div#search-results p.search-summary { - font-size: 0.8em; -} -div.document div#search-results ul.search { - list-style: none; - padding-left: 0; -} -div.document div#search-results ul.search li { - border-bottom: 1px solid var(--dividerColor); - margin: 0; - padding: 2rem 0; -} -div.document div#search-results ul.search li > a:first-child { - font-size: 1.2rem; -} -div.document dd ul, div.document dd ol { - padding-left: 1rem; -} -div.document dl.py { - margin-bottom: 2rem; -} -div.document dl.py dt.sig { - background-color: var(--codeBackgroundColor); - color: var(--fontColor); - box-sizing: border-box; - font-family: "Roboto Mono", monospace, Monaco, Consolas, Andale Mono; - font-size: 0.9rem; - padding: 1rem; - border-left: 5px solid rgba(0, 0, 0, 0.1); - border-radius: 0.2rem; -} -div.document dl.py em.property { - color: var(--sidebarColor); - font-weight: bold; -} -div.document dl.py span.sig-name { - color: var(--codeBlue); - font-weight: bold; -} -div.document dl.py em.property { - color: var(--codeGreen); -} -div.document dl.py em.sig-param { - margin-left: 2rem; -} -div.document dl.py em.sig-param span.default_value { - color: var(--codeGreen); -} -div.document dl.py span.sig-return span.sig-return-typehint { - color: var(--fontColor); -} -div.document dl.py span.sig-return span.sig-return-typehint pre { - color: var(--fontColor); -} -div.document dl.py em.sig-param > span:first-child { - font-weight: bold; -} -div.document dl.cpp, div.document dl.c { - margin-bottom: 1rem; -} -div.document dl.cpp dt.sig, div.document dl.c dt.sig { - background-color: var(--codeBackgroundColor); - color: var(--fontColor); - box-sizing: border-box; - font-family: "Roboto Mono", monospace, Monaco, Consolas, Andale Mono; - font-size: 0.9rem; - padding: 1rem; - border-left: 5px solid rgba(0, 0, 0, 0.1); - border-radius: 0.2rem; - line-height: 1.4; -} -div.document dl.cpp span.sig-name, div.document dl.c span.sig-name { - color: var(--codeBlue); - font-weight: bold; -} -div.document dl.cpp span.sig-indent, div.document dl.c span.sig-indent { - margin-left: 2rem; -} -div.document dl.cpp span.target + span, div.document dl.c span.target + span { - color: var(--codeGreen); -} -div.document dl.cpp span.sig-param > span:first-child, div.document dl.c span.sig-param > span:first-child { - font-weight: bold; -} -div.document div.admonition { - box-shadow: 0px 0px 0px 1px var(--dividerColor); - border-radius: 0.2rem; - margin: 1rem 0; - overflow: hidden; -} -div.document div.admonition p { - box-sizing: border-box; - font-size: 0.9rem; - padding: 0.5rem; - margin: 0; -} -div.document div.admonition p:first-child { - padding-bottom: 0; - margin-bottom: 0; -} -div.document div.admonition p + p { - padding-top: 0.2rem; -} -div.document div.admonition p.admonition-title { - font-weight: bolder; - letter-spacing: 0.01rem; -} -div.document div.admonition.hint, div.document div.admonition.important, div.document div.admonition.tip { - border-left: 5px solid #56b79c; -} -div.document div.admonition.hint p.admonition-title, div.document div.admonition.important p.admonition-title, div.document div.admonition.tip p.admonition-title { - color: #56b79c; -} -div.document div.admonition.note { - border-left: 5px solid #587f9f; -} -div.document div.admonition.note p.admonition-title { - color: #587f9f; -} -div.document div.admonition.danger, div.document div.admonition.error { - border-left: 5px solid #e6a39a; -} -div.document div.admonition.danger p.admonition-title, div.document div.admonition.error p.admonition-title { - color: #e6a39a; -} -div.document div.admonition.attention, div.document div.admonition.caution, div.document div.admonition.warning { - border-left: 5px solid #e7b486; -} -div.document div.admonition.attention p.admonition-title, div.document div.admonition.caution p.admonition-title, div.document div.admonition.warning p.admonition-title { - color: #e7b486; -} - -/*****************************************************************************/ -/* Custom classes for UI control extensions: tabs, grids, cards. */ - -/* tab-heading: Heading for use inside tabs, since underline */ -/* notation doesn't work there. Invoke with: */ -/* .. container:: .tab-heading */ -/* Heading text */ - -.tab-heading p { - font-size: 1.2em !important; - font-weight: bold; -} - - -/*****************************************************************************/ -/* Sidebar */ -div.sphinxsidebar { - background-color: var(--sidebarColor); - border-right: 1px solid var(--dividerColor); - position: fixed; - left: 0; - top: 0; - bottom: 0; - width: 15rem; - box-sizing: border-box; - padding: var(--navbarHeight) 1rem 1rem; - z-index: 50; -} -@media (max-width: 50rem) { - div.sphinxsidebar { - display: none; - } -} -div.sphinxsidebar div.sphinxsidebarwrapper { - height: 100%; - overflow-y: auto; -} -/* This is a total hack to remove the inexplicable ToC from the left sidebar */ -div.sphinxsidebar div.sphinxsidebarwrapper > div { - display: none; -} -/* Format the TOC caption (title) */ -div.sphinxsidebar span.caption-text { - font-weight: bold; -} -div.sphinxsidebar ul { - padding-left: 0rem; - list-style: none; -} -div.sphinxsidebar ul li { - font-size: 0.9rem; - line-height: 1.2; -} -div.sphinxsidebar ul li a { - display: block; - box-sizing: border-box; - padding: 0 0.2rem 0.6rem; - color: var(--fontColor); - text-decoration: none; -} -div.sphinxsidebar ul li a.current { - color: var(--linkColor); -} -div.sphinxsidebar ul li a:hover { - color: var(--linkColor); -} -div.sphinxsidebar ul li > ul { - padding-left: 1rem; -} -div.sphinxsidebar p { - color: var(--faintFontColor); -} - -/*****************************************************************************/ -/* The right sidebar, showing the table of contents for the current page. */ -div#show_right_sidebar { - position: fixed; - right: 0; - top: 0; - z-index: 20; - background-color: var(--sidebarColor); - border-left: 1px solid var(--dividerColor); - border-bottom: 1px solid var(--dividerColor); - padding: var(--navbarHeight) 1rem 0rem; -} -div#show_right_sidebar p { - font-size: 0.9em; -} -div#show_right_sidebar p span { - color: var(--faintFontColor); - vertical-align: middle; -} -div#show_right_sidebar p span.icon { - color: var(--linkColor); - font-size: 0.9em; - padding-right: 0.2rem; -} - -div#right_sidebar { - position: fixed; - right: 0; - top: 0; - z-index: 50; - background-color: var(--sidebarColor); - width: 15rem; - border-left: 1px solid var(--dividerColor); - box-sizing: border-box; - padding: var(--navbarHeight) 1rem 1rem; - height: 100%; - overflow-y: auto; -} -div#right_sidebar p span { - color: var(--faintFontColor); - vertical-align: middle; -} -div#right_sidebar p span.icon { - color: var(--linkColor); - font-size: 0.9em; - padding-right: 0.2rem; -} -div#right_sidebar ul { - padding-left: 0rem; - list-style: none; -} -div#right_sidebar ul li { - font-size: 0.9rem; - line-height: 1.2; -} -div#right_sidebar ul li a { - display: block; - box-sizing: border-box; - padding: 0 0.2rem 0.6rem; - color: var(--fontColor); - text-decoration: none; -} -div#right_sidebar ul li a.current { - color: var(--linkColor); -} -div#right_sidebar ul li a:hover { - color: var(--linkColor); -} -div#right_sidebar ul li > ul { - padding-left: 1rem; -} -div#right_sidebar p { - color: var(--faintFontColor); -} -@media (max-width: 50rem) { - div#right_sidebar { - display: none; - } -} - -/* Limit the TOC depth in the right sidebar */ -div.page_toc ul ul ul { - display: none; -} - -/*****************************************************************************/ -/* Footer */ -div.footer { - box-sizing: border-box; - padding-top: 2rem; - font-size: 0.7rem; - text-align: center; - text-transform: uppercase; - color: var(--faintFontColor); -} - -p#theme_credit { - font-size: 0.6rem; - text-transform: uppercase; - text-align: center; - color: var(--faintFontColor); -} - -/*****************************************************************************/ -/* Buttons */ -div.button_nav_wrapper { - margin-left: 15rem; - margin-right: 15rem; -} -@media (max-width: 50rem) { - div.button_nav_wrapper { - margin-left: 0px; - margin-right: 0px; - } -} -div.button_nav_wrapper div.button_nav { - max-width: 45rem; - margin: 0 auto; - display: flex; - flex-direction: row; - width: 100%; -} -div.button_nav_wrapper div.button_nav div { - box-sizing: border-box; - padding: 1rem; - flex: 50%; -} -div.button_nav_wrapper div.button_nav div a { - display: block; -} -div.button_nav_wrapper div.button_nav div a span { - vertical-align: middle; -} -div.button_nav_wrapper div.button_nav div a span.icon { - font-weight: bold; - font-size: 0.8em; -} -div.button_nav_wrapper div.button_nav div.left a { - text-align: left; -} -div.button_nav_wrapper div.button_nav div.left a span.icon { - padding-right: 0.4rem; -} -div.button_nav_wrapper div.button_nav div.right a { - text-align: right; -} -div.button_nav_wrapper div.button_nav div.right a span.icon { - padding-left: 0.4rem; -} - -/*****************************************************************************/ -/* Pygments overrides in dark mode */ -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight { - --black: #000000; - --red: #ff9393; - --darkBlue: #6b83fe; - --grey: #a8a8a8; - --pink: #ff99d8; - --torquoise: #68e9e9; - --brown: #d48a00; - --purple: #ce04e9; - --paleYellow: #454534; - background: var(--codeBackgroundColor); - color: var(--fontColor); - /* Comment */ - /* Error */ - /* Keyword */ - /* Operator */ - /* Comment.Hashbang */ - /* Comment.Multiline */ - /* Comment.Preproc */ - /* Comment.PreprocFile */ - /* Comment.Single */ - /* Comment.Special */ - /* Generic.Deleted */ - /* Generic.Emph */ - /* Generic.Error */ - /* Generic.Heading */ - /* Generic.Inserted */ - /* Generic.Output */ - /* Generic.Prompt */ - /* Generic.Strong */ - /* Generic.Subheading */ - /* Generic.Traceback */ - /* Keyword.Constant */ - /* Keyword.Declaration */ - /* Keyword.Namespace */ - /* Keyword.Pseudo */ - /* Keyword.Reserved */ - /* Keyword.Type */ - /* Literal.Number */ - /* Literal.String */ - /* Name.Attribute */ - /* Name.Builtin */ - /* Name.Class */ - /* Name.Constant */ - /* Name.Decorator */ - /* Name.Entity */ - /* Name.Exception */ - /* Name.Function */ - /* Name.Label */ - /* Name.Namespace */ - /* Name.Tag */ - /* Name.Variable */ - /* Operator.Word */ - /* Text.Whitespace */ - /* Literal.Number.Bin */ - /* Literal.Number.Float */ - /* Literal.Number.Hex */ - /* Literal.Number.Integer */ - /* Literal.Number.Oct */ - /* Literal.String.Affix */ - /* Literal.String.Backtick */ - /* Literal.String.Char */ - /* Literal.String.Delimiter */ - /* Literal.String.Doc */ - /* Literal.String.Double */ - /* Literal.String.Escape */ - /* Literal.String.Heredoc */ - /* Literal.String.Interpol */ - /* Literal.String.Other */ - /* Literal.String.Regex */ - /* Literal.String.Single */ - /* Literal.String.Symbol */ - /* Name.Builtin.Pseudo */ - /* Name.Function.Magic */ - /* Name.Variable.Class */ - /* Name.Variable.Global */ - /* Name.Variable.Instance */ - /* Name.Variable.Magic */ - /* Literal.Number.Integer.Long */ -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight pre, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight pre { - line-height: 125%; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight td.linenos .normal, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight td.linenos .normal { - color: inherit; - background-color: transparent; - padding-left: 5px; - padding-right: 5px; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight span.linenos, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight span.linenos { - color: inherit; - background-color: transparent; - padding-left: 5px; - padding-right: 5px; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight td.linenos .special, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight td.linenos .special { - color: var(--black); - background-color: var(--paleYellow); - padding-left: 5px; - padding-right: 5px; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight span.linenos.special, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight span.linenos.special { - color: var(--black); - background-color: var(--paleYellow); - padding-left: 5px; - padding-right: 5px; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .hll, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .hll { - background-color: var(--paleYellow); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .c, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .c { - color: var(--torquoise); - font-style: italic; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .err, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .err { - border: 1px solid var(--red); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .k, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .k { - color: var(--codeGreen); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .o, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .o { - color: var(--grey); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .ch, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .ch { - color: var(--torquoise); - font-style: italic; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .cm, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .cm { - color: var(--torquoise); - font-style: italic; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .cp, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .cp { - color: var(--brown); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .cpf, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .cpf { - color: var(--torquoise); - font-style: italic; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .c1, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .c1 { - color: var(--torquoise); - font-style: italic; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .cs, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .cs { - color: var(--torquoise); - font-style: italic; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .gd, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .gd { - color: var(--red); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .ge, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .ge { - font-style: italic; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .gr, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .gr { - color: var(--red); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .gh, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .gh { - color: var(--codeBlue); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .gi, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .gi { - color: var(--codeGreen); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .go, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .go { - color: var(--grey); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .gp, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .gp { - color: var(--codeBlue); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .gs, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .gs { - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .gu, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .gu { - color: var(--purple); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .gt, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .gt { - color: var(--codeBlue); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .kc, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .kc { - color: var(--codeGreen); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .kd, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .kd { - color: var(--codeGreen); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .kn, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .kn { - color: var(--codeGreen); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .kp, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .kp { - color: var(--codeGreen); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .kr, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .kr { - color: var(--codeGreen); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .kt, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .kt { - color: var(--red); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .m, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .m { - color: var(--grey); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .s, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .s { - color: var(--red); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .na, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .na { - color: var(--codeGreen); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .nb, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .nb { - color: var(--codeGreen); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .nc, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .nc { - color: var(--codeBlue); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .no, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .no { - color: var(--red); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .nd, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .nd { - color: var(--purple); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .ni, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .ni { - color: var(--grey); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .ne, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .ne { - color: var(--red); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .nf, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .nf { - color: var(--codeBlue); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .nl, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .nl { - color: var(--codeGreen); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .nn, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .nn { - color: var(--codeBlue); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .nt, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .nt { - color: var(--codeGreen); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .nv, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .nv { - color: var(--darkBlue); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .ow, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .ow { - color: var(--pink); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .w, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .w { - color: var(--grey); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .mb, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .mb { - color: var(--grey); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .mf, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .mf { - color: var(--grey); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .mh, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .mh { - color: var(--grey); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .mi, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .mi { - color: var(--grey); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .mo, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .mo { - color: var(--grey); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .sa, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .sa { - color: var(--red); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .sb, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .sb { - color: var(--red); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .sc, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .sc { - color: var(--red); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .dl, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .dl { - color: var(--red); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .sd, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .sd { - color: var(--red); - font-style: italic; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .s2, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .s2 { - color: var(--red); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .se, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .se { - color: var(--brown); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .sh, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .sh { - color: var(--red); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .si, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .si { - color: var(--pink); - font-weight: bold; -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .sx, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .sx { - color: var(--codeGreen); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .sr, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .sr { - color: var(--pink); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .s1, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .s1 { - color: var(--red); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .ss, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .ss { - color: var(--darkBlue); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .bp, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .bp { - color: var(--codeGreen); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .fm, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .fm { - color: var(--codeBlue); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .vc, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .vc { - color: var(--darkBlue); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .vg, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .vg { - color: var(--darkBlue); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .vi, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .vi { - color: var(--darkBlue); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .vm, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .vm { - color: var(--darkBlue); -} -:root[data-mode=dark] body[data-dark_mode_code_blocks=true] .highlight .il, -:root[data-mode=darkest] body[data-dark_mode_code_blocks=true] .highlight .il { - color: var(--grey); -} - -/*# sourceMappingURL=basic_mod.css.map */ diff --git a/Docs/beta/_templates/brand.html b/Docs/beta/_templates/brand.html new file mode 100644 index 00000000000..5653e1b20d7 --- /dev/null +++ b/Docs/beta/_templates/brand.html @@ -0,0 +1,31 @@ +{#- + +Hi there! + +You might be interested in https://pradyunsg.me/furo/customisation/sidebar/ + +Although if you're reading this, chances are that you're either familiar +enough with Sphinx that you know what you're doing, or landed here from that +documentation page. + +Hope your day's going well. :) + +-#} + diff --git a/Docs/beta/_templates/ethical-ads.html b/Docs/beta/_templates/ethical-ads.html new file mode 100644 index 00000000000..0c682a4e823 --- /dev/null +++ b/Docs/beta/_templates/ethical-ads.html @@ -0,0 +1,10 @@ +{# Add the ethical ads div, when generating documentation on Read the Docs #} +{% if READTHEDOCS %} +
    +{% endif %} diff --git a/Docs/beta/_templates/navigation.html b/Docs/beta/_templates/navigation.html new file mode 100644 index 00000000000..eda5176075d --- /dev/null +++ b/Docs/beta/_templates/navigation.html @@ -0,0 +1,3 @@ +
    + {{ furo_navigation_tree }} +
    diff --git a/Docs/beta/_templates/rtd-versions.html b/Docs/beta/_templates/rtd-versions.html new file mode 100644 index 00000000000..4b75680ecce --- /dev/null +++ b/Docs/beta/_templates/rtd-versions.html @@ -0,0 +1,34 @@ +{# Add rst-badge after rst-versions for small badge style. #} +{% if READTHEDOCS %} +
    + + Read the Docs + v: {{ current_version }} + + +
    +
    +
    {{ _('Versions') }}
    + {% for slug, url in versions %} +
    {{ slug }}
    + {% endfor %} +
    +
    +
    {{ _('Downloads') }}
    + {% for type, url in downloads %} +
    {{ type }}
    + {% endfor %} +
    +
    + {# Translators: The phrase "Read the Docs" is not translated #} +
    {{ _('On Read the Docs') }}
    +
    + {{ _('Project Home') }} +
    +
    + {{ _('Builds') }} +
    +
    +
    +
    +{% endif %} diff --git a/Docs/beta/_templates/scroll-end.html b/Docs/beta/_templates/scroll-end.html new file mode 100644 index 00000000000..04f5b844997 --- /dev/null +++ b/Docs/beta/_templates/scroll-end.html @@ -0,0 +1 @@ + diff --git a/Docs/beta/_templates/scroll-start.html b/Docs/beta/_templates/scroll-start.html new file mode 100644 index 00000000000..d003e58d3c7 --- /dev/null +++ b/Docs/beta/_templates/scroll-start.html @@ -0,0 +1 @@ +
    diff --git a/Docs/beta/_templates/search.html b/Docs/beta/_templates/search.html new file mode 100644 index 00000000000..7a3e910a4e2 --- /dev/null +++ b/Docs/beta/_templates/search.html @@ -0,0 +1,6 @@ + + diff --git a/Docs/beta/_templates/variant-selector.html b/Docs/beta/_templates/variant-selector.html new file mode 100644 index 00000000000..aefb22ec067 --- /dev/null +++ b/Docs/beta/_templates/variant-selector.html @@ -0,0 +1,33 @@ +{# Add variant selector for Read the Docs embedding #} +{% if READTHEDOCS %} +
    + +   + v: {{ current_version }} + +
    +
    +
    {{ _('Versions') }}
    + {% for slug, url in versions %} +
    {{ slug }}
    + {% endfor %} +
    +
    +
    {{ _('Downloads') }}
    + {% for type, url in downloads %} +
    {{ type }}
    + {% endfor %} +
    +
    + {# Translators: The phrase "Read the Docs" is not translated #} +
    {{ _('On Read the Docs') }}
    +
    + {{ _('Project Home') }} +
    +
    + {{ _('Builds') }} +
    +
    +
    +
    +{% endif %} diff --git a/Docs/beta/apiref/index.rst b/Docs/beta/apiref/index.rst index 3d98f4071dc..e708386ed35 100644 --- a/Docs/beta/apiref/index.rst +++ b/Docs/beta/apiref/index.rst @@ -2,4 +2,102 @@ ######### AIMET API -######### \ No newline at end of file +######### + +.. toctree:: + :hidden: + + Quantization aware training + Automatic quantization + Adaptive rounding + Cross-layer equalization + Batch norm re-estimation + Quantization analyzer + Visualization + Weight SVD + Spatial SVD + Channel pruning + +Quantization aware training (QAT) +================================= + +Fine-tunes the model parameters in the presence of quantization noise. + +:ref:`Quantization aware training (QAT) ` + + +Automatic quantization (AutoQuant) +================================== + +Analyzes the model, determines the best sequence of AIMET post-training quantization techniques, and applies these techniques. + +:ref:`Automatic quantization (AutoQuant) ` + + +Adaptive rounding (Adaround) +============================ + +Uses training data to improve accuracy over naïve rounding. + +:ref:`PyTorch ` + +:ref:`TensorFlow ` + +:ref:`ONNX ` + + +Cross-layer equalization (CLE) +============================== + +Scales the parameter ranges across different channels to increase the range for layers with low range and reduce range for layers with high range, enabling the same quantizaion parameters to be used across all channels. + +:ref:`Cross-layer equalization (CLE) ` + + +Batch norm re-estimation (BN) +============================= + +Re-estimated statistics are used to adjust the quantization scale parameters of preceeding Convolution or Linear layers, effectively folding the BN layers. + +:ref:`Batch norm re-estimation (BN) ` + + +Quantization analyzer (QuantAnalzer) +===================================== + +Automatically identify sensitive areas and hotspots in the model. + +:ref:`Quantization analyzer (QuantAnalzer) ` + + +Visualization +============= + +Automatically identify sensitive areas and hotspots in the model. + +:ref:`Visualization ` + + +Weight singular value decomposition (Weight SVD) +============================================================================ + +Decomposes one large MAC or memory layer into two smaller layers. + +:ref:`Weight singular value decomposition (Weight SVD) ` + + +Spatial singular value decomposition (Spatial SVD) +=============================================================================== + +Decomposes one large convolution (Conv) MAC or memory layer into two smaller layers. + +:ref:`Spatial singular value decomposition (Spatial SVD) ` + + +Channel pruning (CP) +======================================== + +Removes less-important input channels from 2D convolution layers. + +:ref:`Channel pruning (CP) ` + diff --git a/Docs/beta/apiref/onnx/adaround.rst b/Docs/beta/apiref/onnx/adaround.rst index bdc8487ac32..920509e6b76 100644 --- a/Docs/beta/apiref/onnx/adaround.rst +++ b/Docs/beta/apiref/onnx/adaround.rst @@ -1,5 +1,4 @@ .. _apiref-onnx-adaround: - :orphan: ####################### AIMET ONNX AdaRound API diff --git a/Docs/beta/apiref/tensorflow/adaround.rst b/Docs/beta/apiref/tensorflow/adaround.rst index 28860723e75..87571afca8e 100644 --- a/Docs/beta/apiref/tensorflow/adaround.rst +++ b/Docs/beta/apiref/tensorflow/adaround.rst @@ -1,5 +1,4 @@ .. _apiref-keras-adaround: - :orphan: ############################# AIMET TensorFlow AdaRound API diff --git a/Docs/beta/apiref/torch/adaround.rst b/Docs/beta/apiref/torch/adaround.rst index 005f56c28df..87b44a0a55c 100644 --- a/Docs/beta/apiref/torch/adaround.rst +++ b/Docs/beta/apiref/torch/adaround.rst @@ -1,14 +1,12 @@ .. _apiref-torch-adaround: - :orphan: ########################## AIMET PyTorch AdaRound API ########################## -.. container:: tab-heading - - Top-level API +Top-level API +============= .. note:: @@ -19,17 +17,15 @@ AIMET PyTorch AdaRound API .. autofunction:: aimet_torch.v1.adaround.adaround_weight.Adaround.apply_adaround -.. container:: tab-heading - - Adaround Parameters +Adaround Parameters +=================== .. autoclass:: aimet_torch.v1.adaround.adaround_weight.AdaroundParameters :members: -.. container:: tab-heading - - Enum Definition +Enum Definition +=============== **Quant Scheme Enum** diff --git a/Docs/beta/conf.py b/Docs/beta/conf.py index df85b122624..b42a6126046 100644 --- a/Docs/beta/conf.py +++ b/Docs/beta/conf.py @@ -78,6 +78,7 @@ def setup(app): # If your documentation needs a minimal Sphinx version, state it here. # # needs_sphinx = '5.3.0' +needs_sphinx = '7.3.7' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -93,8 +94,8 @@ def setup(app): 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', - 'sphinx_tabs.tabs', - 'sphinx_design' + 'sphinx_design', + 'sphinx_copybutton' ] # Add any paths that contain templates here, relative to this directory. @@ -132,9 +133,9 @@ def setup(app): # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'piccolo_theme' -html_title = 'AI Model Efficiency Toolkit Documentation version ' + version -html_short_title = 'AIMET Docs v. ' + version +html_theme = 'furo' +html_title = 'AI Model Efficiency Toolkit v. ' + release +# html_short_title = 'AIMET Docs v. ' + version # html_logo = 'images/brain_logo.png' # html_favicon = 'images/brain_logo16.png' @@ -143,21 +144,29 @@ def setup(app): # documentation. # html_theme_options = { - 'banner_hiding': "temporary", - 'banner_text': "", - 'display_version': True, - 'source_url': "https://github.com/quic/aimet", - 'localtoc_maxdepth': 2, - 'globaltoc_includehidden': True, - 'globaltoc_maxdepth': 2, - 'globaltoc_collapse': False + "sidebar_hide_name": False, # Default is False + "top_of_page_buttons": [], + "navigation_with_keys": True, +# "announcement": "Important announcement!", + "footer_icons": [ # This is ugly. Will fix later. + { + "name": "GitHub", + "url": "https://github.com/quic/aimet", + "html": """ + + + + """, + "class": "", + }, + ], } # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] -html_css_files = ['style.css'] +html_css_files = ['aimet-furo.css'] # Changes from default theme file. # Custom sidebar templates, must be a dictionary that maps document names # to template names. @@ -167,7 +176,16 @@ def setup(app): # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', # 'searchbox.html']``. # -html_sidebars = {'**': ['globaltoc.html', 'localtoc.html', 'searchbox.html'] } +# furo theme sidebars +html_sidebars = { + "**": [ + "sidebar/brand.html", + "sidebar/scroll-start.html", + "sidebar/navigation.html", +# "sidebar/search.html", + "sidebar/scroll-end.html", + ] +} # -- Options for HTMLHelp output --------------------------------------------- @@ -207,7 +225,7 @@ def setup(app): # author, documentclass [howto, manual, or own class]). latex_documents = [ (root_doc, 'AIMET.tex', 'AI Model Efficiency Toolkit Documentation', - 'Qualcomm Innovation Center, Inc.', 'manual'), + 'Qualcomm Innovation Center, Inc.', 'manual') ] @@ -217,7 +235,7 @@ def setup(app): # (source start file, name, description, authors, manual section). man_pages = [ (root_doc, 'aimet', 'AI Model Efficiency Toolkit Documentation', - [author], 1) + author, 1) ] @@ -249,6 +267,16 @@ def setup(app): 'display_version_tab': False } +docs_root_url = "https://quic.github.io/aimet-pages/releases/latest/" + +# Version here refers to the AIMET torch v1/v2 version, not the AIMET release number +html_context = { + 'current_version' : "Universal", + 'versions' : [["Universal", docs_root_url + "features/index.html"], + ["PyTorch", docs_root_url + "torch_v2/torch_docs/index.html"]], + 'display_version_tab': False +} + autosummary_generate = False # contains a list of modules to be mocked up which are not available during docs build time diff --git a/Docs/beta/featureguide/adaround.rst b/Docs/beta/featureguide/adaround.rst index 9ba69283c4b..6fb3ea38c91 100644 --- a/Docs/beta/featureguide/adaround.rst +++ b/Docs/beta/featureguide/adaround.rst @@ -65,9 +65,11 @@ Step 1 Prepare the model for quantization. -.. tabs:: +.. tab-set:: + :sync-group: platform - .. tab:: PyTorch + .. tab-item:: PyTorch + :sync: torch .. container:: tab-heading @@ -80,16 +82,19 @@ Prepare the model for quantization. .. literalinclude:: ../snippets/torch/prepare_model.py :language: python - :lines: 38- For details of the model preparer API see the :ref:`Model Preparer API `. - .. tab:: TensorFlow + .. tab-item:: TensorFlow + :sync: tf + Tensorflow has no preparation requirements. - .. tab:: ONNX + .. tab-item:: ONNX + :sync: onnx + ONNX has no preparation requirements. @@ -99,20 +104,23 @@ Step 2 Apply AdaRound to the model. -.. tabs:: +.. tab-set:: + :sync-group: platform - .. tab:: PyTorch + .. tab-item:: PyTorch + :sync: torch .. literalinclude:: ../snippets/torch/apply_adaround.py :language: python - :lines: 38- - .. tab:: TensorFlow + .. tab-item:: TensorFlow + :sync: tf .. literalinclude:: ../snippets/tensorflow/apply_adaround.py :language: python - .. tab:: ONNX + .. tab-item:: ONNX + :sync: onnx .. literalinclude:: ../snippets/onnx/apply_adaround.py :language: python @@ -122,20 +130,24 @@ Step 3 Evaluate the model. -.. tabs:: +.. tab-set:: + :sync-group: platform + + .. tab-item:: PyTorch + :sync: torch - .. tab:: PyTorch .. literalinclude:: ../snippets/torch/evaluate.py :language: python - :lines: 38- - .. tab:: TensorFlow + .. tab-item:: TensorFlow + :sync: tf .. literalinclude:: ../snippets/tensorflow/evaluate.py :language: python - .. tab:: ONNX + .. tab-item:: ONNX + :sync: onnx .. literalinclude:: ../snippets/onnx/evaluate.py :language: python @@ -152,20 +164,24 @@ Next steps If AdaRound resulted in satisfactory accuracy, export the model. -.. tabs:: +.. tab-set:: + :sync-group: platform + + .. tab-item:: PyTorch + :sync: torch - .. tab:: PyTorch .. literalinclude:: ../snippets/torch/export.py :language: python - :lines: 38- - .. tab:: TensorFlow + .. tab-item:: TensorFlow + :sync: tf .. literalinclude:: ../snippets/tensorflow/export.py :language: python - .. tab:: ONNX + .. tab-item:: ONNX + :sync: onnx .. literalinclude:: ../snippets/onnx/export.py :language: python @@ -176,16 +192,23 @@ If the model is still not accurate enough, the next step is typically to try :re API === -.. tabs:: +.. tab-set:: + :sync-group: platform - .. tab:: PyTorch + .. tab-item:: PyTorch + :sync: torch - .. include:: ../apiref/torch/adaround.rst + .. include:: ../apiref/torch/adaround.rst + :start-after: _apiref-torch-adaround: - .. tab:: TensorFlow + .. tab-item:: TensorFlow + :sync: tf - .. include:: ../apiref/tensorflow/adaround.rst + .. include:: ../apiref/tensorflow/adaround.rst + :start-after: _apiref-keras-adaround: - .. tab:: ONNX + .. tab-item:: ONNX + :sync: onnx - .. include:: ../apiref/onnx/adaround.rst + .. include:: ../apiref/onnx/adaround.rst + :start-after: _apiref-onnx-adaround: diff --git a/Docs/beta/featureguide/index.rst b/Docs/beta/featureguide/index.rst index 4e9fe4ce6bc..a532ca2738b 100644 --- a/Docs/beta/featureguide/index.rst +++ b/Docs/beta/featureguide/index.rst @@ -19,17 +19,17 @@ Optimization Techniques Channel pruning :ref:`Quantization aware training (QAT) ` -====================================================== +=========================================================== Fine-tunes the model parameters in the presence of quantization noise. :ref:`Automatic quantization (AutoQuant) ` -============================================================= +================================================================== Analyzes the model, determines the best sequence of AIMET post-training quantization techniques, and applies these techniques. :ref:`Adaptive rounding (Adaround) ` -====================================================== +=========================================================== Uses training data to improve accuracy over naïve rounding. diff --git a/Docs/beta/images/brain_logo.png b/Docs/beta/images/brain_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..72de002b17fa85736694295bb93880ffedd24abc GIT binary patch literal 10266 zcmdUV^;gtS)W1qC0#eeAu%xh(N=Qh`(v8%T5(>hKA`J^j#}d1w)RNL64NJok(nyJP z2(ol751;S({teGL&kysSGc)JRo%fx4?!EK6uLvD2RkDYS5AWT(N2ac(q<7b2?pgzY z@a}8bSM~3%yYH!|s(7z_gn9dJfbXcFsc`RJRUFARgy3#W?5<|&dGFq%uK(KoKDQ#f zd-r%M)RhzrK3o3H3{PcNPV7B!ld`TtGp%F_RzEq2PmTZ7&v_8a6(3K*o?)_A-613> z$h`Z0F2o{Q%wKHDr|`%1I#^x2U~hkLKP#t{XSMZ!1Jw*R?nz~!WT3pT`qLc&ANvDX z?T!e2j(+~Zh9efFm0|MrNi;PN?f>4iQ~Y$j23Frcz2y>;DY$G1gd5WiP;1lme_!=j zPnf$9fhboAE?M&TEf=L6_`6OmYllOs}uIQjHf4eEflo_HIKOU*|;z~CYV`9wts&He7<+ZMx|4#4%2peoJ`6u}L z48FPEw6eMW<>XefxP4jTrE!?nP%3l5EYDJTa^%j)lIWbe#jA#ve6{$RT(y1U&1OHv z@}~FYZ6kF%UuH<9D{gl!Qb!N;&mKlHzGIVoLbb5NYnUPDracX=yMm`U99Bd3Til_`6)ColmjRl6~_a;a(H0-Bc9KwHHn4 z>;4BoZ4BxeX)$&*sKnvpFcvQwe<_LjEm;L-Tv?Tmx6eo1+0&o?(F^Hnd^V7Cp!g0$fsr(7O%K6&U^0Gk_@1OIMFGUf(Q9+ zGL4l6DJ*Z}|5nrvrszKvvDHuhPY39c`X65B1dX;fZGy9g0`sG_gPxAR?0)V`dAmDQ z;V{tX@H(Qwf}+WSQN(}Zu9IefqkFuf{Ez9|OU(Hor7iy;4K2r48XkHp|J#COweC3MA>>w8w?J_T`jRa&%xDOJAPk~;5hv?l1Y68HL8P`_E7fnlqn<`ejFs< zoL}p1WXzPZ(JSiPOx>E}E{Zne2$*>~x>uUI3_JFt-*#h#3&3X#2M4>zs?~?@Nn1Ki zI863Z4_8A2T4m~5!0&zeuggA$bBdvIw{abptD4xcjM-i38NO<`=1oPm*?O*s=7eEv zJekNAafqkJqZyw7*Z8gqqoJ@@G}T*;dJL^UbjsPBjEaBCcEU)>IyDBGBsru%0{H^UlnACP{jLK))oqhU36&X3HQT2NlrY!9DZkf zSN>?))NzawReF_ZFb&-q<9pcg$6AJH7QY{4?^lpUBX!C91lQRMANIKFzJ_gbfdaF! z*FF}0BZp|!MUQ{x;mltO^(_r*qRu`gW$((0NqD$72xEkBeYf|K&2b;dP*93MB=c^GSDiR)hfa5Kv(lbxPaWk3=D%gRCi zasY>7nsCM|W^(VZ)tbvD1>j0&(_2M2v(N3r9CofYbp-mEFY5?(hCSe^=evn#kWSA$ zu9a^h5YsigVdu*JZycoFkfaS(-vTo_9pvLq!cW?KNmHX|hMyfmbv10mb8pxm)NjU| zzU&iTC;%5k7$PQr*@ru?>sX zkdc0b50TlEGA(x8?~KPn>9ez` zY4*wEwog7mheBu%w^ZU-~}9ASfxSxl3b{Hkz{(A5LO+ni_V5CLNW)p z?+I`EtaKg9tL)rv)<-}5&JJkMc>j=cm`M#C*thw(pT|nlq17qn1O}l@{BmKyWQ3o< z57|#!piVnw3ov+b{``b`#-Km{V{-Mz+dN$Q*$Yuklfr;+#7F6rbauE6y^Hy?xkWbi zQsNLzO{M4*B~)t0Lp^TNhq5~i_U{R%Jxuyud~;w`99k>Bkn_PUYI(aG{izh8e~Z5N zI#WBNbn0DRwPAG{sK=hAN#J#hI1w#*pP(@OLfYBBb3{tEdRg+u*^2Y40dd#Gv-XX5 z6^(-zl0orD6Z6iBg$wzL^w?hjdGNeW!IMwga>h@(=#s-k2#TqOH>NdBHR)Y<4u>$r zNrC?a1^!A~y_?9ph+_M=+tZmG&SYPrM+?p~LA2JHd9_VXt1`R;;34?b)-nqF2g|4o z-Ul-D+B`WM_@ue{jDr@^uboHQd7LiuZ+?cwZM=qg6jt}`d*Pc&YrULNm!>Qt5#Z8A zSvaVO9El3>FBv&!U6ysG1!7_*7}&s8EW zo+H&MpveNb62nlf4b-Z-LM!f@e~%i$07Y+{qm}DEwc^GSD1r(Z4(#Rx^LGf^Nr+jD z#wpLguBjh2ou=AQ)NRK6a{qa*c;A1x$yQTpu{)o6An>R6Z0_s~7)B<1%uVWTe{P66 z06u7Rwlzv(5d8-4IV5j}HU@2f@gHlxm=CabtQB-2e)Y63X{u_N$N|wfh$K_VmC4Wp zel;#e0F;_QAB!Bg=&hS9>GR>B>o%W4y1_Qd`4g~x(}4*ft%wz&;P^h$qW*7?c!hSm z(~ckY9Ji?kLhd%t^u=|R%S(`F|E6NjwFAjuaPGc74u7r|9})>8utVQh=vUeaX07Zk9;^Jw(z{T2Tc40r}>d;Evf``~B~dR>zOf|fGZ@g5HK zY|h?X(u_0rXf0bFm5SAkqkTBuqd#NA{^=VkJXgo3WUf(g&SPm}tlL?Km4u+d6!F;WAA zw+?xCmaugheB|^cN8uYgFJ4seHb$~W8AZ{H2V@zAIogT_j+vbewM(A0MeHS(afAJA zwN2)Z6|b0h>5>!5N~j~|q1C1hGOzJz0auq~va$8s%|M;M>Ntj|j0oq`E9$5z&q9~C z60fJJ!p7%fRQboVph!S;Z#)5k!(wm|Ts1K0-b~)qL>OJ#vEMa6YCY#+@w@&JgWEDL zQuS15j#X30bzu-U>4j0PDdXE*d<9FLnX1(Cb9m zl3Tj_E2bCD-IDFIICT7>w}%N*7hz;sIFPK$_))+#pv0e(qV9=dSlfMAsJg~sx=Tdh zi%;?_Y}2~hbnKWAQLOz`o5+hZr&b}W5!7o;89S+PesSZQwoBETJ%`oF7X&%ZDwlY6 z4}3Uw$okTuj`W;vYu^*bwycgKhU!(M|l9rx-?5hRcqF61T`W@^q z6;Ao!z72~AY|eSZofmAKco;)}14hb}#vW#`&TvH&Jse`qv|x8!s+f55pxWwf68AXl z5WbGvzR`bdPa+5DE&DcJ6At2iu|zcbmfSO@DQl!ry{Ht6Z;qrBoU4gC!k&XqsRvw96r*-mwG6A-p2Js=p0~eZTH7C3sjhA8?I#FL(7cV~f-p{QDb<9gzuHS5B~f&` zd1~Ah_%X@Cao!GH;{M%Awwnvnwg#Xk+-4`e@D!CW+nIJ=cmvJUSNHktmTu^k% zV9n~1482a1g5oR$8>M9C4WOE^@2XO(co5F})pL+ZT*CiRN zx}-!fLuOyU$4!sx)R2HE38}v2V`Mz*S7uKGZ+U{AnQV@hyvXk?RG$Pagn<@_+NgG) zl8^9@f48v>8qGFw*PXc`(nQ%2ceN_giafmTyFVTE_6d!z3dx+^X>!}5N8nRP$K(_@ z*1p>T*-sf}g0t0r<4S19P73?hNB5JRmR7bht26RCEl<<$)ZtKG8hC0H(QuGY2KhlQ zWf~@a23V(Zek5_L5eD+j{>Z`UjfgoG7N3Ypb_lYP&v z?E~inUhU?y@aS~>tFMj#@lvhW!bJ`xReU{ufH%nV1o9OUg8LpYq21Y{&Zgf`hUv13 zjs&p2LA%GrbN^Tj`$WnG^yygZ_7wEN;K$vGReIjQS{k3$v}Gru8VSmeu9$r{)7zf{ z3T&4XX;7krBAW&)AufXBc2bb7dZ#o~_XXtPTbs`_Nx=xp3Mdt!;G!;2_tzg8Js6+h z-}un^y-0K-2kCE7Fx8G(Fp%P(8uh~Bb6Uu(F;#XCc_O!NTM#EHNwmJtjOq1qh#&%j zDQPG^>Tb@4QakLUqOfrRs*X`dYLpwk3eA{#*O{}Zr>%1Zv$r0)`5>k;k->4ti^kM9 zF)q}00Qm71TZ}Cwq4FYXWVNrC`sw8Xo&v%pJUf-o*@0N@n9Ebzb_TS5Rtp7vT3ZuHtUtbB{wK(r7be)bi|j}VF54p-?K+62BaH}U z*wt7|50FA1M;S~)cQWHN$(Qh(#^5&X2g9YRhDNyUu*A11_c83Q6ER(JeCu*_38G%a zM{P`8q_RV(cV&r%DXA6&*h*GJ!jGDma05WsBLW3|(&~7T?r&6KKg!0)t<0STb!Sh$ zG|M!Cyj+${OsZQAaGsqPpc_sY+YB3Nc1dtZ^PYU`&x}8A=MoTA<;N>++o4}>dMhe- zlli*d+bo?0!&aL2E)-8cP+TqVk15+gk_BndI)w658|$M<p5D)&S7D-7oXYgD$iX*?VacX@^Z#s?bNR_zphhEnd=e}! z4@Ajos9v|NL!&H%cxvXdsi?TXGT+AVXt=wsyPp;IN6Qm>+m;od-&81BAKVV_nB0nA zn|vrzAm>Nf+Cr|Pk`o5aW0@f%{w6$e!^92l17?cu!hYlwVacx7BokFtzmbkgV*mg} z=utpcG3>t5fX){OB?l{}>U;h2?i~SSa)8WbS?=pxti=m&kDUfV^V7BkfZ7`16(CV3 zf13bbp+9x<5jgkvkn(nKITvK?Wi>Uq1Z;)1KFhh$yg}QYgZ4aQj*LjwqWD?;w=3>q zF$K9tV>Xhii>kSk9CD~Kz6kTK_I^rKdDWZKjFQB3#Z#ud92WoR)cQwiV)@?Z-v^mV zq?^J+$sjH9LZU1JoAM*JTh7^$+kwv`O zHEF-{X%2TeGzw=J>+NO|*$WwWz4u&JfdcDgqx1 z)Dp+Tram|IQlNX2#Qa9PC{JGO%AeEO30Kzt@k{v%BIUeR3Ge~t23$|$5Pl)_HTi`@ z0iID&i3Jv0B8pc(3zNIpR6gk69}GTt)$ls$D-G^MSj?#aoUi7OE;Ckw+=S@TU-=hQ z-%t;W307D4_m@f7xn?aLp2Kn`?}2=(q8MvPW;U{lQx9KiE76xLh!@{xeB&|5TC!FX z#F$%gTHU(UKtC#XiA9k@%;tp#c3Rh)^hS?=PY^#Q7Uh|xig-}2v=NyNioW*uj4ca! zHK=f!EedEF0-=5SD&2;sQ!50YUn*dMC(=uwij6zVu>XlcW0YF2H}TJTNFSkW$H@rg zzF5;GtJofjh`=t6cYzFzpo^O)?>fvLL^2uVQ*x+S%0Yl46wJ)(R;~qddx@sP-tx4Clx=Gb=Q^B0x|4kuyBV0l$ zhTF;#s;m;Atoz0pW1>eJ3CgO`%3`n|rid?d0Jm7HJqMuc%2*(Svbhd)=z%IP#SQaw zHVR}pLVt2kk+1H|`_AFWj!)+2%N#i()hNPl_}MZ=L9x7dj*pj7JyuHU^pLxi=7rB& z?6OJQS2kuMCxqd1?Ogf$1(Rh0e|2Zr<$ov8SP^5*>3AZO`C#|ShXvy&4jgcT)WqmA zS)FoB%<+W~@6WOAP?6U$m(kY>I(dp&raB2|im($>=EF*k72E@c9*n^ux~&S(rMS~A zPSfisYV)CZ>VdsU<>A!AaKZRe!rVweFEy$@=Z%UGzrjTPg~I&3^+x>{leI6n(_jO& zM|GtN7v;r=R`h6hvP(YO*H!kRe=jvktc`3PI8|eiSjH~dFJG1Ey+F1`VzNvkS?Z%4 z-l7=ALb5Pn-XyjWN3W8*{lnr{TjBbWz54e-0(#vh}a_x~B@yJ71V}P0E z_#?T&m=HEDk_~)e|I-x4M#qOtwCg9Gcc=*TVe>70pj*cu_JqpM)*rKx!%*$Rcp)?e z!5S<0Y=h{d1T6lhof2c~Hp~!eEK67a%&Mi(a@qJFz1piZ%@UuemmpcWJbj#K7HB4J z??bL8xg_Q1&Q3oz*=o$38MUXb@U#?0^lI0BC+u~m1T}enN2Lid?Ebt&<4 z3R;Q9bhfo(%0uj}3WXaB;Y3uDzy7T6)CyrH#z{&@FidMW_14baw*5}UPha0pO{QB<2?5M6%m%9RCO{Qw^HZ^)|lKL%$Moz9X{O;H(KZDIh?_^l?@{oQCRLt?Dj#$>=26w^V%AIb#;C znIm`hReSa@t<057@p;ygBWjf@s26x}Q*8AELWa>y8P?)MRp+@!pT+Ot&{{Slyxo(8(r}?4j-s zj%2MT);OEl1$uYV4K{UkdS>2CGlc5dIS4x_%^wwpfXt~kk(W5!xgQ1L@<{E#<8P0` z1s(1(6nSFwSAtM%a|NT%^5>1$T!5~n6qnQFq3^5cE5cRdlwIE<{U8@_BOsLVS-#X&DNAk(GlXHCnF#oRZJ;cscWy zQ&P=fFlbfx-$zw@c4}-+Y;)ke_$p0)1Zs z<;Cvj8zZ(q%K`4*s<)X&9c4^8YVdtQm&YuL)R7L^ER62*CiBSj@tEOJbfZhSul zVa_L-*cCDkrUX1o_QBxBq-d)I!1+U7vY$EDmb5>ggT*F31iB0Pb-#r|2Dh;tu04%! zi|wT1h#cV78bCEq6UtN^0glya``#!OJnje^{cgY`<`P$JVUN|fOn*N~PZ04Kg0P?6 zx4{`*eP6l6LqHJh2p}-D(C+zkbT0;NrkiV2$;v+bejUCj-U!-oYj>flldJp1b;LH* z`d9y~A57S(*@t69-0Ug0a=4--+x}_f143$RKMv6ayc_o`yKJ_1m64~#P(+plj|e|( zy0+G)jx@;=@>h@ZuzC@DG^UOG{$%!7dKfh>%Z|&_#;n&2j&|$9FSs8bA=Yf=HX(3` ztRzgXsWxdCjU3;%y-RaL?y!#C1gCY&b$B$(Ii)__{+0Gb3%hB{)O&E%=UAzjvn{h# zxfC+9fgY@c4w`4~A3FI9O}X-#aF$bOgwkxP49-tZlFNIz9%R{tBpcrp)ejLm$3T%a^%0q_Oz` zMhHE{yeG#9PW$*0>f<>c|0Y*|kf))*EBx%jV`y07mn~3@Tmi zr31b9KNo z-pB@O!XWMb^8`QB`!)uW$PAlKmji?_g*R?>E(B+z4>3YqF?wOl!U*dJK<1w^w;wOz zAZ^Ukq#CxV|Bs7emIL1Y+z8wbMFm4C3CH@P(lWo>-HvF zR4ze;VZaQ%c2^iKBlB|5`ww{Lm8;`M)iKNUPyK>cEAM9{Wx!vK!H{j`O6fLpymx@} zuP`Cg+F>CV3DR+O`g=~#Q!X!w8Fx|@=^;@K?t~@QFU(i_rxif!pj?! zE>KW=^b2WJ%+Tq~t^s{JHUab86>{keom~pK77+2#%$~P7##WcAX_-CxUNnxZ!)VRq zcPJIm3o;CRK|fCYxD~wt-87#RauLfMr z!gllH{kga4r%Lmem({vivKhY!l`)@PgE}u`x3jh%yq0a-HhCi>BWhLn#2&j3*^XCG zps&|{?oki4rw$)R@=}QMv7J2A7F6@AWt9@wRy{LO&E-5CXdKw=s^T4#Wg$VtvmzMO zk0e=K@YLFN3;0>=2D}&^!xYq}`b`tkgkR15J0u?-Y&d~NEj;5Br;cQRWP7AV4f#B- zC@ax_)M}P_{DpKg&%bX{gzonYX4c$ZW}1+kpBg)VU{?L>)1loMMHuTao9|EFPwQL< zYkCsk2sh9H3DKA7>7ArZ+_p>9`jwTL@JuvRfZ!UJDq-3rdhwWTKVmoseC0d-Jf4LR z+!xxTndiB_P z3ziaQpM)Fv$sxv-$16O{nZ-=StNwLdr~4Q{3+H}R!`zboKstv3)lxBrnV&)TIksJocz9g+(%*i(K*-lcp18I0iLeXBP zKHtp4%{2!>I_!XFHjo?*MlnCs#-; z2q1i+dQ$x+BP#J$MfPqh6!Cl&fz{M2l~%`3ij9>J@Jb!X#{DV- zSFVM>trsyb#JsL=+%>K)-RyKQ(l<)&k7#hIsUP7kBmIJASIWh0HapCDwJ7!q^6jWk zgP(i=T@(!=%fO&%L!2Ln?9|tDn`685s&b`$LzI09Wd%EeSXGFB95|ben=YF-CG+|K zJ5<-$<-XWq8?IJ~Sv)#Xs z9fSH5a}kfa_L$LlyF#aV#^jGj)Z?C`>0!zvckHL+&C%(t-oU*-(d~hpitI^|PzsD> zM>}y1c8)@v-}V=oA!=qXhOVyBSm#$xGxW6ZH#|A%)7C#RaXxYk?^xuhV5eWgmpJvU zc1M4r?8D}BzcK<%b4xCtq-=Dw#`Ae~t2@FH`}6h2p1&S{%)h(7G|OSSi#WPmak7~e zu2<$Us*WcZPLhU{!64(3siFlgnkkF%6M=1}neQck6NQr)l=WYw1;zVHx%!hwfL^d6 zGb>7UH{JM>HC6f7@-O}5HXF9<_<5@CC?FBkBp+ZO{&XucLo%LMQK-`MXbIl&lK#(5 e!^b$Ww`jBJ>4JCuhIf3vd+N$sO67{y!T$qRcm>P= literal 0 HcmV?d00001 diff --git a/Docs/beta/install/index.rst b/Docs/beta/install/index.rst index a23bb147a59..0fe3bbc8fa3 100644 --- a/Docs/beta/install/index.rst +++ b/Docs/beta/install/index.rst @@ -1,5 +1,5 @@ .. _install-index: -######### +############ Installation -######### \ No newline at end of file +############ \ No newline at end of file diff --git a/Docs/beta/rn/index.rst b/Docs/beta/rn/index.rst index 899618b8012..65a964c3a56 100644 --- a/Docs/beta/rn/index.rst +++ b/Docs/beta/rn/index.rst @@ -1,5 +1,5 @@ .. _rn-index: -######### +############# Release Notes -######### \ No newline at end of file +############# \ No newline at end of file diff --git a/Docs/beta/snippets/torch/apply_adaround.py b/Docs/beta/snippets/torch/apply_adaround.py index 9b09d8ced1f..c09013436c5 100644 --- a/Docs/beta/snippets/torch/apply_adaround.py +++ b/Docs/beta/snippets/torch/apply_adaround.py @@ -1,40 +1,3 @@ -# -*- mode: python -*- -# ============================================================================= -# @@-COPYRIGHT-START-@@ -# -# Copyright (c) 2024, Qualcomm Innovation Center, Inc. All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# 1. Redistributions of source code must retain the above copyright notice, -# this list of conditions and the following disclaimer. -# -# 2. Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# 3. Neither the name of the copyright holder nor the names of its contributors -# may be used to endorse or promote products derived from this software -# without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -# POSSIBILITY OF SUCH DAMAGE. -# -# SPDX-License-Identifier: BSD-3-Clause -# -# @@-COPYRIGHT-END-@@ -# ============================================================================= -# pylint: disable=all # Apply AdaRound from aimet_common.defs import QuantScheme from aimet_torch.v1.quantsim import QuantizationSimModel diff --git a/Docs/beta/snippets/torch/create_quantizationsimmodel.py b/Docs/beta/snippets/torch/create_quantizationsimmodel.py index 108b02af221..a400476649f 100644 --- a/Docs/beta/snippets/torch/create_quantizationsimmodel.py +++ b/Docs/beta/snippets/torch/create_quantizationsimmodel.py @@ -1,40 +1,3 @@ -# -*- mode: python -*- -# ============================================================================= -# @@-COPYRIGHT-START-@@ -# -# Copyright (c) 2024, Qualcomm Innovation Center, Inc. All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# 1. Redistributions of source code must retain the above copyright notice, -# this list of conditions and the following disclaimer. -# -# 2. Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# 3. Neither the name of the copyright holder nor the names of its contributors -# may be used to endorse or promote products derived from this software -# without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -# POSSIBILITY OF SUCH DAMAGE. -# -# SPDX-License-Identifier: BSD-3-Clause -# -# @@-COPYRIGHT-END-@@ -# ============================================================================= -# pylint: disable=all from aimet_common.defs import QuantScheme from aimet_torch.v1.quantsim import QuantizationSimModel from aimet_torch.v1.adaround.adaround_weight import Adaround, AdaroundParameters @@ -47,4 +10,4 @@ # is a model to which AIMET AdaRound has been applied # is a selected AIMET quantization scheme # and are the bit widths of the quantized model -# is any data that conforms to the model input shape. It is not used. +# is any data that conforms to the model input shape. It is not used. \ No newline at end of file diff --git a/Docs/beta/snippets/torch/evaluate.py b/Docs/beta/snippets/torch/evaluate.py index 1d7412fb875..55d8923aa28 100644 --- a/Docs/beta/snippets/torch/evaluate.py +++ b/Docs/beta/snippets/torch/evaluate.py @@ -1,40 +1,3 @@ -# -*- mode: python -*- -# ============================================================================= -# @@-COPYRIGHT-START-@@ -# -# Copyright (c) 2024, Qualcomm Innovation Center, Inc. All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# 1. Redistributions of source code must retain the above copyright notice, -# this list of conditions and the following disclaimer. -# -# 2. Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# 3. Neither the name of the copyright holder nor the names of its contributors -# may be used to endorse or promote products derived from this software -# without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -# POSSIBILITY OF SUCH DAMAGE. -# -# SPDX-License-Identifier: BSD-3-Clause -# -# @@-COPYRIGHT-END-@@ -# ============================================================================= -# pylint: disable=all -# Determine simulated accuracy -accuracy = ImageNetDataPipeline.evaluate(sim.model, use_cuda) -print(accuracy) + # Determine simulated accuracy + accuracy = ImageNetDataPipeline.evaluate(sim.model, use_cuda) + print(accuracy) \ No newline at end of file diff --git a/Docs/beta/snippets/torch/export.py b/Docs/beta/snippets/torch/export.py index f901de34b52..e36a1a3a3cb 100644 --- a/Docs/beta/snippets/torch/export.py +++ b/Docs/beta/snippets/torch/export.py @@ -1,41 +1,4 @@ -# -*- mode: python -*- -# ============================================================================= -# @@-COPYRIGHT-START-@@ -# -# Copyright (c) 2024, Qualcomm Innovation Center, Inc. All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# 1. Redistributions of source code must retain the above copyright notice, -# this list of conditions and the following disclaimer. -# -# 2. Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# 3. Neither the name of the copyright holder nor the names of its contributors -# may be used to endorse or promote products derived from this software -# without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -# POSSIBILITY OF SUCH DAMAGE. -# -# SPDX-License-Identifier: BSD-3-Clause -# -# @@-COPYRIGHT-END-@@ -# ============================================================================= -# pylint: disable=all -# Export the model -# Export the model which saves pytorch model without any simulation nodes and saves encodings file for both -# activations and parameters in JSON format -model.export(path='./', filename_prefix='', dummy_input=dummy_input.cpu()) + # Export the model + # Export the model which saves pytorch model without any simulation nodes and saves encodings file for both + # activations and parameters in JSON format + model.export(path='./', filename_prefix='', dummy_input=dummy_input.cpu()) diff --git a/Docs/beta/snippets/torch/pass_calibration_data.py b/Docs/beta/snippets/torch/pass_calibration_data.py index 3897b79df37..cb998a2c7f6 100644 --- a/Docs/beta/snippets/torch/pass_calibration_data.py +++ b/Docs/beta/snippets/torch/pass_calibration_data.py @@ -1,40 +1,3 @@ -# -*- mode: python -*- -# ============================================================================= -# @@-COPYRIGHT-START-@@ -# -# Copyright (c) 2024, Qualcomm Innovation Center, Inc. All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# 1. Redistributions of source code must retain the above copyright notice, -# this list of conditions and the following disclaimer. -# -# 2. Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# 3. Neither the name of the copyright holder nor the names of its contributors -# may be used to endorse or promote products derived from this software -# without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -# POSSIBILITY OF SUCH DAMAGE. -# -# SPDX-License-Identifier: BSD-3-Clause -# -# @@-COPYRIGHT-END-@@ -# ============================================================================= -# pylint: disable=all # PyTorch imports import torch diff --git a/Docs/beta/snippets/torch/prepare_model.py b/Docs/beta/snippets/torch/prepare_model.py index 9f00f7b85b0..6c0d6621622 100644 --- a/Docs/beta/snippets/torch/prepare_model.py +++ b/Docs/beta/snippets/torch/prepare_model.py @@ -1,42 +1,5 @@ -# -*- mode: python -*- -# ============================================================================= -# @@-COPYRIGHT-START-@@ -# -# Copyright (c) 2024, Qualcomm Innovation Center, Inc. All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# 1. Redistributions of source code must retain the above copyright notice, -# this list of conditions and the following disclaimer. -# -# 2. Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# 3. Neither the name of the copyright holder nor the names of its contributors -# may be used to endorse or promote products derived from this software -# without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -# POSSIBILITY OF SUCH DAMAGE. -# -# SPDX-License-Identifier: BSD-3-Clause -# -# @@-COPYRIGHT-END-@@ -# ============================================================================= -# pylint: disable=all # Prepare the model from aimet_torch.model_preparer import prepare_model prepared_model = prepare_model() -# where is a torch.nn.Module +# where is a torch.nn.Module \ No newline at end of file From d32fa276f606edaf281663f24ee1b5d05b943418 Mon Sep 17 00:00:00 2001 From: Dave Welsch Date: Fri, 15 Nov 2024 10:05:42 -0800 Subject: [PATCH 2/4] Add copyright headers to snippet .py files to fix repolinter complaint. Signed-off-by: Dave Welsch --- Docs/beta/featureguide/adaround.rst | 14 +++++-- Docs/beta/snippets/torch/apply_adaround.py | 38 +++++++++++++++++++ .../torch/create_quantizationsimmodel.py | 38 +++++++++++++++++++ Docs/beta/snippets/torch/evaluate.py | 38 +++++++++++++++++++ Docs/beta/snippets/torch/export.py | 38 +++++++++++++++++++ .../snippets/torch/pass_calibration_data.py | 38 +++++++++++++++++++ Docs/beta/snippets/torch/prepare_model.py | 38 +++++++++++++++++++ 7 files changed, 238 insertions(+), 4 deletions(-) diff --git a/Docs/beta/featureguide/adaround.rst b/Docs/beta/featureguide/adaround.rst index 6fb3ea38c91..effa671f6d7 100644 --- a/Docs/beta/featureguide/adaround.rst +++ b/Docs/beta/featureguide/adaround.rst @@ -82,6 +82,7 @@ Prepare the model for quantization. .. literalinclude:: ../snippets/torch/prepare_model.py :language: python + :start-after: # pylint: disable=missing-docstring For details of the model preparer API see the :ref:`Model Preparer API `. @@ -89,13 +90,11 @@ Prepare the model for quantization. .. tab-item:: TensorFlow :sync: tf - Tensorflow has no preparation requirements. .. tab-item:: ONNX :sync: onnx - ONNX has no preparation requirements. @@ -112,18 +111,21 @@ Apply AdaRound to the model. .. literalinclude:: ../snippets/torch/apply_adaround.py :language: python + :start-after: # pylint: disable=missing-docstring .. tab-item:: TensorFlow :sync: tf .. literalinclude:: ../snippets/tensorflow/apply_adaround.py :language: python + :start-after: # pylint: disable=missing-docstring .. tab-item:: ONNX :sync: onnx .. literalinclude:: ../snippets/onnx/apply_adaround.py :language: python + :start-after: # pylint: disable=missing-docstring Step 3 ~~~~~~ @@ -136,21 +138,23 @@ Evaluate the model. .. tab-item:: PyTorch :sync: torch - .. literalinclude:: ../snippets/torch/evaluate.py :language: python + :start-after: # pylint: disable=missing-docstring .. tab-item:: TensorFlow :sync: tf .. literalinclude:: ../snippets/tensorflow/evaluate.py :language: python + :start-after: # pylint: disable=missing-docstring .. tab-item:: ONNX :sync: onnx .. literalinclude:: ../snippets/onnx/evaluate.py :language: python + :start-after: # pylint: disable=missing-docstring Results @@ -170,21 +174,23 @@ If AdaRound resulted in satisfactory accuracy, export the model. .. tab-item:: PyTorch :sync: torch - .. literalinclude:: ../snippets/torch/export.py :language: python + :start-after: # pylint: disable=missing-docstring .. tab-item:: TensorFlow :sync: tf .. literalinclude:: ../snippets/tensorflow/export.py :language: python + :start-after: # pylint: disable=missing-docstring .. tab-item:: ONNX :sync: onnx .. literalinclude:: ../snippets/onnx/export.py :language: python + :start-after: # pylint: disable=missing-docstring If the model is still not accurate enough, the next step is typically to try :ref:`quantization-aware training `. diff --git a/Docs/beta/snippets/torch/apply_adaround.py b/Docs/beta/snippets/torch/apply_adaround.py index c09013436c5..029c661ff80 100644 --- a/Docs/beta/snippets/torch/apply_adaround.py +++ b/Docs/beta/snippets/torch/apply_adaround.py @@ -1,3 +1,41 @@ +# -*- mode: python -*- +# ============================================================================= +# @@-COPYRIGHT-START-@@ +# +# Copyright (c) 2023, Qualcomm Innovation Center, Inc. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# 3. Neither the name of the copyright holder nor the names of its contributors +# may be used to endorse or promote products derived from this software +# without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. +# +# SPDX-License-Identifier: BSD-3-Clause +# +# @@-COPYRIGHT-END-@@ +# ============================================================================= +# pylint: disable=missing-docstring + # Apply AdaRound from aimet_common.defs import QuantScheme from aimet_torch.v1.quantsim import QuantizationSimModel diff --git a/Docs/beta/snippets/torch/create_quantizationsimmodel.py b/Docs/beta/snippets/torch/create_quantizationsimmodel.py index a400476649f..5c5a5774102 100644 --- a/Docs/beta/snippets/torch/create_quantizationsimmodel.py +++ b/Docs/beta/snippets/torch/create_quantizationsimmodel.py @@ -1,3 +1,41 @@ +# -*- mode: python -*- +# ============================================================================= +# @@-COPYRIGHT-START-@@ +# +# Copyright (c) 2023, Qualcomm Innovation Center, Inc. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# 3. Neither the name of the copyright holder nor the names of its contributors +# may be used to endorse or promote products derived from this software +# without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. +# +# SPDX-License-Identifier: BSD-3-Clause +# +# @@-COPYRIGHT-END-@@ +# ============================================================================= +# pylint: disable=missing-docstring + from aimet_common.defs import QuantScheme from aimet_torch.v1.quantsim import QuantizationSimModel from aimet_torch.v1.adaround.adaround_weight import Adaround, AdaroundParameters diff --git a/Docs/beta/snippets/torch/evaluate.py b/Docs/beta/snippets/torch/evaluate.py index 55d8923aa28..bc1aa3e43c5 100644 --- a/Docs/beta/snippets/torch/evaluate.py +++ b/Docs/beta/snippets/torch/evaluate.py @@ -1,3 +1,41 @@ +# -*- mode: python -*- +# ============================================================================= +# @@-COPYRIGHT-START-@@ +# +# Copyright (c) 2023, Qualcomm Innovation Center, Inc. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# 3. Neither the name of the copyright holder nor the names of its contributors +# may be used to endorse or promote products derived from this software +# without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. +# +# SPDX-License-Identifier: BSD-3-Clause +# +# @@-COPYRIGHT-END-@@ +# ============================================================================= +# pylint: disable=missing-docstring + # Determine simulated accuracy accuracy = ImageNetDataPipeline.evaluate(sim.model, use_cuda) print(accuracy) \ No newline at end of file diff --git a/Docs/beta/snippets/torch/export.py b/Docs/beta/snippets/torch/export.py index e36a1a3a3cb..c87b67adea1 100644 --- a/Docs/beta/snippets/torch/export.py +++ b/Docs/beta/snippets/torch/export.py @@ -1,3 +1,41 @@ +# -*- mode: python -*- +# ============================================================================= +# @@-COPYRIGHT-START-@@ +# +# Copyright (c) 2023, Qualcomm Innovation Center, Inc. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# 3. Neither the name of the copyright holder nor the names of its contributors +# may be used to endorse or promote products derived from this software +# without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. +# +# SPDX-License-Identifier: BSD-3-Clause +# +# @@-COPYRIGHT-END-@@ +# ============================================================================= +# pylint: disable=missing-docstring + # Export the model # Export the model which saves pytorch model without any simulation nodes and saves encodings file for both # activations and parameters in JSON format diff --git a/Docs/beta/snippets/torch/pass_calibration_data.py b/Docs/beta/snippets/torch/pass_calibration_data.py index cb998a2c7f6..e458c43a68b 100644 --- a/Docs/beta/snippets/torch/pass_calibration_data.py +++ b/Docs/beta/snippets/torch/pass_calibration_data.py @@ -1,3 +1,41 @@ +# -*- mode: python -*- +# ============================================================================= +# @@-COPYRIGHT-START-@@ +# +# Copyright (c) 2023, Qualcomm Innovation Center, Inc. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# 3. Neither the name of the copyright holder nor the names of its contributors +# may be used to endorse or promote products derived from this software +# without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. +# +# SPDX-License-Identifier: BSD-3-Clause +# +# @@-COPYRIGHT-END-@@ +# ============================================================================= +# pylint: disable=missing-docstring + # PyTorch imports import torch diff --git a/Docs/beta/snippets/torch/prepare_model.py b/Docs/beta/snippets/torch/prepare_model.py index 6c0d6621622..7b4e70d6cb3 100644 --- a/Docs/beta/snippets/torch/prepare_model.py +++ b/Docs/beta/snippets/torch/prepare_model.py @@ -1,3 +1,41 @@ +# -*- mode: python -*- +# ============================================================================= +# @@-COPYRIGHT-START-@@ +# +# Copyright (c) 2023, Qualcomm Innovation Center, Inc. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# 3. Neither the name of the copyright holder nor the names of its contributors +# may be used to endorse or promote products derived from this software +# without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. +# +# SPDX-License-Identifier: BSD-3-Clause +# +# @@-COPYRIGHT-END-@@ +# ============================================================================= +# pylint: disable=missing-docstring + # Prepare the model from aimet_torch.model_preparer import prepare_model prepared_model = prepare_model() From bfe40b25cc80a47d6469f1627d4849ec099c8929 Mon Sep 17 00:00:00 2001 From: Dave Welsch Date: Fri, 15 Nov 2024 15:46:36 -0800 Subject: [PATCH 3/4] Removed unnecessary templates, cleaned up CSS file. Signed-off-by: Dave Welsch --- Docs/beta/_static/aimet-furo.css | 20 ------------- Docs/beta/_templates/ethical-ads.html | 10 ------- Docs/beta/_templates/rtd-versions.html | 34 ---------------------- Docs/beta/_templates/variant-selector.html | 33 --------------------- 4 files changed, 97 deletions(-) delete mode 100644 Docs/beta/_templates/ethical-ads.html delete mode 100644 Docs/beta/_templates/rtd-versions.html delete mode 100644 Docs/beta/_templates/variant-selector.html diff --git a/Docs/beta/_static/aimet-furo.css b/Docs/beta/_static/aimet-furo.css index be23ee1a89b..8e434439e3c 100644 --- a/Docs/beta/_static/aimet-furo.css +++ b/Docs/beta/_static/aimet-furo.css @@ -10,23 +10,3 @@ [for^="toctree-checkbox-"], [id^="toctree-checkbox-"] { visibility: hidden; } - -/* -
  • -AIMET Feature Guide - - - -*/ \ No newline at end of file diff --git a/Docs/beta/_templates/ethical-ads.html b/Docs/beta/_templates/ethical-ads.html deleted file mode 100644 index 0c682a4e823..00000000000 --- a/Docs/beta/_templates/ethical-ads.html +++ /dev/null @@ -1,10 +0,0 @@ -{# Add the ethical ads div, when generating documentation on Read the Docs #} -{% if READTHEDOCS %} -
    -{% endif %} diff --git a/Docs/beta/_templates/rtd-versions.html b/Docs/beta/_templates/rtd-versions.html deleted file mode 100644 index 4b75680ecce..00000000000 --- a/Docs/beta/_templates/rtd-versions.html +++ /dev/null @@ -1,34 +0,0 @@ -{# Add rst-badge after rst-versions for small badge style. #} -{% if READTHEDOCS %} -
    - - Read the Docs - v: {{ current_version }} - - -
    -
    -
    {{ _('Versions') }}
    - {% for slug, url in versions %} -
    {{ slug }}
    - {% endfor %} -
    -
    -
    {{ _('Downloads') }}
    - {% for type, url in downloads %} -
    {{ type }}
    - {% endfor %} -
    -
    - {# Translators: The phrase "Read the Docs" is not translated #} -
    {{ _('On Read the Docs') }}
    -
    - {{ _('Project Home') }} -
    -
    - {{ _('Builds') }} -
    -
    -
    -
    -{% endif %} diff --git a/Docs/beta/_templates/variant-selector.html b/Docs/beta/_templates/variant-selector.html deleted file mode 100644 index aefb22ec067..00000000000 --- a/Docs/beta/_templates/variant-selector.html +++ /dev/null @@ -1,33 +0,0 @@ -{# Add variant selector for Read the Docs embedding #} -{% if READTHEDOCS %} -
    - -   - v: {{ current_version }} - -
    -
    -
    {{ _('Versions') }}
    - {% for slug, url in versions %} -
    {{ slug }}
    - {% endfor %} -
    -
    -
    {{ _('Downloads') }}
    - {% for type, url in downloads %} -
    {{ type }}
    - {% endfor %} -
    -
    - {# Translators: The phrase "Read the Docs" is not translated #} -
    {{ _('On Read the Docs') }}
    -
    - {{ _('Project Home') }} -
    -
    - {{ _('Builds') }} -
    -
    -
    -
    -{% endif %} From f0f2a1cbe4eecbd00200cb79c366c037845d15e7 Mon Sep 17 00:00:00 2001 From: Dave Welsch Date: Sat, 16 Nov 2024 11:27:35 -0800 Subject: [PATCH 4/4] Fix TOC to display 2 levels, no collapse. Signed-off-by: Dave Welsch --- Docs/beta/_templates/navigation.html | 3 --- Docs/beta/_templates/{ => sidebar}/brand.html | 0 Docs/beta/_templates/sidebar/navigation.html | 3 +++ Docs/beta/_templates/{ => sidebar}/scroll-end.html | 0 Docs/beta/_templates/{ => sidebar}/scroll-start.html | 0 Docs/beta/_templates/{ => sidebar}/search.html | 0 Docs/beta/conf.py | 5 +++++ Docs/beta/snippets/torch/evaluate.py | 6 +++--- Docs/beta/snippets/torch/export.py | 8 ++++---- 9 files changed, 15 insertions(+), 10 deletions(-) delete mode 100644 Docs/beta/_templates/navigation.html rename Docs/beta/_templates/{ => sidebar}/brand.html (100%) create mode 100644 Docs/beta/_templates/sidebar/navigation.html rename Docs/beta/_templates/{ => sidebar}/scroll-end.html (100%) rename Docs/beta/_templates/{ => sidebar}/scroll-start.html (100%) rename Docs/beta/_templates/{ => sidebar}/search.html (100%) diff --git a/Docs/beta/_templates/navigation.html b/Docs/beta/_templates/navigation.html deleted file mode 100644 index eda5176075d..00000000000 --- a/Docs/beta/_templates/navigation.html +++ /dev/null @@ -1,3 +0,0 @@ -
    - {{ furo_navigation_tree }} -
    diff --git a/Docs/beta/_templates/brand.html b/Docs/beta/_templates/sidebar/brand.html similarity index 100% rename from Docs/beta/_templates/brand.html rename to Docs/beta/_templates/sidebar/brand.html diff --git a/Docs/beta/_templates/sidebar/navigation.html b/Docs/beta/_templates/sidebar/navigation.html new file mode 100644 index 00000000000..3f4af219dc6 --- /dev/null +++ b/Docs/beta/_templates/sidebar/navigation.html @@ -0,0 +1,3 @@ +
    + {{ toctree(includehidden=True, collapse=False, titles_only=True, maxdepth=2) }} +
    diff --git a/Docs/beta/_templates/scroll-end.html b/Docs/beta/_templates/sidebar/scroll-end.html similarity index 100% rename from Docs/beta/_templates/scroll-end.html rename to Docs/beta/_templates/sidebar/scroll-end.html diff --git a/Docs/beta/_templates/scroll-start.html b/Docs/beta/_templates/sidebar/scroll-start.html similarity index 100% rename from Docs/beta/_templates/scroll-start.html rename to Docs/beta/_templates/sidebar/scroll-start.html diff --git a/Docs/beta/_templates/search.html b/Docs/beta/_templates/sidebar/search.html similarity index 100% rename from Docs/beta/_templates/search.html rename to Docs/beta/_templates/sidebar/search.html diff --git a/Docs/beta/conf.py b/Docs/beta/conf.py index b42a6126046..e9ad8dfb3ea 100644 --- a/Docs/beta/conf.py +++ b/Docs/beta/conf.py @@ -100,6 +100,8 @@ def setup(app): # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] +# The TOC options are hard-coded in the _templates/navigator.html file. +# For some reason this theme doesn't seem to be setting user-defined config variables. # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: @@ -162,6 +164,7 @@ def setup(app): ], } + # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". @@ -186,6 +189,8 @@ def setup(app): "sidebar/scroll-end.html", ] } +# Custom TOC settings + # -- Options for HTMLHelp output --------------------------------------------- diff --git a/Docs/beta/snippets/torch/evaluate.py b/Docs/beta/snippets/torch/evaluate.py index bc1aa3e43c5..bc7a4bfd40e 100644 --- a/Docs/beta/snippets/torch/evaluate.py +++ b/Docs/beta/snippets/torch/evaluate.py @@ -36,6 +36,6 @@ # ============================================================================= # pylint: disable=missing-docstring - # Determine simulated accuracy - accuracy = ImageNetDataPipeline.evaluate(sim.model, use_cuda) - print(accuracy) \ No newline at end of file +# Determine simulated accuracy +accuracy = ImageNetDataPipeline.evaluate(sim.model, use_cuda) +print(accuracy) \ No newline at end of file diff --git a/Docs/beta/snippets/torch/export.py b/Docs/beta/snippets/torch/export.py index c87b67adea1..f3a9acb587d 100644 --- a/Docs/beta/snippets/torch/export.py +++ b/Docs/beta/snippets/torch/export.py @@ -36,7 +36,7 @@ # ============================================================================= # pylint: disable=missing-docstring - # Export the model - # Export the model which saves pytorch model without any simulation nodes and saves encodings file for both - # activations and parameters in JSON format - model.export(path='./', filename_prefix='', dummy_input=dummy_input.cpu()) +# Export the model +# Export the model which saves pytorch model without any simulation nodes and saves encodings file for both +# activations and parameters in JSON format +model.export(path='./', filename_prefix='', dummy_input=dummy_input.cpu())