synapse-sdk 1.0.0a33__tar.gz → 1.0.0a35__tar.gz

{synapse_sdk-1.0.0a33/synapse_sdk.egg-info → synapse_sdk-1.0.0a35}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: synapse-sdk
-Version: 1.0.0a33
+Version: 1.0.0a35
 Summary: synapse sdk
 Author-email: datamaker <developer@datamaker.io>
 License: MIT

synapse_sdk-1.0.0a35/requirements.txt

@@ -0,0 +1,11 @@
+click
+cookiecutter
+requests
+tqdm
+pyyaml
+pydantic
+pyjwt
+python-dotenv
+ray[all]>=2.44.1
+fsspec[gcs,s3,sftp]==2025.3.2
+universal-pathlib==0.2.6

synapse_sdk-1.0.0a35/synapse_sdk/clients/validators/collections.py

@@ -0,0 +1,31 @@
+class FileSpecificationValidator:
+    """File specification validator class for synapse backend collection.
+
+    Args:
+        file_spec_template (list):
+            * List of dictionaries containing file specification template
+            * This is from synapse-backend file specification data.
+        organized_files (list): List of dictionaries containing organized files.
+    """
+
+    def __init__(self, file_spec_template, organized_files):
+        self.file_spec_template = file_spec_template
+        self.organized_files = organized_files
+
+    def validate(self):
+        """Validate the file specification template with organized files.
+
+        Returns:
+            bool: True if the file specification template is valid, False otherwise.
+        """
+        for spec in self.file_spec_template:
+            spec_name = spec['name']
+            is_required = spec['is_required']
+
+            for file_group in self.organized_files:
+                files = file_group['files']
+                if is_required and spec_name not in files:
+                    return False
+                if spec_name in files and not files[spec_name]:
+                    return False
+        return True

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

