Skip to content

Commit

Permalink
update 2.5.0+cpu docs (#3414)
Browse files Browse the repository at this point in the history
  • Loading branch information
jingxu10 authored Dec 18, 2024
1 parent 6ec2876 commit 508d326
Show file tree
Hide file tree
Showing 42 changed files with 203 additions and 47 deletions.
4 changes: 2 additions & 2 deletions cpu/2.5.0+cpu/_sources/tutorials/examples.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1327,6 +1327,6 @@ $ ldd example-app

## Intel® AI Reference Models

Use cases that have already been optimized by Intel engineers are available at [Intel® AI Reference Models](https://github.com/IntelAI/models/tree/pytorch-r2.3-models) (former Model Zoo).
A number of PyTorch use cases for benchmarking are also available in the [benchmarks](https://github.com/IntelAI/models/tree/pytorch-r2.3-models/benchmarks#pytorch-use-cases).
Use cases that have already been optimized by Intel engineers are available at [Intel® AI Reference Models](https://github.com/intel/ai-reference-models/tree/pytorch-r2.5-models) (former Model Zoo).
The lists of PyTorch use cases with links to sample codes are available in the [use case tables](https://github.com/intel/ai-reference-models/tree/pytorch-r2.5-models?tab=readme-ov-file#use-cases).
You can get performance benefits out-of-the-box by simply running scripts in the Intel® AI Reference Models.
2 changes: 1 addition & 1 deletion cpu/2.5.0+cpu/_sources/tutorials/llm.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ These LLM-specific optimizations can be automatically applied with a single fron
llm/llm_optimize

`ipex.llm` Optimized Model List for Inference
-------------------------------
---------------------------------------------

Verified for single instance mode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
10 changes: 7 additions & 3 deletions cpu/2.5.0+cpu/_static/js/versions.js
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
const themeFlyoutDisplay = "hidden";
const themeVersionSelector = "True";
const themeLanguageSelector = "True";
const themeVersionSelector = true;
const themeLanguageSelector = true;

if (themeFlyoutDisplay === "attached") {
function renderLanguages(config) {
if (!config.projects.translations.length) {
return "";
}

// Insert the current language to the options on the selector
let languages = config.projects.translations.concat(config.projects.current);
languages = languages.sort((a, b) => a.language.name.localeCompare(b.language.name));

const languagesHTML = `
<dl>
<dt>Languages</dt>
${config.projects.translations
${languages
.map(
(translation) => `
<dd ${translation.slug == config.projects.current.slug ? 'class="rtd-current-item"' : ""}>
Expand Down
6 changes: 5 additions & 1 deletion cpu/2.5.0+cpu/design_doc/cpu/isa_dyndisp.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@
<a href="../../index.html" class="icon icon-home">
Intel&#174 Extension for PyTorch*
</a>
<div class="version">
<a href="../../../../">2.5.0+cpu ▼</a>
<p>Click link above to switch version</p>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Expand Down Expand Up @@ -125,7 +129,7 @@ <h1>Intel® Extension for PyTorch* CPU ISA Dynamic Dispatch Design Doc<a class="
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
<jinja2.runtime.BlockReference object at 0x7fceda8a7a00>
<jinja2.runtime.BlockReference object at 0x700e2d2b95a0>
<p></p><div><a href='https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html' data-cookie-notice='true'>Cookies</a> <a href='https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html'>| Privacy</a> <a href="/#" data-wap_ref="dns" id="wap_dns"><small>| Your Privacy Choices</small></a> <a href=https://www.intel.com/content/www/us/en/privacy/privacy-residents-certain-states.html data-wap_ref="nac" id="wap_nac"><small>| Notice at Collection</small></a> </div> <p></p> <div>&copy; Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document, with the sole exception that code included in this document is licensed subject to the Zero-Clause BSD open source license (OBSD), <a href='http://opensource.org/licenses/0BSD'>http://opensource.org/licenses/0BSD</a>. </div>


Expand Down
6 changes: 5 additions & 1 deletion cpu/2.5.0+cpu/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@
<a href="index.html" class="icon icon-home">
Intel&#174 Extension for PyTorch*
</a>
<div class="version">
<a href="../../">2.5.0+cpu ▼</a>
<p>Click link above to switch version</p>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Expand Down Expand Up @@ -377,7 +381,7 @@ <h2 id="V">V</h2>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
<jinja2.runtime.BlockReference object at 0x7fceda84eec0>
<jinja2.runtime.BlockReference object at 0x700e2c926e60>
<p></p><div><a href='https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html' data-cookie-notice='true'>Cookies</a> <a href='https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html'>| Privacy</a> <a href="/#" data-wap_ref="dns" id="wap_dns"><small>| Your Privacy Choices</small></a> <a href=https://www.intel.com/content/www/us/en/privacy/privacy-residents-certain-states.html data-wap_ref="nac" id="wap_nac"><small>| Notice at Collection</small></a> </div> <p></p> <div>&copy; Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document, with the sole exception that code included in this document is licensed subject to the Zero-Clause BSD open source license (OBSD), <a href='http://opensource.org/licenses/0BSD'>http://opensource.org/licenses/0BSD</a>. </div>


Expand Down
6 changes: 5 additions & 1 deletion cpu/2.5.0+cpu/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@
<a href="#" class="icon icon-home">
Intel&#174 Extension for PyTorch*
</a>
<div class="version">
<a href="../../">2.5.0+cpu ▼</a>
<p>Click link above to switch version</p>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Expand Down Expand Up @@ -183,7 +187,7 @@ <h2>Support<a class="headerlink" href="#support" title="Link to this heading">
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
<jinja2.runtime.BlockReference object at 0x7fceda8a7280>
<jinja2.runtime.BlockReference object at 0x700e2d2bb880>
<p></p><div><a href='https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html' data-cookie-notice='true'>Cookies</a> <a href='https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html'>| Privacy</a> <a href="/#" data-wap_ref="dns" id="wap_dns"><small>| Your Privacy Choices</small></a> <a href=https://www.intel.com/content/www/us/en/privacy/privacy-residents-certain-states.html data-wap_ref="nac" id="wap_nac"><small>| Notice at Collection</small></a> </div> <p></p> <div>&copy; Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document, with the sole exception that code included in this document is licensed subject to the Zero-Clause BSD open source license (OBSD), <a href='http://opensource.org/licenses/0BSD'>http://opensource.org/licenses/0BSD</a>. </div>


Expand Down
6 changes: 5 additions & 1 deletion cpu/2.5.0+cpu/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@
<a href="index.html" class="icon icon-home">
Intel&#174 Extension for PyTorch*
</a>
<div class="version">
<a href="../../">2.5.0+cpu ▼</a>
<p>Click link above to switch version</p>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Expand Down Expand Up @@ -165,7 +169,7 @@ <h1>Python Module Index</h1>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
<jinja2.runtime.BlockReference object at 0x7fceda4fa2c0>
<jinja2.runtime.BlockReference object at 0x700e2d3f9a50>
<p></p><div><a href='https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html' data-cookie-notice='true'>Cookies</a> <a href='https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html'>| Privacy</a> <a href="/#" data-wap_ref="dns" id="wap_dns"><small>| Your Privacy Choices</small></a> <a href=https://www.intel.com/content/www/us/en/privacy/privacy-residents-certain-states.html data-wap_ref="nac" id="wap_nac"><small>| Notice at Collection</small></a> </div> <p></p> <div>&copy; Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document, with the sole exception that code included in this document is licensed subject to the Zero-Clause BSD open source license (OBSD), <a href='http://opensource.org/licenses/0BSD'>http://opensource.org/licenses/0BSD</a>. </div>


Expand Down
6 changes: 5 additions & 1 deletion cpu/2.5.0+cpu/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@
<a href="index.html" class="icon icon-home">
Intel&#174 Extension for PyTorch*
</a>
<div class="version">
<a href="../../">2.5.0+cpu ▼</a>
<p>Click link above to switch version</p>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="#" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Expand Down Expand Up @@ -140,7 +144,7 @@
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
<jinja2.runtime.BlockReference object at 0x7fceda995360>
<jinja2.runtime.BlockReference object at 0x700e2ca1ad10>
<p></p><div><a href='https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html' data-cookie-notice='true'>Cookies</a> <a href='https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html'>| Privacy</a> <a href="/#" data-wap_ref="dns" id="wap_dns"><small>| Your Privacy Choices</small></a> <a href=https://www.intel.com/content/www/us/en/privacy/privacy-residents-certain-states.html data-wap_ref="nac" id="wap_nac"><small>| Notice at Collection</small></a> </div> <p></p> <div>&copy; Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document, with the sole exception that code included in this document is licensed subject to the Zero-Clause BSD open source license (OBSD), <a href='http://opensource.org/licenses/0BSD'>http://opensource.org/licenses/0BSD</a>. </div>


Expand Down
2 changes: 1 addition & 1 deletion cpu/2.5.0+cpu/searchindex.js

Large diffs are not rendered by default.

6 changes: 5 additions & 1 deletion cpu/2.5.0+cpu/tutorials/api_doc.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@
<a href="../index.html" class="icon icon-home">
Intel&#174 Extension for PyTorch*
</a>
<div class="version">
<a href="../../../">2.5.0+cpu ▼</a>
<p>Click link above to switch version</p>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Expand Down Expand Up @@ -1751,7 +1755,7 @@ <h2>Graph Optimization<a class="headerlink" href="#graph-optimization" title="Li
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
<jinja2.runtime.BlockReference object at 0x7fcedb68e770>
<jinja2.runtime.BlockReference object at 0x700e2d2b9c90>
<p></p><div><a href='https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html' data-cookie-notice='true'>Cookies</a> <a href='https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html'>| Privacy</a> <a href="/#" data-wap_ref="dns" id="wap_dns"><small>| Your Privacy Choices</small></a> <a href=https://www.intel.com/content/www/us/en/privacy/privacy-residents-certain-states.html data-wap_ref="nac" id="wap_nac"><small>| Notice at Collection</small></a> </div> <p></p> <div>&copy; Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document, with the sole exception that code included in this document is licensed subject to the Zero-Clause BSD open source license (OBSD), <a href='http://opensource.org/licenses/0BSD'>http://opensource.org/licenses/0BSD</a>. </div>


Expand Down
6 changes: 5 additions & 1 deletion cpu/2.5.0+cpu/tutorials/blogs_publications.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@
<a href="../index.html" class="icon icon-home">
Intel&#174 Extension for PyTorch*
</a>
<div class="version">
<a href="../../../">2.5.0+cpu ▼</a>
<p>Click link above to switch version</p>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Expand Down Expand Up @@ -167,7 +171,7 @@ <h1>Blogs &amp; Publications<a class="headerlink" href="#blogs-publications" tit
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
<jinja2.runtime.BlockReference object at 0x7fceda8c47c0>
<jinja2.runtime.BlockReference object at 0x700e2e121cc0>
<p></p><div><a href='https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html' data-cookie-notice='true'>Cookies</a> <a href='https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html'>| Privacy</a> <a href="/#" data-wap_ref="dns" id="wap_dns"><small>| Your Privacy Choices</small></a> <a href=https://www.intel.com/content/www/us/en/privacy/privacy-residents-certain-states.html data-wap_ref="nac" id="wap_nac"><small>| Notice at Collection</small></a> </div> <p></p> <div>&copy; Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document, with the sole exception that code included in this document is licensed subject to the Zero-Clause BSD open source license (OBSD), <a href='http://opensource.org/licenses/0BSD'>http://opensource.org/licenses/0BSD</a>. </div>


Expand Down
6 changes: 5 additions & 1 deletion cpu/2.5.0+cpu/tutorials/cheat_sheet.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@
<a href="../index.html" class="icon icon-home">
Intel&#174 Extension for PyTorch*
</a>
<div class="version">
<a href="../../../">2.5.0+cpu ▼</a>
<p>Click link above to switch version</p>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Expand Down Expand Up @@ -195,7 +199,7 @@ <h1>Cheat Sheet<a class="headerlink" href="#cheat-sheet" title="Link to this hea
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
<jinja2.runtime.BlockReference object at 0x7fceda8c4e80>
<jinja2.runtime.BlockReference object at 0x700e2d2609d0>
<p></p><div><a href='https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html' data-cookie-notice='true'>Cookies</a> <a href='https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html'>| Privacy</a> <a href="/#" data-wap_ref="dns" id="wap_dns"><small>| Your Privacy Choices</small></a> <a href=https://www.intel.com/content/www/us/en/privacy/privacy-residents-certain-states.html data-wap_ref="nac" id="wap_nac"><small>| Notice at Collection</small></a> </div> <p></p> <div>&copy; Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document, with the sole exception that code included in this document is licensed subject to the Zero-Clause BSD open source license (OBSD), <a href='http://opensource.org/licenses/0BSD'>http://opensource.org/licenses/0BSD</a>. </div>


Expand Down
6 changes: 5 additions & 1 deletion cpu/2.5.0+cpu/tutorials/contribution.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@
<a href="../index.html" class="icon icon-home">
Intel&#174 Extension for PyTorch*
</a>
<div class="version">
<a href="../../../">2.5.0+cpu ▼</a>
<p>Click link above to switch version</p>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Expand Down Expand Up @@ -331,7 +335,7 @@ <h4>Tips<a class="headerlink" href="#tips" title="Link to this heading"></a><
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
<jinja2.runtime.BlockReference object at 0x7fcedb859ff0>
<jinja2.runtime.BlockReference object at 0x700e2d3f92a0>
<p></p><div><a href='https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html' data-cookie-notice='true'>Cookies</a> <a href='https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html'>| Privacy</a> <a href="/#" data-wap_ref="dns" id="wap_dns"><small>| Your Privacy Choices</small></a> <a href=https://www.intel.com/content/www/us/en/privacy/privacy-residents-certain-states.html data-wap_ref="nac" id="wap_nac"><small>| Notice at Collection</small></a> </div> <p></p> <div>&copy; Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document, with the sole exception that code included in this document is licensed subject to the Zero-Clause BSD open source license (OBSD), <a href='http://opensource.org/licenses/0BSD'>http://opensource.org/licenses/0BSD</a>. </div>


Expand Down
Loading

0 comments on commit 508d326

Please sign in to comment.