Skip to content

Commit

Permalink
Update docs from d98186d
Browse files Browse the repository at this point in the history
  • Loading branch information
olivedevteam committed Jan 30, 2025
1 parent 7ec4836 commit b1cef0c
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 6 deletions.
12 changes: 10 additions & 2 deletions reference/cli.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ <h1>Finetune<a class="headerlink" href="#finetune" title="Link to this heading">
<span class="p">[</span><span class="o">--</span><span class="n">train_subset</span> <span class="n">TRAIN_SUBSET</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">train_split</span> <span class="n">TRAIN_SPLIT</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">eval_subset</span> <span class="n">EVAL_SUBSET</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">eval_split</span> <span class="n">EVAL_SPLIT</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">data_files</span> <span class="n">DATA_FILES</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">text_field</span> <span class="n">TEXT_FIELD</span> <span class="o">|</span> <span class="o">--</span><span class="n">text_template</span> <span class="n">TEXT_TEMPLATE</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">text_field</span> <span class="n">TEXT_FIELD</span> <span class="o">|</span> <span class="o">--</span><span class="n">text_template</span> <span class="n">TEXT_TEMPLATE</span> <span class="o">|</span> <span class="o">--</span><span class="n">use_chat_template</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">max_seq_len</span> <span class="n">MAX_SEQ_LEN</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">add_special_tokens</span> <span class="n">ADD_SPECIAL_TOKENS</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">max_samples</span> <span class="n">MAX_SAMPLES</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">batch_size</span> <span class="n">BATCH_SIZE</span><span class="p">]</span>
Expand Down Expand Up @@ -544,6 +544,10 @@ <h2>Named Arguments<a class="headerlink" href="#named-arguments" title="Link to
<dt><kbd>--text_template</kbd></dt>
<dd><p>Template to generate text field from. E.g. ‘### Question: {prompt} n### Answer: {response}’</p>
</dd>
<dt><kbd>--use_chat_template</kbd></dt>
<dd><p>Use chat template for text field.</p>
<p>Default: False</p>
</dd>
<dt><kbd>--max_seq_len</kbd></dt>
<dd><p>Maximum sequence length for the data.</p>
<p>Default: 1024</p>
Expand Down Expand Up @@ -784,7 +788,7 @@ <h1>Quantization<a class="headerlink" href="#quantization" title="Link to this h
<span class="p">[</span><span class="o">--</span><span class="n">implementation</span> <span class="p">{</span><span class="n">awq</span><span class="p">,</span><span class="n">bnb4</span><span class="p">,</span><span class="n">gptq</span><span class="p">,</span><span class="n">inc_dynamic</span><span class="p">,</span><span class="n">matmul4</span><span class="p">,</span><span class="n">mnb_to_qdq</span><span class="p">,</span><span class="n">nvmo</span><span class="p">,</span><span class="n">onnx_dynamic</span><span class="p">}]</span>
<span class="p">[</span><span class="o">--</span><span class="n">enable</span><span class="o">-</span><span class="n">qdq</span><span class="o">-</span><span class="n">encoding</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span> <span class="n">DATA_NAME</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">subset</span> <span class="n">SUBSET</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">split</span> <span class="n">SPLIT</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">data_files</span> <span class="n">DATA_FILES</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">text_field</span> <span class="n">TEXT_FIELD</span> <span class="o">|</span> <span class="o">--</span><span class="n">text_template</span> <span class="n">TEXT_TEMPLATE</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">text_field</span> <span class="n">TEXT_FIELD</span> <span class="o">|</span> <span class="o">--</span><span class="n">text_template</span> <span class="n">TEXT_TEMPLATE</span> <span class="o">|</span> <span class="o">--</span><span class="n">use_chat_template</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">max_seq_len</span> <span class="n">MAX_SEQ_LEN</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">add_special_tokens</span> <span class="n">ADD_SPECIAL_TOKENS</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">max_samples</span> <span class="n">MAX_SAMPLES</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">batch_size</span> <span class="n">BATCH_SIZE</span><span class="p">]</span>
Expand Down Expand Up @@ -862,6 +866,10 @@ <h2>Named Arguments<a class="headerlink" href="#named-arguments" title="Link to
<dt><kbd>--text_template</kbd></dt>
<dd><p>Template to generate text field from. E.g. ‘### Question: {prompt} n### Answer: {response}’</p>
</dd>
<dt><kbd>--use_chat_template</kbd></dt>
<dd><p>Use chat template for text field.</p>
<p>Default: False</p>
</dd>
<dt><kbd>--max_seq_len</kbd></dt>
<dd><p>Maximum sequence length for the data.</p>
<p>Default: 1024</p>
Expand Down
5 changes: 2 additions & 3 deletions reference/pass.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5223,8 +5223,7 @@ <h1>Pytorch<a class="headerlink" href="#pytorch" title="Link to this heading">#<
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-arg-258">
<span class="sig-name descname"><span class="pre">data_config</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-arg-258" title="Link to this definition">#</a></dt>
<dd><p>
Data config for quantization. Default value is None.</p>
<dd><p>Data config for quantization. If not provided, wikitest train data will be used for HfModels. Required for PyTorch models.</p>
<p><strong>type:</strong> olive.data.config.DataConfig | Dict</p>
<p><strong>default_value:</strong> None</p>
<p><strong>search_defaults:</strong> None</p>
Expand Down Expand Up @@ -5329,7 +5328,7 @@ <h1>Pytorch<a class="headerlink" href="#pytorch" title="Link to this heading">#<
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-arg-261">
<span class="sig-name descname"><span class="pre">data_config</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-arg-261" title="Link to this definition">#</a></dt>
<dd><p>Data config for quantization. Default value is None.</p>
<dd><p>Data config for quantization. If not provided, pile validation data will be used.</p>
<p><strong>type:</strong> olive.data.config.DataConfig | Dict</p>
<p><strong>default_value:</strong> None</p>
<p><strong>search_defaults:</strong> None</p>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit b1cef0c

Please sign in to comment.