@@ -0,0 +1,107 @@
+from packaging import version
+
+from synapse_sdk.clients.exceptions import ClientError
+from synapse_sdk.i18n import gettext as _
+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_actor_options(self):
+        options = {'runtime_env': self.get_runtime_env()}
+        for option in ['num_cpus', 'num_gpus']:
+            option_value = self.params.get(option)
+            if option_value:
+                options[option] = option_value
+        return options
+
+    def start(self):
+        from ray import serve
+
+        from synapse_sdk.plugins.categories.neural_net.base.inference import app
+
+        self.ray_init()
+
+        ray_actor_options = self.get_actor_options()
+
+        if self.is_gradio_deployment:
+            from ray.serve.gradio_integrations import GradioServer
+
+            self.assert_gradio_version()
+
+            # GradioIngress differs from serve.ingress(app), thus the difference in self.entrypoint callable
+            try:
+                entrypoint = self.entrypoint().app
+            except (TypeError, ImportError):
+                raise ClientError(
+                    400,
+                    _(
+                        'Gradio app is not callable.'
+                        'Please ensure that your Deployment class defines a callable `app` function'
+                    ),
+                )
+
+            deployment = GradioServer.options(ray_actor_options=ray_actor_options).bind(entrypoint)
+        else:
+            deployment = serve.deployment(ray_actor_options=ray_actor_options)(
+                serve.ingress(app)(self.entrypoint)
+            ).bind(self.envs['SYNAPSE_PLUGIN_RUN_HOST'])
+
+        serve.delete(self.plugin_release.code)
+
+        # TODO add run object
+        serve.run(
+            deployment,
+            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.job_id:
+            try:
+                serve_application = self.ray_client.get_serve_application(self.plugin_release.code)
+                return self.client.create_serve_application({
+                    'job': self.job_id,
+                    'status': serve_application['status'],
+                    'data': serve_application,
+                })
+            except ClientError:
+                pass
+        return None
+
+    @property
+    def is_gradio_deployment(self):
+        return self.config.get('gradio_app', False)
+
+    def assert_gradio_version(self):
+        """Assert gradio version is not greater than 3.50.2.
+        Ray Serve cannot pickle gradio endpoints, thus gradio version greater than 3.50.2 is not supported (SSE Issues)
+        """
+        GRADIO_VERSION_MAX_ALLOWED = '3.50.2'
+
+        gradio_installed = False
+        gradio_version = None
+        for req in self.requirements:
+            if req.startswith('gradio=='):
+                gradio_installed = True
+                gradio_version = req.split('==')[1]
+                break
+
+        assert gradio_installed, _(
+            'Gradio is not installed or version is not specified. Please install gradio==3.50.2 to use this feature.'
+        )
+
+        if version.parse(gradio_version) > version.parse(GRADIO_VERSION_MAX_ALLOWED):
+            raise AssertionError(
+                f'Gradio version {gradio_version} is greater than maximum allowed version {GRADIO_VERSION_MAX_ALLOWED}'
+            )

{synapse_sdk-1.0.0a33 → synapse_sdk-1.0.0a35}/synapse_sdk/plugins/categories/upload/actions/upload.py

@@ -1,4 +1,3 @@
-from enum import Enum
 from typing import Annotated, Dict, List
 
 from pydantic import AfterValidator, BaseModel, field_validator
@@ -6,6 +5,7 @@ from pydantic_core import PydanticCustomError
 
 from synapse_sdk.clients.exceptions import ClientError
 from synapse_sdk.clients.utils import get_batched_list
+from synapse_sdk.clients.validators.collections import FileSpecificationValidator
 from synapse_sdk.i18n import gettext as _
 from synapse_sdk.plugins.categories.base import Action
 from synapse_sdk.plugins.categories.decorators import register_action
@@ -145,7 +145,7 @@ class UploadAction(Action):
 
         # Analyze Collection file specifications to determine the data structure for upload.
         self.run.set_progress(0, 1, category='analyze_collection')
-        file_specification_skeleton = self._analyze_collection()
+        file_specification_template = self._analyze_collection()
         self.run.set_progress(1, 1, category='analyze_collection')
 
         # Setup result dict.
@@ -153,7 +153,7 @@ class UploadAction(Action):
 
         # Organize data according to Collection file specification structure.
         organized_files = uploader.handle_upload_files()
-        if not self._validate_organized_files(file_specification_skeleton, organized_files):
+        if not self._validate_organized_files(file_specification_template, organized_files):
             self.run.log_message('Validate organized files failed.')
             return result
 
@@ -219,9 +219,10 @@ class UploadAction(Action):
         collection = client.get_dataset(collection_id)
         return collection['file_specifications']
 
-    def _validate_organized_files(self, file_specification_skeleton: Dict, organized_files: List) -> bool:
+    def _validate_organized_files(self, file_specification_template: Dict, organized_files: List) -> bool:
         """Validate organized files from Uploader."""
-        return True
+        validator = FileSpecificationValidator(file_specification_template, organized_files)
+        return validator.validate()
 
     def _upload_files(self, organized_files) -> List:
         """Upload files to synapse-backend.

{synapse_sdk-1.0.0a33 → synapse_sdk-1.0.0a35/synapse_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: synapse-sdk
-Version: 1.0.0a33
+Version: 1.0.0a35
 Summary: synapse sdk
 Author-email: datamaker <developer@datamaker.io>
 License: MIT

{synapse_sdk-1.0.0a33 → synapse_sdk-1.0.0a35}/synapse_sdk.egg-info/SOURCES.txt

@@ -56,6 +56,8 @@ synapse_sdk/clients/backend/models.py
 synapse_sdk/clients/ray/__init__.py
 synapse_sdk/clients/ray/core.py
 synapse_sdk/clients/ray/serve.py
+synapse_sdk/clients/validators/__init__.py
+synapse_sdk/clients/validators/collections.py
 synapse_sdk/plugins/__init__.py
 synapse_sdk/plugins/enums.py
 synapse_sdk/plugins/exceptions.py
@@ -148,5 +150,6 @@ tests/__init__.py
 tests/clients/__init__.py
 tests/clients/test_backend_models.py
 tests/clients/test_base_client.py
+tests/clients/test_collection_validators.py
 tests/utils/__init__,py
 tests/utils/test_debug.py

synapse_sdk-1.0.0a35/tests/clients/test_collection_validators.py

@@ -0,0 +1,149 @@
+import pytest
+
+from synapse_sdk.clients.validators.collections import FileSpecificationValidator
+
+
+@pytest.fixture
+def single_image_file_spec_template():
+    return [
+        {
+            'name': 'image_1',
+            'description': '',
+            'file_type': 'image',
+            'file_type_display': '이미지',
+            'configuration': {},
+            'is_sequential': False,
+            'is_required': True,
+            'is_primary': True,
+            'function_type': 'main',
+            'index': 1,
+        }
+    ]
+
+
+@pytest.fixture
+def single_image_organized_files():
+    original_files = []
+    for i in range(1, 21):
+        file_name = f'{i:04d}.jpg'
+        original_files.append({
+            'files': {
+                'image_1': '',
+            },
+            'meta': {
+                'original_file_name': file_name,
+            },
+        })
+    return original_files
+
+
+@pytest.fixture
+def image_and_meta_file_spec_template():
+    return [
+        {
+            'name': 'image_1',
+            'description': '',
+            'file_type': 'image',
+            'file_type_display': '이미지',
+            'configuration': {},
+            'is_sequential': False,
+            'is_required': True,
+            'is_primary': True,
+            'function_type': 'main',
+            'index': 1,
+        },
+        {
+            'name': 'image_2',
+            'description': '',
+            'file_type': 'image',
+            'file_type_display': '이미지',
+            'configuration': {},
+            'is_sequential': False,
+            'is_required': True,
+            'is_primary': True,
+            'function_type': 'main',
+            'index': 2,
+        },
+        {
+            'name': 'meta_1',
+            'description': '',
+            'file_type': 'text',
+            'file_type_display': '텍스트',
+            'configuration': {},
+            'is_sequential': False,
+            'is_required': True,
+            'is_primary': False,
+            'function_type': 'meta',
+            'index': 1,
+        },
+    ]
+
+
+@pytest.fixture
+def image_and_meta_organized_files():
+    original_files = []
+    for i in range(1, 21):  # Create 20 copies
+        image_1_file_name = f'{i:04d}_1.jpg'
+        image_2_file_name = f'{i:04d}_2.jpg'
+        meta_file_name = f'{i:04d}.txt'
+        original_files.append({
+            'files': {
+                'image_1': f'/path/to/{image_1_file_name}',
+                'image_2': f'/path/to/{image_2_file_name}',
+                'meta_1': f'/path/to/{meta_file_name}',
+            },
+            'meta': {
+                'original_file_name': {
+                    'image_1': image_1_file_name,
+                    'image_2': image_2_file_name,
+                    'meta_1': meta_file_name,
+                },
+            },
+        })
+    return original_files
+
+
+@pytest.fixture
+def invalid_image_and_meta_organized_files():
+    original_files = []
+    for i in range(1, 21):  # Create 20 copies
+        image_1_file_name = f'{i:04d}_1.jpg'
+        image_2_file_name = f'{i:04d}_2.jpg'
+        meta_file_name = f'{i:04d}.txt'
+        original_files.append({
+            'files': {
+                'image_invalid_1': f'/path/to/{image_1_file_name}',
+                'image_invalid_2': f'/path/to/{image_2_file_name}',
+                'meta_1': f'/path/to/{meta_file_name}',
+            },
+            'meta': {
+                'original_file_name': {
+                    'image_1': image_1_file_name,
+                    'image_2': image_2_file_name,
+                    'meta_1': meta_file_name,
+                },
+            },
+        })
+    return original_files
+
+
+def test_validate_single_image_file_spec_template(single_image_file_spec_template, single_image_organized_files):
+    validator = FileSpecificationValidator(single_image_file_spec_template, single_image_organized_files)
+
+    assert validator.validate() is True
+
+
+def test_validate_image_and_meta_file_spec_template_success(
+    image_and_meta_file_spec_template, image_and_meta_organized_files
+):
+    validator = FileSpecificationValidator(image_and_meta_file_spec_template, image_and_meta_organized_files)
+
+    assert validator.validate() is True
+
+
+def test_validate_image_and_meta_file_spec_template_failed_with_invalid_organized_files(
+    image_and_meta_file_spec_template, invalid_image_and_meta_organized_files
+):
+    validator = FileSpecificationValidator(image_and_meta_file_spec_template, invalid_image_and_meta_organized_files)
+
+    assert validator.validate() is False

synapse_sdk-1.0.0a33/requirements.txt

@@ -1,11 +0,0 @@
-click
-cookiecutter
-requests
-tqdm
-pyyaml
-pydantic
-pyjwt
-python-dotenv
-ray[all]>=2.43.0
-fsspec[gcs,s3,sftp]==2025.2.0
-universal-pathlib==0.2.6

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

@@ -1,53 +0,0 @@
-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_actor_options(self):
-        options = {'runtime_env': self.get_runtime_env()}
-        for option in ['num_cpus', 'num_gpus']:
-            option_value = self.params.get(option)
-            if option_value:
-                options[option] = option_value
-        return options
-
-    def start(self):
-        from ray import serve
-
-        from synapse_sdk.plugins.categories.neural_net.base.inference import app
-
-        self.ray_init()
-
-        deployment = serve.deployment(ray_actor_options=self.get_actor_options())(serve.ingress(app)(self.entrypoint))
-        serve.delete(self.plugin_release.code)
-
-        # TODO add run object
-        serve.run(
-            deployment.bind(self.envs['SYNAPSE_PLUGIN_RUN_HOST']),
-            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.job_id:
-            try:
-                serve_application = self.ray_client.get_serve_application(self.plugin_release.code)
-                return self.client.create_serve_application({
-                    'job': self.job_id,
-                    'status': serve_application['status'],
-                    'data': serve_application,
-                })
-            except ClientError:
-                pass
-        return None