synapse-sdk 1.0.0b24__py3-none-any.whl → 2025.9.1__py3-none-any.whl

synapse_sdk/clients/agent/ray.py

@@ -295,3 +295,53 @@ class RayClientMixin(BaseClient):
     def delete_serve_application(self, pk):
         path = f'serve_applications/{pk}/'
         return self._delete(path)
+
+    def stop_job(self, pk):
+        """Stop a running job gracefully.
+
+        Uses Ray's stop_job() API to request graceful termination of the job.
+        This preserves job state and allows for potential resubmission later.
+
+        Args:
+            pk (str): Job primary key or identifier. Must be alphanumeric with
+                     optional hyphens/underscores, max 100 characters.
+
+        Returns:
+            dict: Response containing job status and stop details.
+
+        Raises:
+            ClientError:
+                - 400: If pk is empty, contains invalid characters, or too long
+                - 400: If job is already in terminal state (STOPPED, FAILED, etc.)
+                - 404: If job is not found
+                - 503: If connection to Ray cluster fails
+                - 500: If unexpected error occurs during stop
+
+        Usage:
+            >>> # Stop a running job
+            >>> result = client.stop_job('job-12345')
+            >>> print(result['status'])  # Should show 'STOPPING' or similar
+
+            >>> # Handle stop errors
+            >>> try:
+            ...     client.stop_job('job-12345')
+            ... except ClientError as e:
+            ...     print(f"Stop failed: {e}")
+
+        Technical Notes:
+            - Uses Ray's stop_job() API for graceful termination
+            - Validates job state before attempting stop
+            - Maintains consistency with existing SDK patterns
+            - Provides detailed error messages for debugging
+
+        See Also:
+            resume_job: Method for restarting stopped jobs
+        """
+        # Validate inputs using network utilities
+        validated_pk = validate_resource_id(pk, 'job')
+
+        # Build API path for job stop
+        path = f'jobs/{validated_pk}/stop/'
+
+        # Use _post method with empty data to match Ray's API pattern
+        return self._post(path)

synapse_sdk/devtools/docs/docs/api/clients/ray.md

@@ -14,7 +14,7 @@ The `RayClientMixin` provides comprehensive Ray cluster operations, including jo
 
 ## Key Features
 
-- **Job Lifecycle Management**: Create, monitor, and manage Ray jobs
+- **Job Lifecycle Management**: Create, monitor, manage, and stop Ray jobs
 - **Real-time Log Streaming**: WebSocket and HTTP-based log tailing
 - **Node & Task Monitoring**: Monitor cluster resources and task execution
 - **Ray Serve Integration**: Deploy and manage Ray Serve applications
@@ -52,6 +52,11 @@ jobs = client.list_jobs()
 # Get specific job details
 job = client.get_job('job-12345')
 
+# Stop a running job if needed
+if job['status'] == 'RUNNING':
+    result = client.stop_job('job-12345')
+    print(f"Job stop initiated: {result['status']}")
+
 # Stream logs in real-time
 for log_line in client.tail_job_logs('job-12345'):
     print(log_line.strip())
@@ -86,6 +91,22 @@ Get static log entries for a job.
 logs = client.list_job_logs('job-12345')
 ```
 
+### `stop_job(pk)`
+
+Stop a running job gracefully using Ray's stop_job() API.
+
+```python
+# Stop a running job
+result = client.stop_job('job-12345')
+print(f"Stop status: {result['status']}")
+
+# Handle stop errors
+try:
+    client.stop_job('job-12345')
+except ClientError as e:
+    print(f"Stop failed: {e}")
+```
+
 ## Real-time Log Streaming
 
 ### `tail_job_logs(pk, stream_timeout=10, protocol='stream')`
@@ -221,7 +242,7 @@ except ClientError as e:
 
 ### Common Error Codes
 
-- **400**: Invalid parameters (job ID, timeout, protocol)
+- **400**: Invalid parameters (job ID, timeout, protocol) or job already in terminal state
 - **404**: Resource not found (job, node, task, application)
 - **408**: Connection or read timeout
 - **429**: Stream limits exceeded

synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/clients/ray.md

@@ -14,7 +14,7 @@ Apache Ray 클러스터 관리 및 모니터링 기능을 위한 클라이언트
 
 ## 주요 기능
 
-- **Job 라이프사이클 관리**: Ray 작업 생성, 모니터링 및 관리
+- **Job 라이프사이클 관리**: Ray 작업 생성, 모니터링, 관리 및 중지
 - **실시간 로그 스트리밍**: WebSocket 및 HTTP 기반 로그 테일링
 - **노드 및 태스크 모니터링**: 클러스터 리소스 및 태스크 실행 모니터링
 - **Ray Serve 통합**: Ray Serve 애플리케이션 배포 및 관리
@@ -52,6 +52,11 @@ jobs = client.list_jobs()
 # 특정 작업 세부정보 가져오기
 job = client.get_job('job-12345')
 
+# 필요한 경우 실행 중인 작업 중지
+if job['status'] == 'RUNNING':
+    result = client.stop_job('job-12345')
+    print(f"작업 중지 시작: {result['status']}")
+
 # 실시간으로 로그 스트리밍
 for log_line in client.tail_job_logs('job-12345'):
     print(log_line.strip())
@@ -86,6 +91,22 @@ for job in jobs['results']:
 logs = client.list_job_logs('job-12345')
 ```
 
