From 2fed663ebd1983f8c971e532a7ce4345ef37dd0a Mon Sep 17 00:00:00 2001 From: Vinayak Baddi <68580231+vbaddi@users.noreply.github.com> Date: Wed, 8 Jan 2025 13:50:53 +0530 Subject: [PATCH] [QEff. finetune] nit: add updates to cli md (#213) * nit: add updates to cli md Signed-off-by: vbaddi * nit: update finetune.py doc Signed-off-by: vbaddi --------- 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..b1f7cbc21 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.finetune 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