clams-python 1.2.5__tar.gz → 1.3.0__tar.gz

{clams_python-1.2.5/clams_python.egg-info → clams_python-1.3.0}/PKG-INFO

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

clams_python-1.3.0/VERSION

@@ -0,0 +1 @@
+1.3.0

{clams_python-1.2.5 → clams_python-1.3.0}/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']
@@ -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 @@ 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 +154,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
@@ -260,7 +291,7 @@ class ClamsApp(ABC):
                 break
         if error_view is None:
             error_view = mmif.new_view()
-            self.sign_view(error_view, self._refine_params(**runtime_conf))
+            self.sign_view(error_view, runtime_conf)
         exc_info = sys.exc_info()
         error_view.set_error(f'{exc_info[0]}: {exc_info[1]}',
                              '\t\n'.join(traceback.format_tb(exc_info[2])))

{clams_python-1.2.5 → clams_python-1.3.0}/clams/develop/templates/app/Containerfile.template

@@ -25,7 +25,7 @@ ENV HF_HOME="/cache/huggingface"
 # https://pytorch.org/docs/stable/hub.html#where-are-my-downloaded-models-saved
 ENV TORCH_HOME="/cache/torch"
 
-RUN mkdir /cache ; rm -rf /root/.cache && ln -s /cache /root/.cache
+RUN mkdir /cache ; rm -rf /root/.cache ; ln -s /cache /root/.cache
 ################################################################################
 
 ################################################################################

{clams_python-1.2.5 → clams_python-1.3.0}/clams/mmif_utils/source.py

@@ -203,9 +203,10 @@ def generate_source_mmif_from_file(documents, prefix=None, scheme='file', **igno
                 raise ValueError(f'file location must be an absolute path, or --prefix must be used; given \"{location}\".')
             elif prefix and not location.is_absolute():
                 location = prefix / location
+        location = str(location)
         doc = Document()
         doc.at_type = at_types[mime.split('/', maxsplit=1)[0]]
-        doc.properties.location = f"{location_uri.scheme}://{location}"
+        doc.properties.location = f"{location_uri.scheme}://{location if not location.startswith(location_uri.scheme) else location[len(location_uri.scheme)+3:]}"
         doc.properties.id = f'd{doc_id}'
         doc.properties.mime = mime
         pl.add_document(doc)
@@ -225,7 +226,14 @@ def describe_argparser():
 
 
 def prep_argparser(**kwargs):
-    parser = argparse.ArgumentParser(description=describe_argparser()[1], formatter_class=argparse.RawDescriptionHelpFormatter, **kwargs)
+    import pkgutil
+    import re
+    import importlib
+    discovered_docloc_plugins = {
+        name[len('mmif_docloc_'):]: importlib.import_module(name) for _, name, _ in pkgutil.iter_modules() if
+        re.match(r'mmif[-_]docloc[-_]', name)
+    }
+    parser = argparse.ArgumentParser(description=describe_argparser()[1], formatter_class=argparse.RawTextHelpFormatter, **kwargs)
     parser.add_argument(
         'documents',
         default=None,
@@ -255,12 +263,17 @@ def prep_argparser(**kwargs):
         nargs='?',
         help='A name of a file to capture a generated MMIF json. When not given, MMIF is printed to stdout.'
     )
+    scheme_help = 'A scheme to associate with the document location URI. When not given, the default scheme is `file://`.'
+    if len(discovered_docloc_plugins) > 0:
+        plugin_help = [f'"{scheme_name}" ({scheme_plugin.help() if "help" in dir(scheme_plugin) else "help msg not provided by developer"})' 
+                       for scheme_name, scheme_plugin in discovered_docloc_plugins.items()]
+        scheme_help += ' (AVAILABLE ADDITIONAL SCHEMES)  ' + ', '.join(plugin_help)
     parser.add_argument(
         '-s', '--scheme',
         default='file',
         action='store',
         nargs='?',
-        help='A scheme to associate with the document location URI. When not given, the default scheme is `file://`.'
+        help=scheme_help
     )
     return parser
 

clams_python-1.3.0/clams/ver/__init__.py

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

{clams_python-1.2.5 → clams_python-1.3.0/clams_python.egg-info}/PKG-INFO

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

{clams_python-1.2.5 → clams_python-1.3.0}/clams_python.egg-info/requires.txt

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

{clams_python-1.2.5 → clams_python-1.3.0}/requirements.txt

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

{clams_python-1.2.5 → clams_python-1.3.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), 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.5/VERSION

@@ -1 +0,0 @@
-1.2.5

clams_python-1.2.5/clams/ver/__init__.py

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