clams-python 1.2.6__tar.gz → 1.3.1__tar.gz

{clams_python-1.2.6/clams_python.egg-info → clams_python-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clams-python
-Version: 1.2.6
+Version: 1.3.1
 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.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: mmif-python==1.0.18
+Requires-Dist: mmif-python==1.0.19
 Requires-Dist: Flask>=2
 Requires-Dist: Flask-RESTful>=0.3.9
 Requires-Dist: gunicorn>=20

clams_python-1.3.1/VERSION

@@ -0,0 +1 @@
+1.3.1

{clams_python-1.2.6 → clams_python-1.3.1}/clams/app/__init__.py

@@ -5,6 +5,7 @@ import sys
 import warnings
 from abc import ABC, abstractmethod
 from contextlib import contextmanager
+from datetime import datetime
 from urllib import parse as urlparser
 
 __all__ = ['ClamsApp']
@@ -30,6 +31,7 @@ falsy_values = [
     False
 ]
 
+
 class ClamsApp(ABC):
     """
     An abstract class to define API's for ClamsApps. A CLAMS app should inherit
@@ -44,6 +46,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 +146,7 @@ class ClamsApp(ABC):
         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 +155,27 @@ class ClamsApp(ABC):
             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

{clams_python-1.2.6 → clams_python-1.3.1}/clams/mmif_utils/rewind.py

@@ -1,7 +1,9 @@
+"""
+This module provides a CLI to rewind a MMIF from a CLAMS pipeline.
+"""
 import argparse
 import sys
 import textwrap
-from pathlib import Path as P
 
 import mmif
 

{clams_python-1.2.6 → clams_python-1.3.1}/clams/mmif_utils/source.py

@@ -1,3 +1,6 @@
+"""
+This module provides a class for creating a "source" MMIF JSON object.
+"""
 import argparse
 import itertools
 import json

clams_python-1.3.1/clams/ver/__init__.py

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

{clams_python-1.2.6 → clams_python-1.3.1/clams_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clams-python
-Version: 1.2.6
+Version: 1.3.1
 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.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: mmif-python==1.0.18
+Requires-Dist: mmif-python==1.0.19
 Requires-Dist: Flask>=2
 Requires-Dist: Flask-RESTful>=0.3.9
 Requires-Dist: gunicorn>=20

{clams_python-1.2.6 → clams_python-1.3.1}/clams_python.egg-info/requires.txt

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

{clams_python-1.2.6 → clams_python-1.3.1}/requirements.txt

@@ -1,4 +1,4 @@
-mmif-python==1.0.18
+mmif-python==1.0.19
 
 Flask>=2
 Flask-RESTful>=0.3.9

{clams_python-1.2.6 → clams_python-1.3.1}/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), 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):

clams_python-1.2.6/VERSION

@@ -1 +0,0 @@
-1.2.6

clams_python-1.2.6/clams/ver/__init__.py

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