Skip to content

[gh-pages]: release/v1.19 doc is Released #316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 11, 2025
Merged

[gh-pages]: release/v1.19 doc is Released #316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions _modules/QEfficient/peft/auto.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,10 @@ <h1>Source code for QEfficient.peft.auto</h1><div class="highlight"><pre>
<span class="n">mhash</span> <span class="o">=</span> <span class="n">mhash</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()[:</span><span class="mi">16</span><span class="p">]</span>
<span class="k">return</span> <span class="n">mhash</span>

<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_model_config</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">get_base_model</span><span class="p">()</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="vm">__dict__</span>

<div class="viewcode-block" id="QEffAutoPeftModelForCausalLM.load_adapter"><a class="viewcode-back" href="../../../source/python_api.html#QEfficient.peft.auto.QEffAutoPeftModelForCausalLM.load_adapter">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">load_adapter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">model_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">adapter_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Loads a new adapter from huggingface hub or local path</span>

Expand Down
4 changes: 4 additions & 0 deletions _modules/QEfficient/peft/lora/auto.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,10 @@ <h1>Source code for QEfficient.peft.lora.auto</h1><div class="highlight"><pre>
<span class="n">mhash</span> <span class="o">=</span> <span class="n">mhash</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()[:</span><span class="mi">16</span><span class="p">]</span>
<span class="k">return</span> <span class="n">mhash</span>

<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_model_config</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="vm">__dict__</span>

<div class="viewcode-block" id="QEffAutoLoraModelForCausalLM.download_adapter"><a class="viewcode-back" href="../../../../source/python_api.html#QEfficient.peft.lora.auto.QEffAutoLoraModelForCausalLM.download_adapter">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">download_adapter</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">adapter_model_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
Expand Down
195 changes: 150 additions & 45 deletions _modules/QEfficient/transformers/models/modeling_auto.html
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions genindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,8 +480,9 @@ <h2 id="U">U</h2>
<div class="rst-other-versions">
Versions
<dl>
<dd><a href="../index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="index.html">main</a></dd>
<dd><a href="source/release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="source/release/v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,7 @@ <h1>Welcome to Efficient-Transformers Documentation!<a class="headerlink" href="
<dl>
<dd><a href="index.html">main</a></dd>
<dd><a href="source/release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="source/release/v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
5 changes: 3 additions & 2 deletions py-modindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,8 +214,9 @@ <h1>Python Module Index</h1>
<div class="rst-other-versions">
Versions
<dl>
<dd><a href="../index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="index.html">main</a></dd>
<dd><a href="source/release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="source/release/v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
5 changes: 3 additions & 2 deletions search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,9 @@
<div class="rst-other-versions">
Versions
<dl>
<dd><a href="../index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="index.html">main</a></dd>
<dd><a href="source/release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="source/release/v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions source/blogs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ <h1>Qualcomm Cloud AI Introduces Efficient Transformers: One API, Infinite Possi
<dl>
<dd><a href="../index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="release/v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/cli_api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@ <h2><code class="docutils literal notranslate"><span class="pre">QEfficient.clou
<dl>
<dd><a href="../index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="release/v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/finetune.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,7 @@ <h2>Visualization<a class="headerlink" href="#visualization" title="Permalink to
<dl>
<dd><a href="../index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="release/v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/hl_api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1238,6 +1238,7 @@ <h2><code class="docutils literal notranslate"><span class="pre">QEffAutoLoraMod
<dl>
<dd><a href="../index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="release/v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/installation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,7 @@ <h1>Sanity Check<a class="headerlink" href="#sanity-check" title="Permalink to t
<dl>
<dd><a href="../index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="release/v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/introduction.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,7 @@ <h1>Introduction Qualcomm <code class="docutils literal notranslate"><span class
<dl>
<dd><a href="../index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="release/v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/ll_api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -529,6 +529,7 @@ <h3>ApiRunner class is responsible for running:<a class="headerlink" href="#apir
<dl>
<dd><a href="../index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="release/v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
64 changes: 39 additions & 25 deletions source/python_api.html
View file
Open in desktop

Large diffs are not rendered by default.

7 changes: 4 additions & 3 deletions source/quick_start.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ <h3>2. Export and Compile with one API<a class="headerlink" href="#export-and-co

<span class="n">generated_qpc_path</span> <span class="o">=</span> <span class="n">qeff_model</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span>
<span class="n">num_cores</span><span class="o">=</span><span class="mi">14</span><span class="p">,</span>
<span class="n">mxfp6</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">mxfp6_matmul</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
Expand All @@ -398,8 +398,8 @@ <h3>3. Execute<a class="headerlink" href="#execute" title="Permalink to this hea
<p>Benchmark the model on Cloud AI 100, run the infer API to print tokens and tok/sec</p>
<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><span class="c1"># post compilation, we can print the latency stats for the kv models, We provide API to print token and Latency stats on AI 100</span>
<span class="c1"># We need the compiled prefill and decode qpc to compute the token generated, This is based on Greedy Sampling Approach</span>

