Merge pull request #240 from clamsproject/develop

releasing 1.3.0

Author: keighrim

clams/app/__init__.py

@@ -5,6 +5,7 @@
 import warnings
 from abc import ABC, abstractmethod
 from contextlib import contextmanager
+from datetime import datetime
 from urllib import parse as urlparser
 
 __all__ = ['ClamsApp']
@@ -44,6 +45,14 @@ class ClamsApp(ABC):
             'name': 'pretty', 'type': 'boolean', 'choices': None, 'default': False, 'multivalued': False,
             'description': 'The JSON body of the HTTP response will be re-formatted with 2-space indentation',
         },
+        {
+            'name': 'runningTime', 'type': 'boolean', 'choices': None, 'default': False, 'multivalued': False,
+            'description': 'The running time of the app will be recorded in the view metadata',
+        },
+        {
+            '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',
+        },
     ]
 
     # this key is used to store users' raw input params in the parameter dict 
@@ -136,6 +145,7 @@ def annotate(self, mmif: Union[str, dict, Mmif], **runtime_params: List[str]) ->
         refined = self._refine_params(**runtime_params)
         self.logger.debug(f"Refined parameters: {refined}")
         pretty = refined.get('pretty', False)
+        t = datetime.now()
         with warnings.catch_warnings(record=True) as ws:
             annotated = self._annotate(mmif, **refined)
             if ws:
@@ -144,6 +154,27 @@ def annotate(self, mmif: Union[str, dict, Mmif], **runtime_params: List[str]) ->
             warnings_view = annotated.new_view()
             self.sign_view(warnings_view, refined)
             warnings_view.metadata.warnings = issued_warnings
+        td = datetime.now() - t
+        runningTime = refined.get('runningTime', False)
+        hwFetch = refined.get('hwFetch', False)
+        runtime_recs = {}
+        if hwFetch:
+            import platform, shutil, subprocess
+            runtime_recs['architecture'] = platform.machine()
+            # runtime_recs['processor'] = platform.processor()  # this only works on Windows
+            runtime_recs['cuda'] = []
+            if shutil.which('nvidia-smi'):
+                for gpu in subprocess.run(['nvidia-smi', '--query-gpu=name,memory.total', '--format=csv,noheader'], 
+                                          stdout=subprocess.PIPE).stdout.decode('utf-8').strip().split('\n'):
+                    name, mem = gpu.split(', ')
+                    runtime_recs['cuda'].append(f'{name} ({mem})')
+        for annotated_view in annotated.views:
+            if annotated_view.metadata.app == self.metadata.identifier:
+                if runningTime:
+                    annotated_view.metadata.set_additional_property('appRunningTime', str(td))
+                if len(runtime_recs) > 0:
+                    annotated_view.metadata.set_additional_property('appRunningHardware', runtime_recs)
+                    
         return annotated.serialize(pretty=pretty, sanitize=True)
 
     @abstractmethod

documentation/appmetadata.rst

@@ -91,7 +91,7 @@ input specification can be as simple as the following:
       # and more app metadata fields, 
     }
     
-In the above example, the developer is declaring the app is expecting ``Token``annotation objects, with a ``posTagSet`` 
+In the above example, the developer is declaring the app is expecting ``Token`` annotation objects, with a ``posTagSet`` 
 property of which value is the URL of the Penn Treebank POS tag set, *verbatim*, in the input MMIF, and all other 
 existing annotation types in the input MMIF will be ignored during processing. There are some *grammar* of how this 
 ``input`` list can be written. 

documentation/autodoc/clams.appmetadata.rst

@@ -6,3 +6,15 @@ Module contents
 
 .. autoclass:: clams.appmetadata.AppMetadata
    :members:
+
+.. autoclass:: clams.appmetadata.Input
+   :members:
+   :inherited-members:
+
+.. autoclass:: clams.appmetadata.Output
+   :members:
+   :inherited-members:
+
+.. autoclass:: clams.appmetadata.RuntimeParameter
+   :members:
+   :inherited-members:

tests/test_clamsapp.py

@@ -253,14 +253,14 @@ def test_sign_view(self):
         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), 3)  # universal (pretty) + `raise_error` in metadata.py + `multivalued_param`
+        self.assertEqual(len(v3.metadata.appConfiguration), 5)  # universal (pretty, runningtime, hwfetch) + `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), 3)
+        self.assertEqual(len(v4.metadata.appConfiguration), 5)
         self.assertEqual(len(v4.metadata.parameters['multivalued_param']), len(str(multiple_values)))
 
     def test_annotate(self):