synapse-sdk 1.0.0a13__py3-none-any.whl → 2025.11.7__py3-none-any.whl

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

@@ -0,0 +1,284 @@
+---
+id: ml-mixin
+title: MLClientMixin
+sidebar_position: 16
+---
+
+# MLClientMixin
+
+Synapse 백엔드를 위한 머신러닝 모델 관리 및 정답 데이터 작업을 제공합니다.
+
+## 개요
+
+`MLClientMixin`은 머신러닝 모델, 정답 데이터셋, 모델 평가 워크플로와 관련된 모든 작업을 처리합니다. 이 믹스인은 `BackendClient`에 자동으로 포함되며 ML 파이프라인 통합을 위한 메서드를 제공합니다.
+
+## 모델 관리
+
+### `list_models(params=None)`
+
+필터링 옵션과 함께 사용 가능한 머신러닝 모델을 나열합니다.
+
+```python
+# 모든 모델 나열
+models = client.list_models()
+for model in models[0]:
+    print(f"모델: {model['name']} (ID: {model['id']})")
+
+# 특정 프로젝트의 모델 나열
+project_models = client.list_models(params={'project': 123})
+
+# 유형별 모델 나열
+classification_models = client.list_models(params={'model_type': 'classification'})
+
+# 활성 모델만 나열
+active_models = client.list_models(params={'is_active': True})
+```
+
+**매개변수:**
+
+- `params` (dict, 선택사항): 필터링 매개변수
+
+**일반적인 필터링 params:**
+
+- `project`: 프로젝트 ID로 필터링
+- `model_type`: 모델 유형으로 필터링 (`classification`, `detection`, `segmentation`)
+- `is_active`: 모델 상태로 필터링
+- `created_after`: 생성 날짜로 필터링
+- `search`: 모델 이름 및 설명에서 텍스트 검색
+
+**반환값:**
+
+- `tuple`: (models_list, total_count)
+
+### `get_model(pk, params=None, url_conversion=None)`
+
+특정 모델에 대한 상세 정보를 가져옵니다.
+
+```python
+# 기본 모델 정보 가져오기
+model = client.get_model(456)
+print(f"모델: {model['name']}")
+print(f"유형: {model['model_type']}")
+print(f"정확도: {model['metrics']['accuracy']}")
+
+# 확장된 메트릭과 함께 모델 가져오기
+model = client.get_model(456, params={'expand': 'metrics'})
+
+# 파일에 대한 사용자 정의 URL 변환과 함께 모델 가져오기
+model = client.get_model(
+    456,
+    url_conversion={'file': lambda url: f"https://cdn.example.com{url}"}
+)
+```
+
+**매개변수:**
+
+- `pk` (int): 모델 ID
+- `params` (dict, 선택사항): 쿼리 매개변수
+- `url_conversion` (dict, 선택사항): 파일 필드에 대한 사용자 정의 URL 변환
+
+**일반적인 params:**
+
+- `expand`: 추가 데이터 포함 (`metrics`, `evaluations`, `versions`)
+- `include_file`: 모델 파일 정보 포함 여부
+
+**반환값:**
+
+- `dict`: 메타데이터와 메트릭을 포함한 완전한 모델 정보
+
+**모델 구조:**
+
+- `id`: 모델 ID
+- `name`: 모델 이름
+- `description`: 모델 설명
+- `model_type`: 모델 유형
+- `file`: 모델 파일 참조
+- `metrics`: 성능 메트릭
+- `project`: 연관된 프로젝트 ID
+- `is_active`: 모델이 현재 활성 상태인지 여부
+- `created_at`: 생성 타임스탬프
+
+### `create_model(data)`
+
+파일 업로드와 함께 새로운 머신러닝 모델을 생성합니다.
+
+```python
+# 파일 업로드와 함께 모델 생성
+model_data = {
+    'name': 'Object Detection Model v2',
+    'description': '향상된 정확도를 가진 개선된 객체 탐지 모델',
+    'model_type': 'detection',
+    'project': 123,
+    'metrics': {
+        'accuracy': 0.92,
+        'precision': 0.89,
+        'recall': 0.94,
+        'f1_score': 0.91
+    },
+    'configuration': {
+        'input_size': [640, 640],
+        'num_classes': 10,
+        'framework': 'pytorch'
+    },
+    'file': '/path/to/model.pkl'  # 청크 업로드를 통해 업로드됨
+}
+
+new_model = client.create_model(model_data)
+print(f"ID {new_model['id']}로 모델 생성됨")
+```
+
+**매개변수:**
+
+- `data` (dict): 모델 구성 및 메타데이터
+
+**모델 데이터 구조:**
+
+- `name` (str, 필수): 모델 이름
+- `description` (str): 모델 설명
+- `model_type` (str, 필수): 모델 유형
+- `project` (int, 필수): 프로젝트 ID
+- `file` (str, 필수): 모델 파일 경로
+- `metrics` (dict): 성능 메트릭
+- `configuration` (dict): 모델 구성
+- `is_active` (bool): 모델이 활성 상태여야 하는지 여부
+
+**반환값:**
+
+- `dict`: 생성된 ID가 포함된 생성된 모델
+
+**참고:** 모델 파일은 최적 성능을 위해 청크 업로드를 사용하여 자동으로 업로드됩니다.
+
+## 정답 데이터 작업
+
+### `list_ground_truth_events(params=None, url_conversion=None, list_all=False)`
+
+포괄적인 필터링 옵션과 함께 정답 이벤트를 나열합니다.
+
+```python
+# 데이터셋 버전의 정답 이벤트 나열
+events = client.list_ground_truth_events(params={
+    'ground_truth_dataset_versions': [123]
+})
+
+# 모든 이벤트 나열 (페이지네이션 자동 처리)
+all_events = client.list_ground_truth_events(list_all=True)
+
+# 날짜 필터링과 함께 이벤트 나열
+from datetime import datetime, timedelta
+recent_date = (datetime.now() - timedelta(days=30)).isoformat()
+recent_events = client.list_ground_truth_events(params={
+    'created_after': recent_date,
+    'ground_truth_dataset_versions': [123]
+})
+
+# 사용자 정의 URL 변환과 함께 이벤트 나열
+events = client.list_ground_truth_events(
+    params={'ground_truth_dataset_versions': [123]},
+    url_conversion={'files': lambda url: f"https://cdn.example.com{url}"}
+)
+```
+
+**매개변수:**
+
+- `params` (dict, 선택사항): 필터링 매개변수
+- `url_conversion` (dict, 선택사항): 파일 필드에 대한 사용자 정의 URL 변환
+- `list_all` (bool): True인 경우, 페이지네이션을 자동 처리
+
+**일반적인 필터링 params:**
+
+- `ground_truth_dataset_versions`: 데이터셋 버전 ID 목록
+- `project`: 프로젝트 ID로 필터링
+- `created_after`: 생성 날짜로 필터링
+- `data_type`: 데이터 유형으로 필터링
+- `search`: 이벤트 데이터에서 텍스트 검색
+
+**반환값:**
+
+- `tuple`: `list_all=False`인 경우 (events_list, total_count)
+- `list`: `list_all=True`인 경우 모든 이벤트
+
+**정답 이벤트 구조:**
+
+- `id`: 이벤트 ID
+- `data`: 어노테이션/정답 데이터
+- `data_unit`: 연관된 데이터 유닛 정보
+- `ground_truth_dataset_version`: 데이터셋 버전 ID
+- `created_at`: 생성 타임스탬프
+- `metadata`: 추가 이벤트 메타데이터
+
+### `get_ground_truth_version(pk)`
+
+정답 데이터셋 버전에 대한 상세 정보를 가져옵니다.
+
+```python
+version = client.get_ground_truth_version(123)
+print(f"데이터셋 버전: {version['version']}")
+print(f"데이터셋: {version['ground_truth_dataset']['name']}")
+print(f"총 이벤트: {version['event_count']}")
+print(f"생성됨: {version['created_at']}")
+```
+
+**매개변수:**
+
+- `pk` (int): 정답 데이터셋 버전 ID
+
+**반환값:**
+
+- `dict`: 완전한 데이터셋 버전 정보
+
+**데이터셋 버전 구조:**
+
+- `id`: 버전 ID
+- `version`: 버전 번호/이름
+- `ground_truth_dataset`: 부모 데이터셋 정보
+- `event_count`: 이 버전의 이벤트 수
+- `description`: 버전 설명
+- `is_active`: 버전이 현재 활성 상태인지 여부
+- `created_at`: 생성 타임스탬프
+- `statistics`: 버전 통계 및 메트릭
+
+## 오류 처리
+
+```python
+from synapse_sdk.clients.exceptions import ClientError
+
+def robust_model_operations():
+    """오류 처리가 있는 안정적인 모델 작업 예제."""
+
+    try:
+        # 모델 가져오기 시도
+        model = client.get_model(999)
+    except ClientError as e:
+        if e.status_code == 404:
+            print("모델을 찾을 수 없음")
+            return None
+        else:
+            print(f"모델 가져오기 오류: {e}")
+            raise
+
+    try:
+        # 모델 생성 시도
+        model_data = {
+            'name': 'Test Model',
+            'model_type': 'classification',
+            'project': 123,
+            'file': '/path/to/model.pkl'
+        }
+        new_model = client.create_model(model_data)
+    except ClientError as e:
+        if e.status_code == 400:
+            print(f"잘못된 모델 데이터: {e.response}")
+        elif e.status_code == 413:
+            print("모델 파일이 너무 큼")
+        else:
+            print(f"모델 생성 오류: {e}")
+        return None
+
+    return new_model
+```
+
+## 참고
+
+- [BackendClient](./backend.md) - 메인 백엔드 클라이언트
+- [DataCollectionClientMixin](./data-collection-mixin.md) - 데이터 관리 작업
+- [IntegrationClientMixin](./integration-mixin.md) - 플러그인 및 작업 관리

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

