From 83e1f132dc24e2f05f8dbace7a143841df0386f7 Mon Sep 17 00:00:00 2001 From: Vinayak Baddi Date: Wed, 8 Jan 2025 06:36:00 +0000 Subject: [PATCH] nit: add updates to cli md Signed-off-by: vbaddi --- QEfficient/cloud/finetune.py | 8 ++++++++ docs/source/cli_api.md | 5 +++++ 2 files changed, 13 insertions(+) diff --git a/QEfficient/cloud/finetune.py b/QEfficient/cloud/finetune.py index b5e3eb628..450789af8 100644 --- a/QEfficient/cloud/finetune.py +++ b/QEfficient/cloud/finetune.py @@ -45,6 +45,14 @@ def main(**kwargs): + """ + Helper function to finetune the model on QAic. + + .. code-block:: bash + + python -m QEfficient.cloud.export OPTIONS + + """ # update the configuration for the training process train_config = TRAIN_CONFIG() update_config(train_config, **kwargs) diff --git a/docs/source/cli_api.md b/docs/source/cli_api.md index 32f3247b3..603f0141c 100644 --- a/docs/source/cli_api.md +++ b/docs/source/cli_api.md @@ -23,4 +23,9 @@ Use ``bash terminal``, else if using ``ZSH terminal`` then ``device_group``shoul ```{eval-rst} .. automodule:: QEfficient.cloud.export.main +``` +# `QEfficient.cloud.finetune` +```{eval-rst} + .. automodule:: QEfficient.cloud.finetune.main + ``` \ No newline at end of file