<span class="n">qeff_model</span><span class="o">.</span><span class="n">generate</span><span class="p">(</span><span class="n">prompts</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;My name is&quot;</span><span class="p">])</span>
<span class="n">tokenizer</span> <span class="o">=</span> <span class="n">AutoTokenizer</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">model_name</span><span class="p">)</span>
<span class="n">qeff_model</span><span class="o">.</span><span class="n">generate</span><span class="p">(</span><span class="n">prompts</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;My name is&quot;</span><span class="p">],</span><span class="n">tokenizer</span><span class="o">=</span><span class="n">tokenizer</span><span class="p">)</span>
</pre></div>
</div>
<p>End to End demo examples for various models are available in <strong>notebooks</strong> directory. Please check them out.</p>
Expand Down Expand Up @@ -456,6 +456,7 @@ <h3>Draft-Based Speculative Decoding<a class="headerlink" href="#draft-based-spe
<dl>
<dd><a href="../index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="release/v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/reference.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ <h1><a class="reference external" href="https://www.opencompute.org/documents/oc
<dl>
<dd><a href="../index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="release/v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
5 changes: 3 additions & 2 deletions source/release/v1.18/README.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,9 @@ <h2>Preview the docs locally<a class="headerlink" href="#preview-the-docs-locall
<div class="rst-other-versions">
Versions
<dl>
<dd><a href="index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="../../../index.html">main</a></dd>
<dd><a href="index.html">release/v1.18</a></dd>
<dd><a href="../v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
5 changes: 3 additions & 2 deletions source/release/v1.18/genindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,8 +448,9 @@ <h2 id="U">U</h2>
<div class="rst-other-versions">
Versions
<dl>
<dd><a href="index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="../../../index.html">main</a></dd>
<dd><a href="index.html">release/v1.18</a></dd>
<dd><a href="../v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/release/v1.18/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,7 @@ <h1>Welcome to Efficient-Transformers Documentation!<a class="headerlink" href="
<dl>
<dd><a href="../../../index.html">main</a></dd>
<dd><a href="index.html">release/v1.18</a></dd>
<dd><a href="../v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
5 changes: 3 additions & 2 deletions source/release/v1.18/py-modindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,8 +218,9 @@ <h1>Python Module Index</h1>
<div class="rst-other-versions">
Versions
<dl>
<dd><a href="index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="../../../index.html">main</a></dd>
<dd><a href="index.html">release/v1.18</a></dd>
<dd><a href="../v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
5 changes: 3 additions & 2 deletions source/release/v1.18/search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,9 @@
<div class="rst-other-versions">
Versions
<dl>
<dd><a href="index.html">main</a></dd>
<dd><a href="release/v1.18/index.html">release/v1.18</a></dd>
<dd><a href="../../../index.html">main</a></dd>
<dd><a href="index.html">release/v1.18</a></dd>
<dd><a href="../v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/release/v1.18/source/blogs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ <h1>Qualcomm Cloud AI Introduces Efficient Transformers: One API, Infinite Possi
<dl>
<dd><a href="../../../../index.html">main</a></dd>
<dd><a href="../index.html">release/v1.18</a></dd>
<dd><a href="../../v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/release/v1.18/source/cli_api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,7 @@ <h1><code class="docutils literal notranslate"><span class="pre">QEfficient.clou
<dl>
<dd><a href="../../../../index.html">main</a></dd>
<dd><a href="../index.html">release/v1.18</a></dd>
<dd><a href="../../v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/release/v1.18/source/hl_api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -746,6 +746,7 @@ <h2><code class="docutils literal notranslate"><span class="pre">QEffAutoPeftMod
<dl>
<dd><a href="../../../../index.html">main</a></dd>
<dd><a href="../index.html">release/v1.18</a></dd>
<dd><a href="../../v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/release/v1.18/source/installation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ <h1>Sanity Check<a class="headerlink" href="#sanity-check" title="Permalink to t
<dl>
<dd><a href="../../../../index.html">main</a></dd>
<dd><a href="../index.html">release/v1.18</a></dd>
<dd><a href="../../v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/release/v1.18/source/introduction.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ <h1>Introduction Qualcomm <code class="docutils literal notranslate"><span class
<dl>
<dd><a href="../../../../index.html">main</a></dd>
<dd><a href="../index.html">release/v1.18</a></dd>
<dd><a href="../../v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/release/v1.18/source/ll_api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,6 +520,7 @@ <h3>ApiRunner class is responsible for running:<a class="headerlink" href="#apir
<dl>
<dd><a href="../../../../index.html">main</a></dd>
<dd><a href="../index.html">release/v1.18</a></dd>
<dd><a href="../../v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/release/v1.18/source/quick_start.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,7 @@ <h2>3. Execute<a class="headerlink" href="#execute" title="Permalink to this hea
<dl>
<dd><a href="../../../../index.html">main</a></dd>
<dd><a href="../index.html">release/v1.18</a></dd>
<dd><a href="../../v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/release/v1.18/source/reference.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ <h1><a class="reference external" href="https://www.qualcomm.com/developer/blog/
<dl>
<dd><a href="../../../../index.html">main</a></dd>
<dd><a href="../index.html">release/v1.18</a></dd>
<dd><a href="../../v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
1 change: 1 addition & 0 deletions source/release/v1.18/source/validate.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,7 @@
<dl>
<dd><a href="../../../../index.html">main</a></dd>
<dd><a href="../index.html">release/v1.18</a></dd>
<dd><a href="../../v1.19/index.html">release/v1.19</a></dd>
</dl>
</div>
</div><script>
Expand Down
Loading