@@ -0,0 +1,342 @@
+---
+id: ray
+title: RayClient
+sidebar_position: 4
+---
+
+# RayClient
+
+Apache Ray 클러스터 관리 및 모니터링 기능을 위한 클라이언트입니다.
+
+## 개요
+
+`RayClientMixin`은 작업 관리, 실시간 로그 스트리밍, 노드 모니터링, Ray Serve 애플리케이션 제어를 포함한 포괄적인 Ray 클러스터 작업을 제공합니다. Ray 전용 기능으로 `BaseClient`를 확장하는 mixin 클래스로 설계되었습니다.
+
+## 주요 기능
+
+- **Job 라이프사이클 관리**: Ray 작업 생성, 모니터링, 관리 및 중지
+- **실시간 로그 스트리밍**: WebSocket 및 HTTP 기반 로그 테일링
+- **노드 및 태스크 모니터링**: 클러스터 리소스 및 태스크 실행 모니터링
+- **Ray Serve 통합**: Ray Serve 애플리케이션 배포 및 관리
+- **강력한 오류 처리**: 입력 유효성 검사 및 정제된 오류 메시지
+- **리소스 관리**: 자동 정리 및 연결 추적
+
+## Constructor
+
+```python
+# RayClientMixin은 일반적으로 mixin으로 사용됩니다
+class RayClient(RayClientMixin):
+    def __init__(self, base_url: str, timeout: dict = None):
+        super().__init__(base_url, timeout)
+```
+
+### Parameters
+
+- `base_url` (str): Ray 클러스터 대시보드 URL (예: "http://ray-head:8265")
+- `timeout` (dict, 선택사항): 연결 및 읽기 timeout 설정
+
+## 사용법
+
+```python
+from synapse_sdk.clients.agent.ray import RayClientMixin
+from synapse_sdk.clients.base import BaseClient
+
+class RayClient(RayClientMixin, BaseClient):
+    pass
+
+client = RayClient(base_url="http://ray-head:8265")
+
+# 모든 작업 나열
+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())
+```
+
+## Job 작업
+
+### `get_job(pk)`
+
+특정 작업에 대한 세부정보를 검색합니다.
+
+```python
+job = client.get_job('job-12345')
+print(f"Job 상태: {job['status']}")
+```
+
+### `list_jobs()`
+
+Ray 클러스터의 모든 작업을 나열합니다.
+
+```python
+jobs = client.list_jobs()
+for job in jobs['results']:
+    print(f"Job {job['id']}: {job['status']}")
+```
+
+### `list_job_logs(pk)`
+
+작업에 대한 정적 로그 항목을 가져옵니다.
+
+```python
+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')`
+
+WebSocket 또는 HTTP 프로토콜을 사용하여 작업 로그를 스트리밍합니다.
+
+```python
+# HTTP 스트리밍 (기본값, 호환성 높음)
+for log_line in client.tail_job_logs('job-12345', protocol='stream'):
+    print(log_line.strip())
+
+# WebSocket 스트리밍 (낮은 지연시간)
+for log_line in client.tail_job_logs('job-12345', protocol='websocket'):
+    print(log_line.strip())
+
+# 사용자 정의 timeout으로
+for log_line in client.tail_job_logs('job-12345', stream_timeout=30):
+    if 'ERROR' in log_line:
+        break
+```
+
+### `websocket_tail_job_logs(pk, stream_timeout=10)`
+
+가장 낮은 지연시간을 위해 WebSocket을 통해 로그를 스트리밍합니다.
+
+```python
+try:
+    for log_line in client.websocket_tail_job_logs('job-12345'):
+        print(log_line.strip())
+        if 'COMPLETED' in log_line:
+            break
+except ClientError as e:
+    print(f"WebSocket 스트리밍 실패: {e}")
+```
+
+### `stream_tail_job_logs(pk, stream_timeout=10)`
+
+HTTP chunked transfer encoding을 통해 로그를 스트리밍합니다.
+
+```python
+for log_line in client.stream_tail_job_logs('job-12345', stream_timeout=60):
+    if 'FAILED' in log_line:
+        print(f"Job 실패: {log_line}")
+        break
+```
+
+## 노드 작업
+
+### `get_node(pk)`
+
+특정 클러스터 노드에 대한 세부정보를 가져옵니다.
+
+```python
+node = client.get_node('node-abc123')
+print(f"노드 상태: {node['alive']}")
+```
+
+### `list_nodes()`
+
+Ray 클러스터의 모든 노드를 나열합니다.
+
+```python
+nodes = client.list_nodes()
+for node in nodes['results']:
+    print(f"노드 {node['node_id']}: {node['state']}")
+```
+
+## 태스크 작업
+
+### `get_task(pk)`
+
+특정 태스크에 대한 세부정보를 검색합니다.
+
+```python
+task = client.get_task('task-xyz789')
+```
+
+### `list_tasks()`
+
+클러스터의 모든 태스크를 나열합니다.
+
+```python
+tasks = client.list_tasks()
+```
+
+## Ray Serve 작업
+
+### `get_serve_application(pk)`
+
+Ray Serve 애플리케이션에 대한 세부정보를 가져옵니다.
+
+```python
+app = client.get_serve_application('app-123')
+print(f"애플리케이션 상태: {app['status']}")
+```
+
+### `list_serve_applications()`
+
+모든 Ray Serve 애플리케이션을 나열합니다.
+
+```python
+apps = client.list_serve_applications()
+```
+
+### `delete_serve_application(pk)`
+
+Ray Serve 애플리케이션을 삭제합니다.
+
+```python
+client.delete_serve_application('app-123')
+```
+
+## 오류 처리
+
+모든 메서드에는 특정 `ClientError` 예외와 함께 강력한 오류 처리가 포함됩니다:
+
+```python
+from synapse_sdk.clients.exceptions import ClientError
+
+try:
+    for log_line in client.tail_job_logs('invalid-job'):
+        print(log_line)
+except ClientError as e:
+    if e.status == 400:
+        print("잘못된 작업 ID 또는 매개변수")
+    elif e.status == 404:
+        print("작업을 찾을 수 없음")
+    elif e.status == 503:
+        print("Ray 클러스터 연결 실패")
+    else:
+        print(f"예상치 못한 오류: {e}")
+```
+
+### 일반적인 오류 코드
+
+- **400**: 잘못된 매개변수 (job ID, timeout, protocol) 또는 이미 종료 상태인 작업
+- **404**: 리소스를 찾을 수 없음 (job, node, task, application)
+- **408**: 연결 또는 읽기 timeout
+- **429**: 스트림 제한 초과
+- **500**: WebSocket 라이브러리 사용 불가 또는 내부 오류
+- **503**: Ray 클러스터 연결 실패
+
+## 리소스 관리
+
+RayClient에는 자동 리소스 관리가 포함됩니다:
+
+- **Thread Pool**: 동시 작업을 위한 5개 작업자 스레드
+- **연결 추적**: 활성 연결을 위한 WeakSet
+- **스트림 제한**: 메모리 고갈 방지
+- **자동 정리**: 소멸 시 리소스 정리
+
+### 스트림 제한
+
+로그 스트리밍을 위한 기본 제한:
+
+- 최대 메시지: 10,000
+- 최대 라인: 50,000
+- 최대 바이트: 50MB
+- 최대 메시지 크기: 10KB
+- Queue 크기: 1,000
+
+## 모범 사례
+
+### 1. 프로토콜 선택
+
+```python
+# 사용 가능한 경우 가장 낮은 지연시간을 위해 WebSocket 사용
+try:
+    logs = client.tail_job_logs(job_id, protocol='websocket')
+except ClientError:
+    # HTTP 스트리밍으로 폴백
+    logs = client.tail_job_logs(job_id, protocol='stream')
+```
+
+### 2. Timeout 관리
+
+```python
+# 장기 실행 작업에 적절한 timeout 사용
+for log_line in client.tail_job_logs(job_id, stream_timeout=300):
+    process_log_line(log_line)
+```
+
+### 3. 오류 복구
+
+```python
+import time
+
+def robust_log_streaming(client, job_id, max_retries=3):
+    for attempt in range(max_retries):
+        try:
+            for log_line in client.tail_job_logs(job_id):
+                yield log_line
+            break
+        except ClientError as e:
+            if e.status == 503 and attempt < max_retries - 1:
+                time.sleep(2 ** attempt)  # 지수 백오프
+                continue
+            raise
+```
+
+### 4. 리소스 정리
+
+```python
+# 적절한 정리를 위한 컨텍스트 매니저
+class RayClientContext:
+    def __init__(self, base_url):
+        self.client = RayClient(base_url)
+
+    def __enter__(self):
+        return self.client
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        # RayClient.__del__()에 의해 자동으로 정리 처리
+        pass
+
+with RayClientContext("http://ray-head:8265") as client:
+    for log_line in client.tail_job_logs('job-12345'):
+        print(log_line.strip())
+```
+
+## 스레드 안전성
+
+RayClient는 적절한 스레드 안전 메커니즘을 통해 동시 사용을 위해 설계되었습니다:
+
+- 백그라운드 작업을 위한 스레드 풀
+- 연결 추적을 위한 WeakSet
+- 적절한 리소스 정리 메커니즘
+
+## 참고
+
+- [AgentClient](./agent.md) - Agent 전용 작업을 위한 클라이언트
+- [BaseClient](./base.md) - 기본 클라이언트 구현
+- [Network Utilities](../../features/utils/network.md) - 스트리밍 및 유효성 검사 유틸리티

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

