Adding documentation of Phi3v class.

vfragoso · vfragoso · commit d0b6e7c93829 · 2024-05-24T16:36:37.000Z
diff --git a/lmms_eval/models/phi3v.py b/lmms_eval/models/phi3v.py
@@ -17,7 +17,18 @@
 @register_model("phi3v")
 class Phi3v(lmms):
     """
-    TODO(vifragos): Document me!
+    This class implements inference for the microsoft/Phi-3-vision-128k-instruct model.
+    To learn more about this model please visit the following links:
+    1. https://huggingface.co/microsoft/Phi-3-vision-128k-instruct
+    2. https://azure.microsoft.com/en-us/blog/new-models-added-to-the-phi-3-family-available-on-microsoft-azure/
+    3. https://github.com/microsoft/Phi-3CookBook
+
+    NOTE: This class was adapted from quen_vl.py and llava_hf.py.
+
+    Example:
+
+    accelerate launch --num_processes=4 -m lmms_eval --model phi3v --tasks mmmu_val \
+        --batch_size 1 --log_samples --log_samples_suffix phi3v_mmmu --output_path ./logs/
     """
     def __init__(
             self,
