Update docs from 2066637

microsoft · Aug 27, 2024 · 028c409 · 028c409
1 parent dcbb13c
commit 028c409
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 12 deletions.
diff --git a/features/cli.html b/features/cli.html
@@ -102,6 +102,7 @@
 <li class="toctree-l4"><a class="reference internal" href="#dataset-options,-which-mutually-exclusive-with-huggingface-dataset-options">dataset options, which mutually exclusive with huggingface dataset options</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#huggingface-dataset-options,-if-dataset-options-are-not-provided,-user-should-provide-the-following-options-to-modify-the-default-data-config.-please-refer-to-olive.data.container.transformerstokendummydatacontainer-for-more-details.">huggingface dataset options, if dataset options are not provided, user should provide the following options to modify the default data config. Please refer to olive.data.container.TransformersTokenDummyDataContainer for more details.</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#pass-options">pass options</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#remote-options_repeat1">remote options</a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="#cloud-cache">cloud-cache</a><ul>
@@ -220,16 +221,16 @@ <h3>finetune<a class="headerlink" href="#finetune" title="Permalink to this head
 <p>Fine-tune a model on a dataset using peft and optimize the model for ONNX Runtime with adapters as inputs. Huggingface training arguments can be provided along with the defined options.</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">olive</span> <span class="n">finetune</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">precision</span> <span class="p">{</span><span class="n">float16</span><span class="p">,</span><span class="n">float32</span><span class="p">}]</span> <span class="o">-</span><span class="n">m</span> <span class="n">MODEL_NAME_OR_PATH</span>
                <span class="p">[</span><span class="o">--</span><span class="n">trust_remote_code</span><span class="p">]</span>
