chore(docs): add note from get_framework

jina-ai · Oct 8, 2021 · a589a01 · a589a01
1 parent 80b5a2a
commit a589a01
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/finetuner/helper.py b/finetuner/helper.py
@@ -29,7 +29,12 @@
 
 
 def get_framework(dnn_model: AnyDNN) -> str:
-    """Return the framework that enpowers a DNN model
+    """Return the framework that enpowers a DNN model.
+
+    .. note::
+        This is not a solid implementation. It is based on ``__module__`` name,
+        the key idea is to tell ``dnn_model`` without actually importing the
+        framework.
 
     :param dnn_model: a DNN model
     :return: `keras`, `torch`, `paddle` or ValueError