DESCRIPTION to ImageCaption Ingredient

parkervg · Jun 21, 2024 · aa83a8c · aa83a8c
1 parent d45bed5
commit aa83a8c
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/blendsql/ingredients/builtin/vqa/main.py b/blendsql/ingredients/builtin/vqa/main.py
@@ -21,6 +21,11 @@ def __call__(
 
 
 class ImageCaption(MapIngredient):
+    DESCRIPTION = """
+    If we need to generate a caption for an image stored in the database, we can use the scalar function to map to a new column:
+        `{{ImageCaption('table::column')}}`
+    """
+
     def run(self, model: Model, values: List[bytes], **kwargs):
         """Generates a caption for all byte images passed to it."""
         if not all(isinstance(value, bytes) for value in values):