[QEff. finetune] nit: add updates to cli md (#213)

* nit: add updates to cli md Signed-off-by: vbaddi <[email protected]> * nit: update finetune.py doc Signed-off-by: vbaddi <[email protected]> --------- Signed-off-by: vbaddi <[email protected]>
quic · Jan 10, 2025 · 2fed663 · 2fed663
1 parent 8546763
commit 2fed663
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git 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
@@ -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
+   
 ```