synapse-sdk 1.0.0a9__tar.gz → 1.0.0a11__tar.gz

{synapse_sdk-1.0.0a9 → synapse_sdk-1.0.0a11}/.github/workflows/pypi-publish.yml

@@ -27,6 +27,10 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install build
+      - name: Compile i18n messages
+        run : |
+          msgfmt locale/ko/LC_MESSAGES/messages.po -o locale/ko/LC_MESSAGES/messages.mo
+          msgfmt locale/en/LC_MESSAGES/messages.po -o locale/en/LC_MESSAGES/messages.mo
       - name: Build package
         run: python -m build
       - name: Store the distribution packages

{synapse_sdk-1.0.0a9 → synapse_sdk-1.0.0a11}/.gitignore

@@ -26,3 +26,6 @@ __pycache__/
 
 # python
 /main.py
+
+*.mo
+messages.pot

{synapse_sdk-1.0.0a9/synapse_sdk.egg-info → synapse_sdk-1.0.0a11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: synapse-sdk
-Version: 1.0.0a9
+Version: 1.0.0a11
 Summary: synapse sdk
 Author-email: datamaker <developer@datamaker.io>
 License: MIT
@@ -20,3 +20,24 @@ Provides-Extra: all
 Requires-Dist: ray[all]; extra == "all"
 
 This is the SDK to develop synapse plugins
+
+
+## Internationalization
+
+### Find Messages
+```bash
+ $ find . -name "*.py" | xargs xgettext -o messages.pot
+```
+
+### Make Messages
+```bash
+ $ msginit -l ko -i messages.pot -o locale/ko/LC_MESSAGES/messages.po
+ $ msginit -l en -i messages.pot -o locale/en/LC_MESSAGES/messages.po
+```
+
+### Compile Messages
+
+```bash
+ $ msgfmt locale/ko/LC_MESSAGES/messages.po -o locale/ko/LC_MESSAGES/messages.mo
+ $ msgfmt locale/en/LC_MESSAGES/messages.po -o locale/en/LC_MESSAGES/messages.mo
+```

synapse_sdk-1.0.0a11/README.md

@@ -0,0 +1,22 @@
+This is the SDK to develop synapse plugins
+
+
+## Internationalization
+
+### Find Messages
+```bash
+ $ find . -name "*.py" | xargs xgettext -o messages.pot
+```
+
+### Make Messages
+```bash
+ $ msginit -l ko -i messages.pot -o locale/ko/LC_MESSAGES/messages.po
+ $ msginit -l en -i messages.pot -o locale/en/LC_MESSAGES/messages.po
+```
+
+### Compile Messages
+
+```bash
+ $ msgfmt locale/ko/LC_MESSAGES/messages.po -o locale/ko/LC_MESSAGES/messages.mo
+ $ msgfmt locale/en/LC_MESSAGES/messages.po -o locale/en/LC_MESSAGES/messages.mo
+```

synapse_sdk-1.0.0a11/locale/en/LC_MESSAGES/messages.po

@@ -0,0 +1,39 @@
+# English translations for PACKAGE package.
+# Copyright (C) 2024 THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+#  <developer@datamaker.io>, 2024.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-11-27 16:15+0900\n"
+"PO-Revision-Date: 2024-11-27 16:17+0900\n"
+"Last-Translator:  <developer@datamaker.io>\n"
+"Language-Team: English\n"
+"Language: en\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: synapse_sdk/utils/debug.py:5
+msgid "hello world from sdk"
+msgstr "hello world from sdk"
+
+#: synapse_sdk/plugins/cli/publish.py:34
+#, python-brace-format
+msgid ""
+"Successfully published \"{plugin_release.name}\" ({plugin_release.code}) to "
+"synapse backend!"
+msgstr ""
+"Successfully published \"{plugin_release.name}\" ({plugin_release.code}) to "
+"synapse backend!"
+
+#: synapse_sdk/plugins/cli/__init__.py:15
+msgid "Debug mode is \"on\""
+msgstr "Debug mode is \"on\""
+
+#: synapse_sdk/plugins/upload.py:62
+msgid "Building {Path(source_path).name}..."
+msgstr "Building {Path(source_path).name}..."

synapse_sdk-1.0.0a11/locale/ko/LC_MESSAGES/messages.po

@@ -0,0 +1,34 @@
+# Korean translations for PACKAGE package.
+# Copyright (C) 2024 THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+#  <developer@datamaker.io>, 2024.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-11-27 17:16+0900\n"
+"PO-Revision-Date: 2024-11-27 17:16+0900\n"
+"Last-Translator:  <developer@datamaker.io>\n"
+"Language-Team: Korean <translation-team-ko@googlegroups.com>\n"
+"Language: ko\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+
+#: synapse_sdk/utils/debug.py:5
+msgid "hello world from sdk"
+msgstr ""
+
+#: synapse_sdk/plugins/cli/publish.py:34
+msgid "Successfully published \"{}\" ({}) to synapse backend!"
+msgstr "Synapse 백엔드에 \"{}\" ({})를 성공적으로 등록되었습니다!"
+
+#: synapse_sdk/plugins/cli/__init__.py:17
+msgid "Debug mode is \"on\""
+msgstr "디버그 모드가 \"켜짐\" 상태입니다"
+
+#: synapse_sdk/plugins/upload.py:63
+msgid "Building {}..."
+msgstr "{} 빌드 중..."

synapse_sdk-1.0.0a11/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["setuptools>=64", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "synapse-sdk"
+authors = [{ name = "datamaker", email = "developer@datamaker.io" }]
+description = "synapse sdk"
+readme = { file = "README.md", content-type = "text/markdown" }
+requires-python = ">=3.11"
+license = { text = "MIT" }
+classifiers = [
+    "Programming Language :: Python :: 3",
+]
+dependencies = [
+    "boto3",
+    "click",
+    "cookiecutter",
+    "requests",
+    "tqdm",
+    "python-dotenv",
+    "pyyaml",
+    "pydantic",
+]
+dynamic = ["version"]
+
+[project.optional-dependencies]
+all = [
+    "ray[all]"
+]
+
+[project.scripts]
+synapse = "synapse_sdk.cli:cli"
+
+[tool.setuptools]
+packages = ["synapse_sdk"]
+
+[tool.setuptools.package-data]
+"synapse_sdk" = ["../locale/**/*"]
+
+[tool.setuptools_scm]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "Q"]
+ignore = ["W191", "E111", "E114", "E117", "D206", "D300", "Q000", "Q001", "Q002", "Q003", "COM812", "COM819", "ISC001", "ISC002"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.format]
+quote-style = "single"
+preview = true

synapse_sdk-1.0.0a11/synapse_sdk/clients/agent/__init__.py

@@ -0,0 +1,51 @@
+from synapse_sdk.clients.agent.core import CoreClientMixin
+from synapse_sdk.clients.agent.ray import RayClientMixin
+from synapse_sdk.clients.agent.service import ServiceClientMixin
+from synapse_sdk.clients.exceptions import ClientError
+
+
+class AgentClient(CoreClientMixin, RayClientMixin, ServiceClientMixin):
+    name = 'Agent'
+    agent_token = None
+    user_token = None
+    tenant = None
+    long_poll_handler = None
+
+    def __init__(self, base_url, agent_token, user_token=None, tenant=None, long_poll_handler=None):
+        super().__init__(base_url)
+        self.agent_token = agent_token
+        self.user_token = user_token
+        self.tenant = tenant
+        self.long_poll_handler = long_poll_handler
+
+    def _get_headers(self):
+        headers = {'Authorization': self.agent_token}
+        if self.user_token:
+            headers['SYNAPSE-User'] = f'Token {self.user_token}'
+        if self.tenant:
+            headers['SYNAPSE-Tenant'] = f'Token {self.tenant}'
+        return headers
+
+    def _request(self, method, path, **kwargs):
+        if self.long_poll_handler:
+            return self._request_long_poll(method, path, **kwargs)
+        return super()._request(method, path, **kwargs)
+
+    def _request_long_poll(self, method, path, **kwargs):
+        headers = self._get_headers()
+
+        if kwargs.get('files'):
+            raise ClientError(400, 'file is not allowed when long polling')
+
+        headers['Content-Type'] = 'application/json'
+
+        request_id = self.long_poll_handler.set_request({'method': method, 'path': path, 'headers': headers, **kwargs})
+        try:
+            response = self.long_poll_handler.get_response(request_id)
+        except TimeoutError:
+            raise ClientError(408, f'{self.name} is not responding')
+
+        if 400 <= response['status'] < 600:
+            raise ClientError(response['status'], response.json() if response['status'] == 400 else response['reason'])
+
+        return response['data']

synapse_sdk-1.0.0a9/synapse_sdk/clients/agent/service.py → synapse_sdk-1.0.0a11/synapse_sdk/clients/agent/ray.py

@@ -1,19 +1,8 @@
 from synapse_sdk.clients.base import BaseClient
+from synapse_sdk.clients.exceptions import ClientError
 
 
-class ServiceClientMixin(BaseClient):
-    def run_plugin_release(self, code, data):
-        path = f'plugin_releases/{code}/run/'
-        return self._post(path, data=data)
-
-    def run_debug_plugin_release(self, data):
-        path = 'plugin_releases/run_debug/'
-        return self._post(path, data=data)
-
-    def create_plugin_release(self, data):
-        path = 'plugin_releases/'
-        return self._post(path, data=data)
-
+class RayClientMixin(BaseClient):
     def get_job(self, pk):
         path = f'jobs/{pk}/'
         return self._get(path)
@@ -27,6 +16,9 @@ class ServiceClientMixin(BaseClient):
         return self._get(path)
 
     def tail_job_logs(self, pk):
+        if self.long_poll_handler:
+            raise ClientError(400, '"tail_job_logs" does not support long polling')
+
         path = f'jobs/{pk}/tail_logs/'
 
         url = self._get_url(path)
@@ -52,3 +44,11 @@ class ServiceClientMixin(BaseClient):
     def list_tasks(self):
         path = 'tasks/'
         return self._get(path)
+
+    def get_serve_application(self, pk):
+        path = f'serve_application/{pk}/'
+        return self._get(path)
+
+    def list_serve_applications(self):
+        path = 'serve_applications/'
+        return self._get(path)

synapse_sdk-1.0.0a11/synapse_sdk/clients/agent/service.py

@@ -0,0 +1,15 @@
+from synapse_sdk.clients.base import BaseClient
+
+
+class ServiceClientMixin(BaseClient):
+    def run_plugin_release(self, code, data):
+        path = f'plugin_releases/{code}/run/'
+        return self._post(path, data=data)
+
+    def run_debug_plugin_release(self, data):
+        path = 'plugin_releases/run_debug/'
+        return self._post(path, data=data)
+
+    def create_plugin_release(self, data):
+        path = 'plugin_releases/'
+        return self._post(path, data=data)

{synapse_sdk-1.0.0a9 → synapse_sdk-1.0.0a11}/synapse_sdk/clients/backend/integration.py

@@ -31,6 +31,10 @@ class IntegrationClientMixin(BaseClient):
         files = {'file': data.pop('file')}
         return self._post(path, data=data, files=files)
 
+    def get_job(self, pk, params=None):
+        path = f'jobs/{pk}/'
+        return self._get(path, params=params)
+
     def list_jobs(self, params=None):
         path = 'jobs/'
         return self._get(path, params=params)

{synapse_sdk-1.0.0a9 → synapse_sdk-1.0.0a11}/synapse_sdk/clients/backend/ml.py

@@ -19,6 +19,10 @@ class MLClientMixin(BaseClient):
         files = {'file': data.pop('file')}
         return self._post(path, data=data, files=files)
 
+    def create_serve_application(self, data):
+        path = 'serve_applications/'
+        return self._post(path, data=data)
+
     def list_ground_truth_events(self, params=None, url_conversion=None, list_all=False):
         path = 'ground_truth_events/'
         url_conversion = get_default_url_conversion(url_conversion, files_fields=['files'])

{synapse_sdk-1.0.0a9 → synapse_sdk-1.0.0a11}/synapse_sdk/clients/base.py

@@ -50,6 +50,9 @@ class BaseClient:
         except requests.ConnectionError:
             raise ClientError(408, f'{self.name} is not responding')
 
+        return self._post_response(response)
+
+    def _post_response(self, response):
         try:
             return response.json()
         except ValueError:

synapse_sdk-1.0.0a11/synapse_sdk/clients/ray/__init__.py

@@ -0,0 +1,6 @@
+from synapse_sdk.clients.ray.core import CoreClientMixin
+from synapse_sdk.clients.ray.serve import ServeClientMixin
+
+
+class RayClient(ServeClientMixin, CoreClientMixin):
+    name = 'Ray'

synapse_sdk-1.0.0a11/synapse_sdk/clients/ray/core.py

@@ -0,0 +1,22 @@
+from synapse_sdk.clients.base import BaseClient
+from synapse_sdk.clients.exceptions import ClientError
+
+
+class CoreClientMixin(BaseClient):
+    def list_nodes(self, params=None):
+        path = 'nodes'
+        response = self._get(path, params=params)
+        if not response['result']:
+            raise ClientError(200, response['msg'])
+        return response['data']['summary']
+
+    def get_node(self, pk, params=None):
+        path = f'nodes/{pk}'
+        response = self._get(path, params=params)['detail']
+
+        if not response['result']:
+            raise ClientError(200, response['msg'])
+
+        if 'agent' not in response['data']:
+            raise ClientError(404, 'Node Not Found')
+        return response['data']

synapse_sdk-1.0.0a11/synapse_sdk/clients/ray/serve.py

@@ -0,0 +1,20 @@
+from synapse_sdk.clients.base import BaseClient
+from synapse_sdk.clients.exceptions import ClientError
+
+
+class ServeClientMixin(BaseClient):
+    def list_serve_applications(self, params=None):
+        path = 'api/serve/applications/'
+        response = self._get(path, params=params)
+        for key, item in response['applications'].items():
+            response['applications'][key]['deployments'] = list(item['deployments'].values())
+        return list(response['applications'].values())
+
+    def get_serve_application(self, pk, params=None):
+        path = 'api/serve/applications/'
+        response = self._get(path, params=params)
+        try:
+            response['applications'][pk]['deployments'] = list(response['applications'][pk]['deployments'].values())
+            return response['applications'][pk]
+        except KeyError:
+            raise ClientError(404, 'Serve Application Not Found')

synapse_sdk-1.0.0a11/synapse_sdk/i18n.py

@@ -0,0 +1,35 @@
+import gettext as _gettext
+import locale
+from pathlib import Path
+
+ASSIGNED_LOCALE = None
+
+
+def set_language(language):
+    ASSIGNED_LOCALE = language  # noqa: F841
+
+
+def get_locale():
+    if ASSIGNED_LOCALE is not None:
+        return ASSIGNED_LOCALE
+
+    system_locale, encoding = locale.getlocale()
+
+    if system_locale is None:
+        system_locale = 'en'
+
+    return system_locale
+
+
+language = get_locale().split('_')[0]
+
+PACKAGE_DIR = Path(__file__).parent
+LOCALE_DIR = PACKAGE_DIR.parent / 'locale'
+
+translation = _gettext.translation('messages', localedir=LOCALE_DIR, languages=[language], fallback=True)
+translation.install()
+
+gettext = translation.gettext
+ngettext = translation.ngettext
+pgettext = translation.pgettext
+npgettext = translation.npgettext

{synapse_sdk-1.0.0a9 → synapse_sdk-1.0.0a11}/synapse_sdk/loggers.py

@@ -99,11 +99,11 @@ class BackendLogger(BaseLogger):
         except ClientError:
             pass
 
-    def log(self, action, data):
-        print(action, data)
+    def log(self, event, data):
+        print(event, data)
 
         log = {
-            'action': action,
+            'event': event,
             'data': data,
             'datetime': datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S.%f'),
             'job': self.job_id,

{synapse_sdk-1.0.0a9 → synapse_sdk-1.0.0a11}/synapse_sdk/plugins/categories/base.py

@@ -8,9 +8,11 @@ import ray
 import requests
 from pydantic import ValidationError
 from ray.dashboard.modules.job.sdk import JobSubmissionClient
+from ray.exceptions import RayTaskError
 
+from synapse_sdk.clients.ray import RayClient
 from synapse_sdk.plugins.enums import RunMethod
-from synapse_sdk.plugins.exceptions import ActionValidationError
+from synapse_sdk.plugins.exceptions import ActionError
 from synapse_sdk.plugins.models import PluginRelease, Run
 from synapse_sdk.plugins.upload import archive_and_upload, build_and_upload, download_and_upload
 from synapse_sdk.utils.module_loading import import_string
@@ -38,6 +40,7 @@ class Action:
     run = None
 
     default_envs = [
+        'RAY_ADDRESS',
         'RAY_DASHBOARD_URL',
         'RAY_SERVE_ADDRESS',
         'SYNAPSE_PLUGIN_STORAGE',
@@ -56,7 +59,7 @@ class Action:
         self.job_id = job_id
         self.direct = direct
         self.debug = debug
-        self.envs = {**envs, **self.get_default_envs()} if envs else self.get_default_envs()
+        self.envs = {**self.get_default_envs(), **envs} if envs else self.get_default_envs()
         self.run = self.get_run()
 
     @cached_property
@@ -71,6 +74,10 @@ class Action:
     def client(self):
         return self.run.client
 
+    @property
+    def ray_client(self):
+        return RayClient(self.envs['RAY_DASHBOARD_URL'])
+
     @property
     def plugin_url(self):
         if self.debug:
@@ -131,10 +138,14 @@ class Action:
             try:
                 self.params_model.model_validate(self.params, context={'action': self})
             except ValidationError as e:
-                raise ActionValidationError({'params': pydantic_to_drf_error(e)})
+                raise ActionError({'params': pydantic_to_drf_error(e)})
 
     def run_action(self):
         self.validate_params()
+
+        if not ray.is_initialized():
+            ray.init(address=self.envs['RAY_ADDRESS'], ignore_reinit_error=True)
+
         if self.direct:
             if self.method == RunMethod.RESTAPI:
                 return self.start_by_restapi()
@@ -171,7 +182,10 @@ class Action:
                 kwargs[param.name] = getattr(self, param.name)
 
         kwargs['direct'] = True
-        return ray.get(run_task.remote(self.category.value, self.name, *args, **kwargs))
+        try:
+            return ray.get(run_task.remote(self.category.value, self.name, *args, **kwargs))
+        except RayTaskError as e:
+            raise ActionError(e.cause)
 
     def start_by_job(self):
         main_options = []
@@ -186,7 +200,7 @@ class Action:
 
         cmd = ' '.join(main_options + options + arguments)
 
-        client = JobSubmissionClient(address=self.envs.get('RAY_DASHBOARD_URL'))
+        client = self.get_job_client()
         return client.submit_job(
             submission_id=self.job_id,
             entrypoint=f'python main.py {cmd}',
@@ -198,10 +212,24 @@ class Action:
         method = self.params.pop('method')
 
         url = self.plugin_release.get_serve_url(self.envs['RAY_SERVE_ADDRESS'], path)
-        response = getattr(requests, method)(url, **self.params)
-        # TODO ok response가 아닌 경우 대응하기
-        return response.json()
+        try:
+            response = getattr(requests, method)(url, **self.params)
+            try:
+                response_body = response.json()
+            except ValueError:
+                response_body = response.text
+            if response.ok:
+                return response_body
+            else:
+                raise ActionError({'status': response.status_code, 'reason': response.reason, 'message': response_body})
+        except requests.ConnectionError:
+            raise ActionError('Unable to connect to serve application')
 
     def post_action_by_job(self, result):
         if self.client:
-            self.client.update_job(self.job_id, data={'result': result})
+            job_client = self.get_job_client()
+            logs = job_client.get_job_logs(self.job_id).split('\n')
+            self.client.update_job(self.job_id, data={'result': result or {}, 'console_logs': logs})
+
+    def get_job_client(self):
+        return JobSubmissionClient(address=self.envs.get('RAY_DASHBOARD_URL'))

synapse_sdk-1.0.0a11/synapse_sdk/plugins/categories/neural_net/actions/deployment.py

@@ -0,0 +1,45 @@
+from ray import serve
+
+from synapse_sdk.clients.exceptions import ClientError
+from synapse_sdk.plugins.categories.base import Action
+from synapse_sdk.plugins.categories.decorators import register_action
+from synapse_sdk.plugins.enums import PluginCategory, RunMethod
+
+
+@register_action
+class DeploymentAction(Action):
+    name = 'deployment'
+    category = PluginCategory.NEURAL_NET
+    method = RunMethod.JOB
+
+    def get_deployment(self):
+        return serve.deployment(ray_actor_options=self.get_actor_options())(self.entrypoint)
+
+    def get_actor_options(self):
+        return {'runtime_env': self.get_runtime_env()}
+
+    def start(self):
+        deployment = self.get_deployment()
+        serve.delete(self.plugin_release.code)
+        # TODO add run object
+        serve.run(deployment.bind(), name=self.plugin_release.code, route_prefix=f'/{self.plugin_release.checksum}')
+
+        # 백엔드에 ServeApplication 추가
+        serve_application = self.create_serve_application()
+        return {'serve_application': serve_application['id'] if serve_application else None}
+
+    def create_serve_application(self):
+        if self.client:
+            try:
+                job = self.client.get_job(self.job_id)
+                serve_application = self.ray_client.get_serve_application(self.plugin_release.code)
+                return self.client.create_serve_application({
+                    'plugin': self.plugin_release.plugin,
+                    'version': self.plugin_release.version,
+                    'agent': job['agent'],
+                    'status': serve_application['status'],
+                    'data': serve_application,
+                })
+            except ClientError:
+                pass
+        return None

{synapse_sdk-1.0.0a9 → synapse_sdk-1.0.0a11}/synapse_sdk/plugins/categories/neural_net/actions/inference.py

@@ -8,3 +8,11 @@ class InferenceAction(Action):
     name = 'inference'
     category = PluginCategory.NEURAL_NET
     method = RunMethod.RESTAPI
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        headers = {'serve_multiplexed_model_id': str(self.params.pop('model'))}
+        if 'headers' in self.params:
+            self.params['headers'].update(headers)
+        else:
+            self.params['headers'] = headers