synapse-sdk 1.0.0a48__py3-none-any.whl → 1.0.0a50__py3-none-any.whl

synapse_sdk/loggers.py

@@ -1,21 +1,48 @@
 import datetime
 import time
+from typing import Any, Dict
 
 from synapse_sdk.clients.exceptions import ClientError
 
 
 class BaseLogger:
+    """Base class for logging progress and events.
+
+    Args:
+        progress_record(dict): Progress record to track the progress of a task.
+        progress_categories: dict | None: List of categories for progress tracking.
+        metrics_categories: dict | None: List of categories for metrics tracking.
+        current_progress_category: str | None: Current progress category.
+        time_begin_per_category(dict): Dictionary to track the start time for each category.
+        metrics_record(dict): Dictionary to record metrics.
+    """
+
     progress_record = {}
+    metrics_record = {}
     progress_categories = None
-    current_category = None
+    metrics_categories = None
+    current_progress_category = None
     time_begin_per_category = {}
 
-    def __init__(self, progress_categories=None):
+    def __init__(self, progress_categories=None, metrics_categories=None):
+        # Setup progress categories
         self.progress_categories = progress_categories
         if progress_categories:
             self.progress_record['categories'] = progress_categories
 
-    def set_progress(self, current, total, category=None):
+        # Setup metrics categories
+        self.metrics_categories = metrics_categories
+        if metrics_categories:
+            self.metrics_record['categories'] = metrics_categories
+
+    def set_progress(self, current: int, total: int, category: str | None = None):
+        """Set progress for plugin run.
+
+        Args:
+            current(int): current progress value
+            total(int): total progress value
+            category(str | None): progress category
+        """
         assert 0 <= current <= total and total > 0
         assert category is not None or 'categories' not in self.progress_record
 
@@ -32,7 +59,7 @@ class BaseLogger:
         current_progress = {'percent': percent, 'time_remaining': time_remaining}
 
         if category:
-            self.current_category = category
+            self.current_progress_category = category
             self.progress_record['categories'][category].update(current_progress)
         else:
             self.progress_record.update(current_progress)
@@ -45,15 +72,15 @@ class BaseLogger:
 
             overall = 0
             for category, category_record in categories.items():
-                if category == self.current_category:
+                if category == self.current_progress_category:
                     break
                 overall += category_record['proportion']
 
-            category_record = categories[self.current_category]
+            category_record = categories[self.current_progress_category]
             category_percent = category_record.get('percent', 0)
             if not category_progress and 'percent' in category_record:
                 category_progress = {
-                    'category': self.current_category,
+                    'category': self.current_progress_category,
                     'percent': category_percent,
                     'time_remaining': category_record.get('time_remaining'),
                 }
@@ -68,6 +95,23 @@ class BaseLogger:
 
         return progress
 
+    def set_metrics(self, value: Dict[Any, Any], category: str):
+        """Set metrics for plugin run.
+
+        * Metrics which are representing the progress of the plugin run should be set in the metrics_record.
+
+        Args:
+            value(Dict[Any, Any]): metrics value
+            category(str): metrics category
+        """
+        assert category is not None and category != '', 'A category argument must be a non-empty string.'
+        assert isinstance(value, dict), f'A value argument must be a dictionary, but got {type(value).__name__}.'
+
+        if 'categories' not in self.metrics_record:
+            self.metrics_record['categories'] = {}
+
+        self.metrics_record['categories'][category] = value
+
     def log(self, action, data, file=None):
         raise NotImplementedError
 
@@ -77,6 +121,10 @@ class ConsoleLogger(BaseLogger):
         super().set_progress(current, total, category=category)
         print(self.get_current_progress())
 
+    def set_metrics(self, value: Dict[Any, Any], category: str):
+        super().set_metrics(value, category)
+        print(self.metrics_record)
+
     def log(self, action, data, file=None):
         print(action, data)
 
@@ -102,6 +150,16 @@ class BackendLogger(BaseLogger):
         except ClientError:
             pass
 
+    def set_metrics(self, value: Dict[Any, Any], category: str):
+        super().set_metrics(value, category)
+        try:
+            metrics_record = {
+                'record': self.metrics_record,
+            }
+            self.client.update_job(self.job_id, data={'metrics_record': metrics_record})
+        except ClientError:
+            pass
+
     def log(self, event, data, file=None):
         print(event, data)
 

synapse_sdk/plugins/categories/base.py

@@ -25,7 +25,8 @@ class Action:
         method (RunMethod): The method to run of the action.
         run_class (Run): The class to run the action.
         params_model (BaseModel): The model to validate the params.
-        progress_categories (List[str]): The categories to update the progress.
+        progress_categories (Dict[str] | None): The categories to update the progress.
+        metrics_categories (Dict[str] | None): The categories to update the metrics.
         params (Dict): The params to run the action.
         plugin_config (Dict): The plugin config.
         plugin_release (PluginRelease): The plugin release.
@@ -48,6 +49,7 @@ class Action:
     run_class = Run
     params_model = None
     progress_categories = None
+    metrics_categories = None
 
     # init 변수
     params = None