-               <span class="p">[</span><span class="o">--</span><span class="n">torch_dtype</span> <span class="p">{</span><span class="n">bfloat16</span><span class="p">,</span><span class="n">float16</span><span class="p">,</span><span class="n">float32</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="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">train_split</span> <span class="n">TRAIN_SPLIT</span><span class="p">]</span>
+               <span class="p">[</span><span class="o">--</span><span class="n">torch_dtype</span> <span class="p">{</span><span class="n">bfloat16</span><span class="p">,</span><span class="n">float16</span><span class="p">,</span><span class="n">float32</span><span class="p">}]</span> <span class="p">[</span><span class="o">--</span><span class="n">use_ort_genai</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="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">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_split</span> <span class="n">EVAL_SPLIT</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">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">method</span> <span class="p">{</span><span class="n">lora</span><span class="p">,</span><span class="n">qlora</span><span class="p">}]</span>
                <span class="p">[</span><span class="o">--</span><span class="n">lora_r</span> <span class="n">LORA_R</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">lora_alpha</span> <span class="n">LORA_ALPHA</span><span class="p">]</span>
                <span class="p">[</span><span class="o">--</span><span class="n">target_modules</span> <span class="n">TARGET_MODULES</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">o</span> <span class="n">OUTPUT_PATH</span><span class="p">]</span>
-               <span class="p">[</span><span class="o">--</span><span class="n">tempdir</span> <span class="n">TEMPDIR</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">clean</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">azureml_config</span> <span class="n">AZUREML_CONFIG</span><span class="p">]</span>
-               <span class="p">[</span><span class="o">--</span><span class="n">azureml_cluster</span> <span class="n">AZUREML_CLUSTER</span><span class="p">]</span>
-               <span class="p">[</span><span class="o">--</span><span class="n">azureml_keyvault</span> <span class="n">AZUREML_KEYVAULT</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">use_ort_genai</span><span class="p">]</span>
+               <span class="p">[</span><span class="o">--</span><span class="n">tempdir</span> <span class="n">TEMPDIR</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">clean</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">resource_group</span> <span class="n">RESOURCE_GROUP</span><span class="p">]</span>
+               <span class="p">[</span><span class="o">--</span><span class="n">workspace_name</span> <span class="n">WORKSPACE_NAME</span><span class="p">]</span>
+               <span class="p">[</span><span class="o">--</span><span class="n">keyvault_name</span> <span class="n">KEYVAULT_NAME</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">aml_compute</span> <span class="n">AML_COMPUTE</span><span class="p">]</span>
 </pre></div>
 </div>
 <section id="named-arguments_repeat1">
@@ -327,14 +328,17 @@ <h4>lora options<a class="headerlink" href="#lora-options" title="Permalink to t
 <section id="remote-options">
 <h4>remote options<a class="headerlink" href="#remote-options" title="Permalink to this heading">¶</a></h4>
 <dl class="option-list">
-<dt><kbd>--azureml_config</kbd></dt>
-<dd><p>Path to the azureml config file for remote run. Recommended to log in using <cite>az login</cite> before running.</p>
+<dt><kbd>--resource_group</kbd></dt>
+<dd><p>Resource group for the AzureML workspace.</p>
+</dd>
+<dt><kbd>--workspace_name</kbd></dt>
+<dd><p>Workspace name for the AzureML workspace.</p>
 </dd>
-<dt><kbd>--azureml_cluster</kbd></dt>
-<dd><p>The azureml cluster to use for remote run. Must be provided if using azureml_config.</p>
+<dt><kbd>--keyvault_name</kbd></dt>
+<dd><p>The azureml keyvault name with huggingface token to use for remote run. Refer to <a class="reference external" href="https://microsoft.github.io/Olive/features/huggingface_model_optimization.html#huggingface-login">https://microsoft.github.io/Olive/features/huggingface_model_optimization.html#huggingface-login</a> for more details.</p>
 </dd>
-<dt><kbd>--azureml_keyvault</kbd></dt>
-<dd><p>The azureml keyvault with huggingface token to use for remote run. Refer to <a class="reference external" href="https://microsoft.github.io/Olive/features/huggingface_model_optimization.html#huggingface-login">https://microsoft.github.io/Olive/features/huggingface_model_optimization.html#huggingface-login</a> for more details.</p>
+<dt><kbd>--aml_compute</kbd></dt>
+<dd><p>The compute name to run the workflow on.</p>
 </dd>
 </dl>
 </section>
@@ -502,6 +506,10 @@ <h3>tune-session-params<a class="headerlink" href="#tune-session-params" title="
                           <span class="p">[</span><span class="o">--</span><span class="n">disable_force_evaluate_other_eps</span><span class="p">]</span>
                           <span class="p">[</span><span class="o">--</span><span class="n">enable_profiling</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">output_path</span> <span class="n">OUTPUT_PATH</span><span class="p">]</span>
                           <span class="p">[</span><span class="o">--</span><span class="n">tempdir</span> <span class="n">TEMPDIR</span><span class="p">]</span>
+                          <span class="p">[</span><span class="o">--</span><span class="n">resource_group</span> <span class="n">RESOURCE_GROUP</span><span class="p">]</span>
+                          <span class="p">[</span><span class="o">--</span><span class="n">workspace_name</span> <span class="n">WORKSPACE_NAME</span><span class="p">]</span>
+                          <span class="p">[</span><span class="o">--</span><span class="n">keyvault_name</span> <span class="n">KEYVAULT_NAME</span><span class="p">]</span>
+                          <span class="p">[</span><span class="o">--</span><span class="n">aml_compute</span> <span class="n">AML_COMPUTE</span><span class="p">]</span>
 </pre></div>
 </div>
 <section id="named-arguments_repeat5">
@@ -631,6 +639,23 @@ <h4>pass options<a class="headerlink" href="#pass-options" title="Permalink to t
 </dd>
 </dl>
 </section>
+<section id="remote-options_repeat1">
+<h4>remote options<a class="headerlink" href="#remote-options_repeat1" title="Permalink to this heading">¶</a></h4>
+<dl class="option-list">
+<dt><kbd>--resource_group</kbd></dt>
+<dd><p>Resource group for the AzureML workspace.</p>
+</dd>
+<dt><kbd>--workspace_name</kbd></dt>
+<dd><p>Workspace name for the AzureML workspace.</p>
+</dd>
+<dt><kbd>--keyvault_name</kbd></dt>
+<dd><p>The azureml keyvault name with huggingface token to use for remote run. Refer to <a class="reference external" href="https://microsoft.github.io/Olive/features/huggingface_model_optimization.html#huggingface-login">https://microsoft.github.io/Olive/features/huggingface_model_optimization.html#huggingface-login</a> for more details.</p>
+</dd>
+<dt><kbd>--aml_compute</kbd></dt>
+<dd><p>The compute name to run the workflow on.</p>
+</dd>
+</dl>
+</section>
 </section>
 <section id="cloud-cache">
 <h3>cloud-cache<a class="headerlink" href="#cloud-cache" title="Permalink to this heading">¶</a></h3>

diff --git a/searchindex.js b/searchindex.js