clams-python 1.4.0__tar.gz → 1.5.0__tar.gz

{clams_python-1.4.0/clams_python.egg-info → clams_python-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clams-python
-Version: 1.4.0
+Version: 1.5.0
 Summary: A collection of APIs to develop CLAMS app for python
 Home-page: https://clams.ai
 Author: Brandeis Lab for Linguistics and Computation
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: mmif-python==1.2.1
+Requires-Dist: mmif-python==1.3.1
 Requires-Dist: Flask>=2
 Requires-Dist: Flask-RESTful>=0.3.9
 Requires-Dist: gunicorn>=20

clams_python-1.5.0/VERSION

@@ -0,0 +1 @@
+1.5.0

{clams_python-1.4.0 → clams_python-1.5.0}/clams/app/__init__.py

@@ -13,7 +13,11 @@ __all__ = ['ClamsApp']
 from typing import Union, Any, Optional, Dict, List, Tuple
 
 from mmif import Mmif, Document, DocumentTypes, View
-from mmif.utils.cli.describe import generate_param_hash  # pytype: disable=import-error
+from mmif.utils.video_document_helper import (
+    SamplingMode, SAMPLING_MODE_DESCRIPTIONS, SAMPLING_MODE_DEFAULT,
+    _sampling_mode,
+)
+from mmif.utils.workflow_helper import generate_param_hash  # pytype: disable=import-error
 from clams.appmetadata import AppMetadata, real_valued_primitives, python_type, map_param_kv_delimiter
 
 logging.basicConfig(
@@ -22,6 +26,16 @@ logging.basicConfig(
     datefmt="%Y-%m-%d %H:%M:%S")
 
 
+_sampling_mode_choices = [m.value for m in SamplingMode]
+_sampling_mode_description = (
+    'Sampling mode for TimeFrame annotations. '
+    'Has no effect when the app does not process TimeFrames. '
+    + ' '.join(
+        f'"{m.value}" {SAMPLING_MODE_DESCRIPTIONS[m]}'
+        for m in SamplingMode
+    )
+)
+
 falsy_values = [
     'False', 
     'false', 
@@ -55,6 +69,19 @@ class ClamsApp(ABC):
             'name': 'hwFetch', 'type': 'boolean', 'choices': None, 'default': False, 'multivalued': False,
             'description': 'The hardware information (architecture, GPU and vRAM) will be recorded in the view metadata',
         },
+        # tfSamplingMode is universal (not per-app) because it controls
+        # how vdh.extract_frames_by_mode() selects frames from TimeFrames.
+        # The value is intercepted in annotate() and pushed into a
+        # contextvars.ContextVar so that any vdh call inside _annotate()
+        # picks it up automatically — app developers never need to handle
+        # this parameter themselves.
+        {
+            'name': 'tfSamplingMode', 'type': 'string',
+            'choices': _sampling_mode_choices,
+            'default': SAMPLING_MODE_DEFAULT.value,
+            'multivalued': False,
+            'description': _sampling_mode_description,
+        },
     ]
     
     # this key is used to store users' raw input params in the parameter dict 
@@ -148,6 +175,9 @@ class ClamsApp(ABC):
         refined = self._refine_params(**runtime_params)
         self.logger.debug(f"Refined parameters: {refined}")
         pretty = refined.get('pretty', False)
+        sampling_mode_str = refined.pop('tfSamplingMode', None)
+        if sampling_mode_str is not None:
+            _sampling_mode.set(SamplingMode(sampling_mode_str))
         t = datetime.now()
         with warnings.catch_warnings(record=True) as ws:
             annotated, cuda_profiler = self._profile_cuda_memory(self._annotate)(mmif, **refined)

{clams_python-1.4.0 → clams_python-1.5.0}/clams/appmetadata/__init__.py

@@ -1,3 +1,4 @@
+import json
 import os
 import shutil
 import subprocess
@@ -523,4 +524,4 @@ class AppMetadata(pydantic.BaseModel):
 
 
 if __name__ == '__main__':
-    print(AppMetadata.schema_json(indent=2))
+    print(json.dumps(AppMetadata.model_json_schema(), indent=2))

clams_python-1.5.0/clams/ver/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.5.0"

{clams_python-1.4.0 → clams_python-1.5.0/clams_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clams-python
-Version: 1.4.0
+Version: 1.5.0
 Summary: A collection of APIs to develop CLAMS app for python
 Home-page: https://clams.ai
 Author: Brandeis Lab for Linguistics and Computation
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: mmif-python==1.2.1
+Requires-Dist: mmif-python==1.3.1
 Requires-Dist: Flask>=2
 Requires-Dist: Flask-RESTful>=0.3.9
 Requires-Dist: gunicorn>=20

{clams_python-1.4.0 → clams_python-1.5.0}/clams_python.egg-info/requires.txt

@@ -1,4 +1,4 @@
-mmif-python==1.2.1
+mmif-python==1.3.1
 Flask>=2
 Flask-RESTful>=0.3.9
 gunicorn>=20

{clams_python-1.4.0 → clams_python-1.5.0}/requirements.txt

@@ -1,4 +1,4 @@
-mmif-python==1.2.1
+mmif-python==1.3.1
 
 Flask>=2
 Flask-RESTful>=0.3.9

{clams_python-1.4.0 → clams_python-1.5.0}/tests/test_clamsapp.py

@@ -253,14 +253,14 @@ class TestClamsApp(unittest.TestCase):
         args3 = {'undefined_param1': ['value1']} 
         self.app.sign_view(v3, self.app._refine_params(**args3))
         self.assertEqual(len(v3.metadata.parameters), 1)
-        self.assertEqual(len(v3.metadata.appConfiguration), 5)  # universal (pretty, runningtime, hwfetch) + `raise_error` in metadata.py + `multivalued_param`
+        self.assertEqual(len(v3.metadata.appConfiguration), 6)  # universal (pretty, runningTime, hwFetch, tfSamplingMode) + `raise_error` in metadata.py + `multivalued_param`
         self.assertEqual(v3.metadata.appConfiguration['multivalued_param'], [])
         v4 = m.new_view()
         multiple_values = ['value1', 'value2']
         args4 = {'multivalued_param': multiple_values}
         self.app.sign_view(v4, self.app._refine_params(**args4))
         self.assertEqual(len(v4.metadata.parameters), 1)
-        self.assertEqual(len(v4.metadata.appConfiguration), 5)
+        self.assertEqual(len(v4.metadata.appConfiguration), 6)
         self.assertEqual(len(v4.metadata.parameters['multivalued_param']), len(str(multiple_values)))
 
     def test_annotate(self):

clams_python-1.4.0/VERSION

@@ -1 +0,0 @@
-1.4.0

clams_python-1.4.0/clams/ver/__init__.py

@@ -1 +0,0 @@
-__version__ = "1.4.0"