@@ -142,6 +144,7 @@ class Action:
         context = {
             'plugin_release': self.plugin_release,
             'progress_categories': self.progress_categories,
+            'metrics_categories': self.metrics_categories,
             'params': self.params,
             'envs': self.envs,
             'debug': self.debug,

synapse_sdk/plugins/categories/export/actions/export.py

@@ -27,6 +27,13 @@ class ExportRun(Run):
         error: str | None = None
         created: str
 
+    class MetricsRecord(BaseModel):
+        """Metrics record model."""
+
+        stand_by: int
+        failed: int
+        success: int
+
     def log_file(
         self, log_type: str, target_id: int, data_file_info: dict, status: ExportStatus, error: str | None = None
     ):
@@ -51,6 +58,16 @@ class ExportRun(Run):
             ).model_dump(),
         )
 
+    def log_metrics(self, record: MetricsRecord, category: str):
+        """Log export metrics.
+
+        Args:
+            record (MetricsRecord): The metrics record to log.
+            category (str): The category of the metrics.
+        """
+        record = self.MetricsRecord.model_validate(record)
+        self.set_metrics(value=record.dict(), category=category)
+
     def export_log_json_file(
         self,
         target_id: int,
@@ -263,6 +280,7 @@ class ExportAction(Action):
             'proportion': 100,
         }
     }
+    metrics_categories = {'data_file', 'original_file'}
 
     def get_filtered_results(self, filters, handler):
         """Get filtered target results."""

synapse_sdk/plugins/categories/export/templates/plugin/export.py

@@ -42,6 +42,8 @@ def export(run, export_items, path_root, **params):
     origin_files_output_path.mkdir(parents=True, exist_ok=True)
 
     total = params['count']
+    original_file_metrics_record = run.MetricsRecord(stand_by=total, success=0, failed=0)
+    data_file_metrics_record = run.MetricsRecord(stand_by=total, success=0, failed=0)
     # progress init
     run.set_progress(0, total, category='dataset_conversion')
     for no, export_item in enumerate(export_items, start=1):
@@ -56,12 +58,30 @@ def export(run, export_items, path_root, **params):
         if save_original_file_flag:
             if no == 1:
                 run.log_message('Saving original file.')
-            save_original_file(run, final_data, origin_files_output_path, errors_original_file_list)
+            original_status = save_original_file(run, final_data, origin_files_output_path, errors_original_file_list)
+
+            original_file_metrics_record.stand_by -= 1
+            if original_status == ExportStatus.FAILED:
+                original_file_metrics_record.failed += 1
+                continue
+            else:
+                original_file_metrics_record.success += 1
+
+        run.log_metrics(record=original_file_metrics_record, category='original_file')
 
         # Extract data as JSON files
         if no == 1:
             run.log_message('Saving json file.')
-        save_as_json(run, final_data, json_output_path, errors_json_file_list)
+        data_status = save_as_json(run, final_data, json_output_path, errors_json_file_list)
+
+        data_file_metrics_record.stand_by -= 1
+        if data_status == ExportStatus.FAILED:
+            data_file_metrics_record.failed += 1
+            continue
+        else:
+            data_file_metrics_record.success += 1
+
+        run.log_metrics(record=data_file_metrics_record, category='data_file')
 
     run.end_log()
 
@@ -89,7 +109,7 @@ def after_convert(data):
     return data
 
 
-def get_original_file_pathlib(files):
+def get_original_file_name(files):
     """Retrieve the original file path from the given file information.
 
     Args:
@@ -97,9 +117,9 @@ def get_original_file_pathlib(files):
                       original file path, metadata, etc.
 
     Returns:
-        pathlib.Path: The original file path extracted from the metadata.
+        file_name (str): The original file name extracted from the file information.
     """
-    return Path(files['meta']['path_original'])
+    return files['file_name_original']
 
 
 def save_original_file(run, result, base_path, error_file_list):
@@ -112,7 +132,7 @@ def save_original_file(run, result, base_path, error_file_list):
         error_file_list (list): A list to store error files.
     """
     file_url = result['files']['url']
-    file_name = get_original_file_pathlib(result['files']).name
+    file_name = get_original_file_name(result['files'])
     response = requests.get(file_url)
     file_info = {'file_name': file_name}
     error_msg = ''
@@ -126,6 +146,7 @@ def save_original_file(run, result, base_path, error_file_list):
         status = ExportStatus.FAILED
 
     run.export_log_original_file(result['id'], file_info, status, error_msg)
+    return status
 
 
 def save_as_json(run, result, base_path, error_file_list):
@@ -138,7 +159,7 @@ def save_as_json(run, result, base_path, error_file_list):
         error_file_list (list): A list to store error files.
     """
     # Default save file name: original file name
-    file_name = get_original_file_pathlib(result['files']).stem
+    file_name = Path(get_original_file_name(result['files'])).stem
     json_data = result['data']
     file_info = {'file_name': f'{file_name}.json'}
     error_msg = ''