+### `stop_job(pk)`
+
+Ray의 stop_job() API를 사용하여 실행 중인 작업을 정상적으로 중지합니다.
+
+```python
+# 실행 중인 작업 중지
+result = client.stop_job('job-12345')
+print(f"중지 상태: {result['status']}")
+
+# 중지 오류 처리
+try:
+    client.stop_job('job-12345')
+except ClientError as e:
+    print(f"중지 실패: {e}")
+```
+
 ## 실시간 로그 스트리밍
 
 ### `tail_job_logs(pk, stream_timeout=10, protocol='stream')`
@@ -221,7 +242,7 @@ except ClientError as e:
 
 ### 일반적인 오류 코드
 
-- **400**: 잘못된 매개변수 (job ID, timeout, protocol)
+- **400**: 잘못된 매개변수 (job ID, timeout, protocol) 또는 이미 종료 상태인 작업
 - **404**: 리소스를 찾을 수 없음 (job, node, task, application)
 - **408**: 연결 또는 읽기 timeout
 - **429**: 스트림 제한 초과

{synapse_sdk-1.0.0b24.dist-info → synapse_sdk-2025.9.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: synapse-sdk
-Version: 1.0.0b24
+Version: 2025.9.1
 Summary: synapse sdk
 Author-email: datamaker <developer@datamaker.io>
 License: MIT
@@ -25,7 +25,7 @@ Requires-Dist: pillow
 Requires-Dist: websockets
 Requires-Dist: ffmpeg-python==0.2.0
 Provides-Extra: all
-Requires-Dist: ray[all]==2.44.1; extra == "all"
+Requires-Dist: ray[all]==2.49.1; extra == "all"
 Requires-Dist: python-nmap; extra == "all"
 Requires-Dist: hyperopt; extra == "all"
 Requires-Dist: bayesian-optimization==1.4.3; extra == "all"

{synapse_sdk-1.0.0b24.dist-info → synapse_sdk-2025.9.1.dist-info}/RECORD

@@ -29,7 +29,7 @@ synapse_sdk/clients/exceptions.py,sha256=ylv7x10eOp4aA3a48jwonnvqvkiYwzJYXjkVkRT
 synapse_sdk/clients/utils.py,sha256=8pPJTdzHiRPSbZMoQYHAgR2BAMO6u_R_jMV6a2p34iQ,392
 synapse_sdk/clients/agent/__init__.py,sha256=FqYbtzMJdzRfuU2SA-Yxdc0JKmVP1wxH6OlUNmB4lH8,2230
 synapse_sdk/clients/agent/core.py,sha256=aeMSzf8BF7LjVcmHaL8zC7ofBZUff8kIeqkW1xUJ6Sk,745
-synapse_sdk/clients/agent/ray.py,sha256=TfRiFv4QqwvxGAoNY7PmAWa3k6XgZaF1-fmLU-laqeM,12111
+synapse_sdk/clients/agent/ray.py,sha256=xs-X5ObKPbDN23gmDxs2lhI8h6K6iocGk7PAN9hBTjc,13990
 synapse_sdk/clients/agent/service.py,sha256=s7KuPK_DB1nr2VHrigttV1WyFonaGHNrPvU8loRxHcE,478
 synapse_sdk/clients/backend/__init__.py,sha256=9FzjQn0ljRhtdaoG3n38Mdgte7GFwIh4OtEmoqVg2_E,2098
 synapse_sdk/clients/backend/annotation.py,sha256=t9KnSdCJ7NvDRkAOKn4lm5hgoawbLCwIHMeo45QiIlQ,1249
@@ -75,7 +75,7 @@ synapse_sdk/devtools/docs/docs/api/index.md,sha256=l5EA65asRKZpPLKp1agn8jIQjzURz
 synapse_sdk/devtools/docs/docs/api/clients/agent.md,sha256=QbtdFQA-7rZhtnOh9tGSE9tKQQFeYGE7Z7RmxjVJzuw,786
 synapse_sdk/devtools/docs/docs/api/clients/backend.md,sha256=j0NYx82rEiydlMtNQvqkWIXLVHjxckRaZOh-JiVr4LM,1453
 synapse_sdk/devtools/docs/docs/api/clients/base.md,sha256=IxRGjYFI9KjZU3TFkjdWVdw9sgH40WAtOgIPJjORysc,720
-synapse_sdk/devtools/docs/docs/api/clients/ray.md,sha256=mmK694nU10W7c_Z_2PBY_4qvqiL7ADZTP1Ew2CxWVA4,7581
+synapse_sdk/devtools/docs/docs/api/clients/ray.md,sha256=dnrqIT3MeCUnCH-9yUH59RSm46ZUtdRuncpfjFoPMXY,8089
 synapse_sdk/devtools/docs/docs/api/plugins/categories.md,sha256=8zRHyyl3JQ2p0zKU86-nE-NDeWZLMwp0bh8ZF-PSx9M,839
 synapse_sdk/devtools/docs/docs/api/plugins/models.md,sha256=XRMTD2DBilZwmO6AmPhLgdzNfBpcFkAdrBg9mgOMTUs,1060
 synapse_sdk/devtools/docs/docs/api/plugins/utils.md,sha256=39soJ1JLROm_mygR9UWG6XqZ1i5ESmTeZGijrAfUh-o,8389
@@ -117,7 +117,7 @@ synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/ind
 synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/clients/agent.md,sha256=UVllVNexQYmiHAk6dVVvd0MPQt6S9vBcK5Ur-BeLP2M,827
 synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/clients/backend.md,sha256=3XUZv_LYBuFfmY60t-0ZNeH4U61EzHrmI9ggfs7vS_8,1505
 synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/clients/base.md,sha256=cn8B5Py1TQjQc3a1B8wT_UuOGmb9eCk2IrKWSZnPlmA,804
-synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/clients/ray.md,sha256=sVdBRg4g7x0O9bJ0JP1fzzDc74Z9swGl8jDlbpBbCeA,8346
+synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/clients/ray.md,sha256=m7yxYeDMnRdYPrzTPuSk9EHuDRjEMZRY6q-ty4-HmGs,8931
 synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/concepts/index.md,sha256=6o-8H7khfiMhQSXBAvkYpf6jzOEndPje1QAGdlGfskw,843
 synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/examples/index.md,sha256=pMAc1VLUXnHCv2xvvx-GBqVQ1Uh4h-u4nrco5UZ2z-Y,613
 synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/features/index.md,sha256=X0haPkqUY89K5R3LiGLQX9Boh_BpLxUsHA13skTTAp8,1015
@@ -296,9 +296,9 @@ synapse_sdk/utils/storage/providers/gcp.py,sha256=i2BQCu1Kej1If9SuNr2_lEyTcr5M_n
 synapse_sdk/utils/storage/providers/http.py,sha256=2DhIulND47JOnS5ZY7MZUex7Su3peAPksGo1Wwg07L4,5828
 synapse_sdk/utils/storage/providers/s3.py,sha256=ZmqekAvIgcQBdRU-QVJYv1Rlp6VHfXwtbtjTSphua94,2573
 synapse_sdk/utils/storage/providers/sftp.py,sha256=_8s9hf0JXIO21gvm-JVS00FbLsbtvly4c-ETLRax68A,1426
-synapse_sdk-1.0.0b24.dist-info/licenses/LICENSE,sha256=bKzmC5YAg4V1Fhl8OO_tqY8j62hgdncAkN7VrdjmrGk,1101
-synapse_sdk-1.0.0b24.dist-info/METADATA,sha256=tZXjgzMFe1phEDqypqt3HjsxjvYfKS7lm_MfRgcKHNc,3781
-synapse_sdk-1.0.0b24.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-synapse_sdk-1.0.0b24.dist-info/entry_points.txt,sha256=VNptJoGoNJI8yLXfBmhgUefMsmGI0m3-0YoMvrOgbxo,48
-synapse_sdk-1.0.0b24.dist-info/top_level.txt,sha256=ytgJMRK1slVOKUpgcw3LEyHHP7S34J6n_gJzdkcSsw8,12
-synapse_sdk-1.0.0b24.dist-info/RECORD,,
+synapse_sdk-2025.9.1.dist-info/licenses/LICENSE,sha256=bKzmC5YAg4V1Fhl8OO_tqY8j62hgdncAkN7VrdjmrGk,1101
+synapse_sdk-2025.9.1.dist-info/METADATA,sha256=ZIeAof3DTKvJG72NhD8WlTJXhHpkXAZexGaH0i5lFrM,3781
+synapse_sdk-2025.9.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+synapse_sdk-2025.9.1.dist-info/entry_points.txt,sha256=VNptJoGoNJI8yLXfBmhgUefMsmGI0m3-0YoMvrOgbxo,48
+synapse_sdk-2025.9.1.dist-info/top_level.txt,sha256=ytgJMRK1slVOKUpgcw3LEyHHP7S34J6n_gJzdkcSsw8,12
+synapse_sdk-2025.9.1.dist-info/RECORD,,