@@ -0,0 +1,52 @@
+---
+id: index
+title: API 참조
+sidebar_position: 1
+---
+
+# API 참조
+
+Synapse SDK 클래스 및 함수에 대한 완전한 참조 문서입니다.
+
+## 개요
+
+Synapse SDK API는 다음 주요 모듈로 구성됩니다:
+
+### [클라이언트](./clients/backend.md)
+백엔드 서비스 및 에이전트와 상호작용하기 위한 클라이언트 클래스들.
+
+- **[BackendClient](./clients/backend.md)** - 백엔드 작업을 위한 메인 클라이언트
+- **[AgentClient](./clients/agent.md)** - 에이전트 특정 작업을 위한 클라이언트
+- **[RayClient](./clients/ray.md)** - Ray 클러스터 관리 및 모니터링을 위한 클라이언트
+- **[BaseClient](./clients/base.md)** - 모든 클라이언트의 기본 클래스
+
+핵심 플러그인 시스템 컴포넌트들.
+
+### [유틸리티](../features/utils/file.md)
+도우미 함수 및 유틸리티들.
+
+- **[파일 유틸](../features/utils/file.md)** - 파일 작업 및 처리
+- **[네트워크](../features/utils/network.md)** - 스트리밍, 검증 및 연결 관리
+- **[스토리지](../features/utils/storage.md)** - 스토리지 제공자들 (S3, GCS, SFTP)
+- **[타입](../features/utils/types.md)** - 커스텀 타입 및 필드
+
+## 빠른 참조
+
+### 클라이언트 생성
+
+```python
+from synapse_sdk.clients.backend import BackendClient
+
+client = BackendClient(
+    base_url="https://api.synapse.sh",
+    api_token="your-api-token"
+)
+```
+
+### 플러그인 실행
+
+### 플러그인 액션 생성
+
+## 타입 어노테이션
+
+## 파일 처리