@@ -152,3 +173,4 @@ def save_as_json(run, result, base_path, error_file_list):
         status = ExportStatus.FAILED
 
     run.export_log_json_file(result['id'], file_info, status, error_msg)
+    return status

synapse_sdk/plugins/categories/neural_net/actions/train.py

@@ -21,9 +21,9 @@ class TrainRun(Run):
         # TODO validate input via plugin config
         self.log('metric', {'category': category, 'key': key, 'value': value, 'metrics': metrics})
 
-    def log_visualization(self, category, group, image, **meta):
+    def log_visualization(self, category, group, index, image, **meta):
         # TODO validate input via plugin config
-        self.log('visualization', {'category': category, 'group': group, **meta}, file=image)
+        self.log('visualization', {'category': category, 'group': group, 'index': index, **meta}, file=image)
 
 
 class Hyperparameter(BaseModel):

synapse_sdk/plugins/categories/neural_net/actions/tune.py

@@ -22,11 +22,23 @@ class TuneRun(TrainRun):
     checkpoint_output = None
 
 
+class SearchAlgo(BaseModel):
+    name: str
+    points_to_evaluate: Optional[dict] = None
+
+
+class Scheduler(BaseModel):
+    name: str
+    options: Optional[str] = None
+
+
 class TuneConfig(BaseModel):
     mode: Optional[str] = None
     metric: Optional[str] = None
     num_samples: int = 1
     max_concurrent_trials: Optional[int] = None
+    search_alg: Optional[SearchAlgo] = None
+    scheduler: Optional[Scheduler] = None
 
 
 class TuneParams(BaseModel):
@@ -170,8 +182,12 @@ class TuneAction(TrainAction):
             entrypoint = _tune
 
         trainable = tune.with_parameters(entrypoint, run=self.run, dataset=input_dataset, checkpoint=checkpoint)
+
         tune_config = self.params['tune_config']
 
+        tune_config['search_alg'] = self.convert_tune_search_alg(tune_config)
+        tune_config['scheduler'] = self.convert_tune_scheduler(tune_config)
+
         hyperparameter = self.params['hyperparameter']
         param_space = self.convert_tune_params(hyperparameter)
         temp_path = tempfile.TemporaryDirectory()
@@ -230,6 +246,91 @@ class TuneAction(TrainAction):
                 **params,
             })
 
+    @staticmethod
+    def convert_tune_scheduler(tune_config):
+        """
+        Convert YAML hyperparameter configuration to a Ray Tune scheduler.
+
+        Args:
+            tune_config (dict): Hyperparameter configuration.
+
+        Returns:
+            object: Ray Tune scheduler instance.
+        """
+
+        from ray.tune.schedulers import (
+            ASHAScheduler,
+            HyperBandScheduler,
+            MedianStoppingRule,
+            PopulationBasedTraining,
+            FIFOScheduler,
+        )
+
+        if tune_config.get('scheduler') is None:
+            return None
+
+        scheduler_map = {
+            'fifo': FIFOScheduler,
+            'asha': ASHAScheduler,
+            'hyperband': HyperBandScheduler,
+            'pbt': PopulationBasedTraining,
+            'median': MedianStoppingRule,
+        }
+
+        scheduler_type = tune_config['scheduler'].get('name', 'fifo').lower()
+        scheduler_class = scheduler_map.get(scheduler_type, ASHAScheduler)
+
+        # 옵션이 있는 경우 전달하고, 없으면 기본 생성자 호출
+        options = tune_config['scheduler'].get('options')
+
+        # options가 None이거나 빈 딕셔너리가 아닌 경우에만 전달
+        scheduler = scheduler_class(**options) if options else scheduler_class()
+
+        return scheduler
+
+    @staticmethod
+    def convert_tune_search_alg(tune_config):
+        """
+        Convert YAML hyperparameter configuration to Ray Tune search algorithm and scheduler.
+
+        Args:
+            tune_config (dict): Hyperparameter configuration.
+
+        Returns:
+            dict: Ray Tune search algorithm and scheduler
+        """
+
+        if tune_config.get('search_alg') is None:
+            return None
+
+        search_alg_name = tune_config['search_alg']['name'].lower()
+        metric = tune_config['metric']
+        mode = tune_config['mode']
+        points_to_evaluate = tune_config['search_alg'].get('points_to_evaluate', None)
+
+        if search_alg_name == 'axsearch':
+            from ray.tune.search.ax import AxSearch
+
+            search_alg = AxSearch(metric=metric, mode=mode)
+        elif search_alg_name == 'bayesoptsearch':
+            from ray.tune.search.bayesopt import BayesOptSearch
+
+            search_alg = BayesOptSearch(metric=metric, mode=mode)
+        elif search_alg_name == 'hyperoptsearch':
+            from ray.tune.search.hyperopt import HyperOptSearch
+
+            search_alg = HyperOptSearch(metric=metric, mode=mode)
+        elif search_alg_name == 'optunasearch':
+            from ray.tune.search.optuna import OptunaSearch
+
+            search_alg = OptunaSearch(metric=metric, mode=mode)
+        elif search_alg_name == 'basicvariantgenerator':
+            from ray.tune.search.basic_variant import BasicVariantGenerator
+
+            search_alg = BasicVariantGenerator(points_to_evaluate=points_to_evaluate)
+
+        return search_alg
+
     @staticmethod
     def convert_tune_params(param_list):
         """
@@ -243,19 +344,31 @@ class TuneAction(TrainAction):
         """
         from ray import tune
 
+        param_handlers = {
+            'uniform': lambda p: tune.uniform(p['min'], p['max']),
+            'quniform': lambda p: tune.quniform(p['min'], p['max']),
+            'loguniform': lambda p: tune.loguniform(p['min'], p['max'], p['base']),
+            'qloguniform': lambda p: tune.qloguniform(p['min'], p['max'], p['base']),
+            'randn': lambda p: tune.randn(p['mean'], p['sd']),
+            'qrandn': lambda p: tune.qrandn(p['mean'], p['sd']),
+            'randint': lambda p: tune.randint(p['min'], p['max']),
+            'qrandint': lambda p: tune.qrandint(p['min'], p['max']),
+            'lograndint': lambda p: tune.lograndint(p['min'], p['max'], p['base']),
+            'qlograndint': lambda p: tune.qlograndint(p['min'], p['max'], p['base']),
+            'choice': lambda p: tune.choice(p['options']),
+            'grid_search': lambda p: tune.grid_search(p['options']),
+        }
+
         param_space = {}
 
         for param in param_list:
             name = param['name']
             param_type = param['type']
 
-            if param_type == 'loguniform':
-                param_space[name] = tune.loguniform(param['min'], param['max'])
-            elif param_type == 'choice':
-                param_space[name] = tune.choice(param['options'])
-            elif param_type == 'randint':
-                param_space[name] = tune.randint(param['min'], param['max'])
-            # Add more type handlers as needed
+            if param_type in param_handlers:
+                param_space[name] = param_handlers[param_type](param)
+            else:
+                raise ValueError(f'Unknown parameter type: {param_type}')
 
         return param_space
 

synapse_sdk/plugins/categories/neural_net/templates/config.yaml

@@ -5,7 +5,7 @@ readme: README.md
 description: This is plugin_name plugin
 category: neural_net
 tasks:
-  - object_detection
+  - image.object_detection
 data_type: image
 package_manager: uv
 actions:
@@ -19,6 +19,8 @@ actions:
     hyperparameters:
       ui_schema: |
         Dumped FormKit Schema for hyperparameters
+    options:
+      visualize: false # Whether to visualize the training process
   deployment:
     entrypoint: plugin.inference.MockNetInference
   inference:

synapse_sdk/plugins/categories/upload/actions/task_pre_annotation.py

@@ -0,0 +1,100 @@
+from enum import Enum
+from typing import Annotated
+
+from pydantic import AfterValidator, BaseModel, field_validator
+from pydantic_core import PydanticCustomError
+
+from synapse_sdk.clients.exceptions import ClientError
+from synapse_sdk.plugins.categories.decorators import register_action
+from synapse_sdk.plugins.enums import PluginCategory, RunMethod
+from synapse_sdk.plugins.models import Run
+from synapse_sdk.utils.pydantic.validators import non_blank
+
+
+class TaskDataAnnotationType(str, Enum):
+    FILE = 'file'
+    INFERENCE = 'inference'
+
+
+class TaskPreAnnotationRun(Run):
+    pass
+
+
+class TaskPreAnnotationParams(BaseModel):
+    """TaskPreAnnotation action parameters.
+
+    Args:
+        name (str): The name of the action.
+        description (str | None): The description of the action.
+        project (int): The project ID.
+        data_collection (int): The data collection ID.
+        task_data_annotation_type (TaskDataAnnotationType): The type of task data annotation.
+    """
+
+    name: Annotated[str, AfterValidator(non_blank)]
+    description: str | None
+    project: int
+    data_collection: int
+    task_data_annotation_type: TaskDataAnnotationType
+
+    @field_validator('data_collection', mode='before')
+    @classmethod
+    def check_data_collection_exists(cls, value: str, info) -> str:
+        """Validate synapse-backend collection exists."""
+        action = info.context['action']
+        client = action.client
+        try:
+            client.get_dataset(value)
+        except ClientError:
+            raise PydanticCustomError('client_error', 'Error occurred while checking data collection exists.')
+        return value
+
+    @field_validator('project', mode='before')
+    @classmethod
+    def check_project_exists(cls, value: str, info) -> str:
+        """Validate synapse-backend project exists."""
+        if not value:
+            return value
+
+        action = info.context['action']
+        client = action.client
+        try:
+            client.get_project(value)
+        except ClientError:
+            raise PydanticCustomError('client_error', 'Error occurred while checking project exists.')
+        return value
+
+
+@register_action
+class TaskPreAnnotationAction(TaskPreAnnotationRun):
+    """TaskPreAnnotation action class.
+
+    * Annotate data to tasks.
+    """
+
+    name = 'task_pre_annotation'
+    category = PluginCategory.UPLOAD
+    method = RunMethod.JOB
+    run_class = TaskPreAnnotationRun
+    progress_categories = {
+        'generate_tasks': {
+            'proportion': 10,
+        },
+        'annotate_task_data': {
+            'proportion': 90,
+        },
+    }
+
+    def start(self):
+        """Start task_pre_annotation action.
+
+        * Generate tasks.
+        * Annotate data to tasks.
+        """
+        task_pre_annotation = self.get_task_pre_annotation()
+        task_pre_annotation.handle_annotate_data_from_files()
+        return {}
+
+    def get_task_pre_annotation(self):
+        """Get task pre annotation entrypoint."""
+        return self.entrypoint()

synapse_sdk/plugins/categories/upload/actions/upload.py

@@ -105,8 +105,6 @@ class UploadParams(BaseModel):
     storage: int
     collection: int
     project: int | None
-    is_generate_tasks: bool = False
-    is_generate_ground_truths: bool = False
 
     @field_validator('storage', mode='before')
     @classmethod
@@ -165,8 +163,6 @@ class UploadAction(Action):
         analyze_collection: The progress category for the analyze collection process.
         data_file_upload: The progress category for the upload process.
         generate_data_units: The progress category for the generate data units process.
-        generate_tasks: The progress category for the generate tasks process.
-        generate_ground_truths: The progress category for the generate ground truths process.
     """
 
     name = 'upload'
@@ -175,19 +171,13 @@ class UploadAction(Action):
     run_class = UploadRun
     progress_categories = {
         'analyze_collection': {
-            'proportion': 5,
+            'proportion': 10,
         },
         'upload_data_files': {
-            'proportion': 35,
+            'proportion': 50,
         },
         'generate_data_units': {
-            'proportion': 20,
-        },
-        'generate_tasks': {
-            'proportion': 20,
-        },
-        'generate_ground_truths': {
-            'proportion': 20,
+            'proportion': 40,
         },
     }
 
@@ -239,26 +229,6 @@ class UploadAction(Action):
         generated_data_units = self._generate_data_units(uploaded_files, upload_result_count)
         result['generated_data_units_count'] = len(generated_data_units)
 
-        # Setup task with uploaded synapse-backend data units.
-        if not len(generated_data_units):
-            self.run.log_message('No data units were generated.', context=Context.WARNING.value)
-            self.run.end_log()
-            return result
-
-        if self.config['options']['allow_generate_tasks'] and self.params['is_generate_tasks']:
-            generated_tasks = self._generate_tasks(generated_data_units)
-            result['generated_tasks_count'] = len(generated_tasks)
-        else:
-            self.run.log_message('Generating tasks process has passed.')
-
-        # Generate ground truths for the uploaded data.
-        # TODO: Need to add ground truths generation logic later.
-        if self.config['options']['allow_generate_ground_truths'] and self.params['is_generate_ground_truths']:
-            generated_ground_truths = self._generate_ground_truths()
-            result['generated_ground_truths_count'] = len(generated_ground_truths)
-        else:
-            self.run.log_message('Generating ground truths process has passed.')
-
         self.run.end_log()
         return result
 
@@ -343,53 +313,3 @@ class UploadAction(Action):
         self.run.set_progress(upload_result_count, upload_result_count, category='generate_data_units')
 
         return sum(generated_data_units, [])
-
-    def _generate_tasks(self, generated_data_units: List) -> List:
-        """Setup task with uploaded synapse-backend data units.
-
-        TODO: make batch size configurable.
-        """
-        # Initialize progress
-        self.run.set_progress(0, 1, category='generate_tasks')
-        self.run.log_message('Generating tasks with data files...')
-
-        # Prepare batches for processing
-        client = self.run.client
-        project_id = self.params['project']
-        current_progress = 0
-
-        # Generate tasks
-        generated_tasks = []
-        generated_data_units_count = len(generated_data_units)
-        for data_unit in generated_data_units:
-            tasks_data = []
-            task_data = {'project': project_id, 'data_unit': data_unit['id']}
-            tasks_data.append(task_data)
-            if tasks_data:
-                created_tasks = client.create_tasks(tasks_data)
-                created_task_ids = [created_task['id'] for created_task in created_tasks]
-                generated_tasks.append(created_task_ids)
-                for created_task_id in created_task_ids:
-                    self.run.log_task(created_task_id, UploadStatus.SUCCESS)
-
-            self.run.set_progress(current_progress, generated_data_units_count, category='generate_tasks')
-            current_progress += 1
-
-        # Finish progress
-        self.run.log_message('Generating tasks completed')
-        self.run.set_progress(1, 1, category='generate_tasks')
-
-        return sum(generated_tasks, [])
-
-    def _generate_ground_truths(self):
-        """Generate ground truths for the uploaded data.
-
-        TODO: Need to add ground truths generation logic later.
-        """
-        # Initialize progress
-        self.run.set_progress(0, 1, category='generate_ground_truths')
-        self.run.log_message('Generating ground truths...')
-
-        # Finish progress
-        self.run.log_message('Generating ground truths completed')
-        self.run.set_progress(1, 1, category='generate_ground_truths')

synapse_sdk/plugins/categories/upload/templates/config.yaml

@@ -1,8 +1,10 @@
 actions:
   upload:
     entrypoint: plugin.upload.Uploader
-    options:
-      allow_generate_tasks: false
-      allow_generate_ground_truths: false
+    supported_data_type: image # A primary data type of synapse backend collection. (e.g. 'image', 'text', 'video', 'pcd', 'audio')
+    ui_schema: |
+      Dumped FormKit Schema for upload plugin custom options
+  task_pre_annotation:
+    entrypoint: plugin.upload.TaskPreAnnotation
     ui_schema: |
       Dumped FormKit Schema for upload plugin custom options

synapse_sdk/plugins/categories/upload/templates/plugin/task_pre_annotation.py

@@ -0,0 +1,14 @@
+class TaskPreAnnotation:
+    def __init__(self, run, *args, **kwargs):
+        """Initialize the plugin task pre annotation action class.
+
+        Args:
+            run: Plugin run object.
+        """
+        self.run = run
+
+    def handle_annotate_data_from_files(self):
+        pass
+
+    def handle_annotate_data_with_inference(self):
+        pass

synapse_sdk/plugins/models.py

@@ -128,15 +128,11 @@ class Run:
             self.logger = ConsoleLogger(**kwargs)
 
     def set_progress(self, current, total, category=''):
-        """Set progress for plugin run.
-
-        Args:
-            current: current progress value
-            total: total progress value
-            category: progress category
-        """
         self.logger.set_progress(current, total, category)
 
+    def set_metrics(self, value: Dict[Any, Any], category: str):
+        self.logger.set_metrics(value, category)
+
     def log(self, event, data, file=None):
         self.logger.log(event, data, file=file)
 

{synapse_sdk-1.0.0a48.dist-info → synapse_sdk-1.0.0a50.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: synapse-sdk
-Version: 1.0.0a48
+Version: 1.0.0a50
 Summary: synapse sdk
 Author-email: datamaker <developer@datamaker.io>
 License: MIT
@@ -22,6 +22,8 @@ Requires-Dist: fsspec[gcs,s3,sftp]
 Provides-Extra: all
 Requires-Dist: ray[all]; extra == "all"
 Requires-Dist: python-nmap; extra == "all"
+Requires-Dist: hyperopt; extra == "all"
+Requires-Dist: bayesian-optimization==1.4.3; extra == "all"
 Dynamic: license-file
 
 This is the SDK to develop synapse plugins

{synapse_sdk-1.0.0a48.dist-info → synapse_sdk-1.0.0a50.dist-info}/RECORD

@@ -4,7 +4,7 @@ locale/ko/LC_MESSAGES/messages.mo,sha256=7HJEJA0wKlN14xQ5VF4FCNet54tjw6mfWYj3IaB
 locale/ko/LC_MESSAGES/messages.po,sha256=TFii_RbURDH-Du_9ZQf3wNh-2briGk1IqY33-9GKrMU,1126
 synapse_sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 synapse_sdk/i18n.py,sha256=VXMR-Zm_1hTAg9iPk3YZNNq-T1Bhx1J2fEtRT6kyYbg,766
-synapse_sdk/loggers.py,sha256=OSTDDhEAvj8fiAuYNZqsZ9bygGM20sMC5yJ_nOaLDDU,4155
+synapse_sdk/loggers.py,sha256=hi-m5y4x0OcR2Esf7o849fWpdKrzCGOR4AxazbB7ShE,6528
 synapse_sdk/types.py,sha256=khzn8KpgxFdn1SrpbcuX84m_Md1Mz_HIoUoPq8uok40,698
 synapse_sdk/cli/__init__.py,sha256=P-_FXCqb_nTVdQznuHop6kDXF_JuncZpeAmgHiGoILQ,152
 synapse_sdk/cli/alias/__init__.py,sha256=jDy8N_KupVy7n_jKKWhjQOj76-mR-uoVvMoyzObUkuI,405
@@ -44,11 +44,11 @@ synapse_sdk/clients/validators/collections.py,sha256=LtnwvutsScubOUcZ2reGHLCzseX
 synapse_sdk/plugins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 synapse_sdk/plugins/enums.py,sha256=ibixwqA3sCNSriG1jAtL54JQc_Zwo3MufwYUqGhVncc,523
 synapse_sdk/plugins/exceptions.py,sha256=Qs7qODp_RRLO9y2otU2T4ryj5LFwIZODvSIXkAh91u0,691
-synapse_sdk/plugins/models.py,sha256=FI_6Hr4q4hGj-GwHjucOfX4HYsUpraGd2yeuy4FjjC0,4438
+synapse_sdk/plugins/models.py,sha256=QSsF9A3MSbujdKEeVgkt7vpm0LGQYg_9P_T05WVSmCA,4362
 synapse_sdk/plugins/upload.py,sha256=VJOotYMayylOH0lNoAGeGHRkLdhP7jnC_A0rFQMvQpQ,3228
 synapse_sdk/plugins/utils.py,sha256=4_K6jIl0WrsXOEhFp94faMOriSsddOhIiaXcawYYUUA,3300
 synapse_sdk/plugins/categories/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-synapse_sdk/plugins/categories/base.py,sha256=ATI1VjBWm2rimSkNiiCjfZn7FO4x2oltmh81pJJGL0w,10389
+synapse_sdk/plugins/categories/base.py,sha256=akaBeRK23knqyipTohWu5dKNU4WmPJtxRLu9cdV-xOU,10570
 synapse_sdk/plugins/categories/decorators.py,sha256=Gw6T-UHwpCKrSt596X-g2sZbY_Z1zbbogowClj7Pr5Q,518
 synapse_sdk/plugins/categories/registry.py,sha256=KdQR8SUlLT-3kgYzDNWawS1uJnAhrcw2j4zFaTpilRs,636
 synapse_sdk/plugins/categories/templates.py,sha256=FF5FerhkZMeW1YcKLY5cylC0SkWSYdJODA_Qcm4OGYQ,887
@@ -61,21 +61,21 @@ synapse_sdk/plugins/categories/data_validation/templates/plugin/validation.py,sh
 synapse_sdk/plugins/categories/export/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 synapse_sdk/plugins/categories/export/enums.py,sha256=gtyngvQ1DKkos9iKGcbecwTVQQ6sDwbrBPSGPNb5Am0,127
 synapse_sdk/plugins/categories/export/actions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-synapse_sdk/plugins/categories/export/actions/export.py,sha256=xqPB_MufeMP3riaKCbGVFGukV8RdXcg6-zUrkw4t1-A,9922
+synapse_sdk/plugins/categories/export/actions/export.py,sha256=2lIjur8EiwTB9sc16FV8ZaPXFxUtGRPx9hreG_DKLQA,10483
 synapse_sdk/plugins/categories/export/templates/config.yaml,sha256=N7YmnFROb3s3M35SA9nmabyzoSb5O2t2TRPicwFNN2o,56
 synapse_sdk/plugins/categories/export/templates/plugin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-synapse_sdk/plugins/categories/export/templates/plugin/export.py,sha256=UzPOYvH2rwUlTUpMgcbn7mBsenf3hmWytE-eD_cB_9A,5202
+synapse_sdk/plugins/categories/export/templates/plugin/export.py,sha256=zG8mSn7ZGIj8cttWmb7GEPcGgQRbZ97brJCzkuK7RP8,6106
 synapse_sdk/plugins/categories/neural_net/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 synapse_sdk/plugins/categories/neural_net/actions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 synapse_sdk/plugins/categories/neural_net/actions/deployment.py,sha256=y2LrS-pwazqRI5O0q1NUy45NQYsBj6ykbrXnDMs_fqE,1987
 synapse_sdk/plugins/categories/neural_net/actions/gradio.py,sha256=jBkonh0JHRIKFPxv-XBBFM8Da3dSJs-vyJu_KGT73DQ,4508
 synapse_sdk/plugins/categories/neural_net/actions/inference.py,sha256=0a655ELqNVjPFZTJDiw4EUdcMCPGveUEKyoYqpwMFBU,1019
 synapse_sdk/plugins/categories/neural_net/actions/test.py,sha256=JY25eg-Fo6WbgtMkGoo_qNqoaZkp3AQNEypJmeGzEog,320
-synapse_sdk/plugins/categories/neural_net/actions/train.py,sha256=kve6iTCg2kUeavMQTR2JFuoYDu-QWZFFlB58ZICQtdM,5406
-synapse_sdk/plugins/categories/neural_net/actions/tune.py,sha256=XJczlLDF8FOJXA-7TXNZa3npWhMsT0wGqQwYW3w5TDo,9475
+synapse_sdk/plugins/categories/neural_net/actions/train.py,sha256=i406Ar0V74QwdvqI_g_DgHblB_SoGRPMsuwWcxfoeew,5429
+synapse_sdk/plugins/categories/neural_net/actions/tune.py,sha256=UoXVW0KKUEDeHIk5I77KG1AWLSCPAwbmQFLsYwtHenU,13494
 synapse_sdk/plugins/categories/neural_net/base/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 synapse_sdk/plugins/categories/neural_net/base/inference.py,sha256=R5DASI6-5vzsjDOYxqeGGMBjnav5qHF4hNJT8zNUR3I,1097
-synapse_sdk/plugins/categories/neural_net/templates/config.yaml,sha256=uZVuXjIfsd_pTaSKptHeHn1TN2FIiLrvvpkClToc6po,596
+synapse_sdk/plugins/categories/neural_net/templates/config.yaml,sha256=VUCMN1_c6m6VUZqbt2zMwAfdBlusb1SE4TldEbw4498,682
 synapse_sdk/plugins/categories/neural_net/templates/plugin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 synapse_sdk/plugins/categories/neural_net/templates/plugin/inference.py,sha256=InfqKWJYi6sqiUnfPKHC5KYGhxckDaWZNQ202u-uVP4,366
 synapse_sdk/plugins/categories/neural_net/templates/plugin/test.py,sha256=kYyk7l4UtcDUAH4nkdVUGrHHHjxI4p1U13HSLnmGPyE,53
@@ -100,9 +100,11 @@ synapse_sdk/plugins/categories/smart_tool/templates/plugin/__init__.py,sha256=47
 synapse_sdk/plugins/categories/smart_tool/templates/plugin/auto_label.py,sha256=eevNg0nOcYFR4z_L_R-sCvVOYoLWSAH1jwDkAf3YCjY,320
 synapse_sdk/plugins/categories/upload/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 synapse_sdk/plugins/categories/upload/actions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-synapse_sdk/plugins/categories/upload/actions/upload.py,sha256=9DIH4Aw70LxDpfhrpD0MfncE1m9oj-v52FpaChkVEnA,14755
-synapse_sdk/plugins/categories/upload/templates/config.yaml,sha256=PARk7_F5zNqMK6VMXiMtzG16Um9i0-f-tHYa38Nf498,225
+synapse_sdk/plugins/categories/upload/actions/task_pre_annotation.py,sha256=rzHpxz9fOEcp6S_YDkKFoEtfa1ZruawiJSF7yVqaKDA,3017
+synapse_sdk/plugins/categories/upload/actions/upload.py,sha256=3qjuvH28BfMdBK2bOTo-GlqoF24eKPX10hFhha0-GEk,11278
+synapse_sdk/plugins/categories/upload/templates/config.yaml,sha256=1O0kMfkFMGYwnpBcttrlC9bu4xzU9docw2MBOq_Elmo,417
 synapse_sdk/plugins/categories/upload/templates/plugin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+synapse_sdk/plugins/categories/upload/templates/plugin/task_pre_annotation.py,sha256=9XkUZu7USjVjDPufM0NlYmkdKfV7Hf_9v5GN1RgZzS0,350
 synapse_sdk/plugins/categories/upload/templates/plugin/upload.py,sha256=dnK8gy33GjG5ettayawDJv1gM3xCm1K6lM-PfeeTjQw,1163
 synapse_sdk/plugins/templates/cookiecutter.json,sha256=NxOWk9A_v1pO0Ny4IYT9Cj5iiJ16--cIQrGC67QdR0I,396
 synapse_sdk/plugins/templates/hooks/post_gen_project.py,sha256=jqlYkY1O2TxIR-Vh3gnwILYy8k-D39Xx66d2KNQVMCs,147
@@ -134,9 +136,9 @@ synapse_sdk/utils/storage/providers/__init__.py,sha256=x7RGwZryT2FpVxS7fGWryRVpq
 synapse_sdk/utils/storage/providers/gcp.py,sha256=i2BQCu1Kej1If9SuNr2_lEyTcr5M_ncGITZrL0u5wEA,363
 synapse_sdk/utils/storage/providers/s3.py,sha256=W94rQvhGRXti3R4mYP7gmU5pcyCQpGFIBLvxxqLVdRM,2231
 synapse_sdk/utils/storage/providers/sftp.py,sha256=_8s9hf0JXIO21gvm-JVS00FbLsbtvly4c-ETLRax68A,1426
-synapse_sdk-1.0.0a48.dist-info/licenses/LICENSE,sha256=bKzmC5YAg4V1Fhl8OO_tqY8j62hgdncAkN7VrdjmrGk,1101
-synapse_sdk-1.0.0a48.dist-info/METADATA,sha256=d3PEB2-ivG8oy4s1Kbm78h_KPA-kP_5YM3PtqV8vRW0,1203
-synapse_sdk-1.0.0a48.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
-synapse_sdk-1.0.0a48.dist-info/entry_points.txt,sha256=VNptJoGoNJI8yLXfBmhgUefMsmGI0m3-0YoMvrOgbxo,48
-synapse_sdk-1.0.0a48.dist-info/top_level.txt,sha256=ytgJMRK1slVOKUpgcw3LEyHHP7S34J6n_gJzdkcSsw8,12
-synapse_sdk-1.0.0a48.dist-info/RECORD,,
+synapse_sdk-1.0.0a50.dist-info/licenses/LICENSE,sha256=bKzmC5YAg4V1Fhl8OO_tqY8j62hgdncAkN7VrdjmrGk,1101
+synapse_sdk-1.0.0a50.dist-info/METADATA,sha256=ykGGzwz-t_btKYxsEGDVbLbC4gTFsGMfd2pVt1LKZmQ,1303
+synapse_sdk-1.0.0a50.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+synapse_sdk-1.0.0a50.dist-info/entry_points.txt,sha256=VNptJoGoNJI8yLXfBmhgUefMsmGI0m3-0YoMvrOgbxo,48
+synapse_sdk-1.0.0a50.dist-info/top_level.txt,sha256=ytgJMRK1slVOKUpgcw3LEyHHP7S34J6n_gJzdkcSsw8,12
+synapse_sdk-1.0.0a50.dist-info/RECORD,,

{synapse_sdk-1.0.0a48.dist-info → synapse_sdk-1.0.0a50.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (79.0.0)
+Generator: setuptools (80.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any