synapse-sdk 1.0.0b13__py3-none-any.whl → 1.0.0b14__py3-none-any.whl

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

@@ -0,0 +1,29 @@
+---
+id: index
+title: Examples
+sidebar_position: 1
+---
+
+# Examples
+
+Synapse SDK 사용을 위한 실용적인 예제 및 튜토리얼입니다.
+
+## 시작하기 예제
+
+빠르게 시작할 수 있도록 도움을 주는 기본 예제입니다.
+
+## 플러그인 예제
+
+다양한 사용 사례에 대한 실제 플러그인 예제입니다.
+
+## 통합 예제
+
+Synapse SDK를 다른 도구 및 서비스와 통합하는 예제입니다.
+
+## 고급 예제
+
+복잡한 워크플로우 및 고급 사용 패턴입니다.
+
+## 코드 샘플
+
+일반적인 작업을 위한 즉시 사용 가능한 코드 스니펫입니다.

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

@@ -0,0 +1,179 @@
+---
+id: faq
+title: 자주 묻는 질문
+sidebar_position: 9
+---
+
+# 자주 묻는 질문
+
+Synapse SDK에 대한 일반적인 질문과 답변입니다.
+
+## 설치 및 설정
+
+### Q: 지원되는 Python 버전은 무엇인가요?
+
+Synapse SDK는 **Python 3.10 이상**이 필요합니다.
+
+```bash
+pip install "synapse-sdk[all,devtools]"
+```
+
+### Q: 로컬 개발을 위해 code-server를 어떻게 설치하나요?
+
+여러 가지 옵션이 있습니다:
+
+```bash
+# 권장: 설치 스크립트
+curl -fsSL https://code-server.dev/install.sh | sh
+
+# npm 사용
+npm install -g code-server
+
+# yarn 사용
+yarn global add code-server
+```
+
+더 많은 설치 방법은 다음을 참조하세요: [code-server 설치 가이드](https://coder.com/docs/code-server/latest/install)
+
+## CLI 사용
+
+### Q: Synapse CLI를 어떻게 시작하나요?
+
+간단히 실행하세요:
+
+```bash
+synapse
+```
+
+이것은 모든 Synapse 기능에 액세스할 수 있는 대화형 메뉴를 엽니다.
+
+### Q: Agent와 로컬 code-server의 차이점은 무엇인가요?
+
+- **Agent Code-Server**: 프로젝트 파일이 동기화된 원격 Agent에서 실행됩니다. 플러그인 암호화 및 보안 전송이 포함됩니다.
+- **로컬 Code-Server**: 로컬 머신에서 실행됩니다. 더 빠른 시작, 로컬 환경 및 설정을 사용합니다.
+
+### Q: code-server 포트를 어떻게 설정하나요?
+
+Code-server 포트는 `~/.config/code-server/config.yaml`에서 자동으로 감지됩니다. 설정이 없으면 포트 8070을 기본값으로 사용합니다.
+
+예제 설정:
+
+```yaml
+bind-addr: 127.0.0.1:8070
+auth: password
+password: your-password-here
+cert: false
+```
+
+### Q: Agent 작업공간 경로가 로컬 경로와 다른 이유는 무엇인가요?
+
+Agent는 로컬 프로젝트가 `/home/coder/workspace`에 마운트되는 컨테이너화된 환경에서 실행됩니다. 이는 정상적이며 다양한 개발 환경에서 일관된 경로를 보장합니다.
+
+## Code-Server 문제 해결
+
+### Q: Code-server에서 "사용 불가능" 오류가 표시됩니다
+
+이는 일반적으로 다음을 의미합니다:
+
+1. Agent에 code-server 지원이 활성화되어 있지 않음
+2. 네트워크 연결 문제
+3. Agent가 적절히 설정되지 않음
+
+**해결방법**: code-server 지원으로 Agent를 재설치하거나 Agent 설정을 확인하세요.
+
+### Q: 브라우저가 자동으로 열리지 않습니다
+
+이는 헤드리스 환경이나 디스플레이를 사용할 수 없을 때 발생합니다.
+
+**해결방법**: 제공된 URL(`?folder=` 매개변수 포함)을 브라우저에 수동으로 복사하세요.
+
+### Q: 작업공간에서 플러그인이 감지되지 않습니다
+
+**해결방법**: 디렉토리에 플러그인 메타데이터가 포함된 유효한 `config.yaml` 파일이 있는지 확인하세요:
+
+```yaml
+name: my-plugin
+version: 1.0.0
+description: My awesome plugin
+entry_point: main.py
+```
+
+### Q: 플러그인 암호화는 어떻게 작동하나요?
+
+Agent로 code-server를 열 때 Synapse는:
+
+1. 작업공간에 플러그인이 포함되어 있는지 감지
+2. 플러그인 파일의 ZIP 아카이브 생성
+3. AES-256 암호화를 사용하여 아카이브 암호화
+4. Agent로 안전하게 전송
+5. Agent 작업공간에서 암호 해제 및 추출
+
+이렇게 하면 전송 중 플러그인 코드가 보호됩니다.
+
+## 설정
+
+### Q: 설정 파일은 어디에 저장되나요?
+
+- **Synapse 설정**: `~/.synapse/devtools.yaml`
+- **Code-Server 설정**: `~/.config/code-server/config.yaml`
+
+### Q: 설정을 어떻게 재설정하나요?
+
+```bash
+# 설정 파일 제거
+rm ~/.synapse/devtools.yaml
+rm ~/.config/code-server/config.yaml
+
+# 설정 마법사 실행
+synapse config
+```
+
+### Q: "유효하지 않은 토큰 (401)" 오류가 발생하면 어떻게 하나요?
+
+이는 API 토큰이 만료되었거나 유효하지 않음을 의미합니다.
+
+**해결방법**:
+
+1. Synapse 백엔드에서 새 토큰 생성
+2. `synapse config`를 실행하여 토큰 업데이트
+3. `synapse --dev-tools`로 연결 테스트
+
+## 플러그인 개발
+
+### Q: 새 플러그인을 어떻게 생성하나요?
+
+대화형 플러그인 생성기를 사용하세요:
+
+```bash
+synapse
+# "🔌 Plugin Management" → "Create new plugin" 선택
+```
+
+이것은 예제와 문서가 포함된 완전한 플러그인 구조를 생성합니다.
+
+### Q: 플러그인을 로컬에서 어떻게 테스트하나요?
+
+```bash
+# 로컬 스크립트 실행으로 테스트
+synapse plugin run my_action '{"param": "value"}' --run-by script
+
+# Agent 실행으로 테스트
+synapse plugin run my_action '{"param": "value"}' --run-by agent
+```
+
+게시하기 전에 항상 로컬에서 테스트하여 플러그인이 올바르게 작동하는지 확인하세요.
+
+### Q: 플러그인 게시가 오류와 함께 실패합니다
+
+일반적인 문제:
+
+1. **누락된 의존성**: `requirements.txt`에 필요한 모든 패키지가 포함되어 있는지 확인
+2. **구문 오류**: 먼저 `--run-by script`로 로컬 테스트
+3. **설정 오류**: `config.yaml` 형식과 필수 필드 확인
+4. **백엔드 연결**: 백엔드에 액세스할 수 있고 토큰이 유효한지 확인
+
+**해결방법**: 자세한 오류 정보를 위해 디버그 모드를 사용하세요:
+
+```bash
+synapse plugin publish --debug
+```

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

@@ -0,0 +1,30 @@
+---
+id: converters
+title: 변환기
+sidebar_position: 1
+---
+
+# 변환기
+
+Synapse SDK는 컴퓨터 비전 데이터셋을 위한 포괄적인 데이터 형식 변환 유틸리티를 제공합니다. 이러한 변환기는 머신 러닝 워크플로우에서 일반적으로 사용되는 다양한 어노테이션 형식 간의 원활한 변환을 가능하게 합니다.
+
+## 개요
+
+변환기 시스템은 다음 간의 양방향 변환을 지원합니다:
+
+- **DM 형식** - Synapse Data Manager의 네이티브 어노테이션 형식 (v1 ⟷ v2 마이그레이션 지원)
+- **COCO 형식** - Microsoft Common Objects in Context 형식
+- **Pascal VOC 형식** - Visual Object Classes XML 형식  
+- **YOLO 형식** - You Only Look Once 텍스트 기반 형식
+
+모든 변환기는 분류된 데이터셋(train/valid/test 분할 포함)과 분류되지 않은 데이터셋 모두를 지원합니다. 또한 모든 변환기는 이제 개별 파일 처리를 위한 단일 파일 변환 모드를 지원합니다.
+
+## 지원되는 어노테이션 타입
+
+| 어노테이션 타입 | DM | COCO | Pascal VOC | YOLO |
+|----------------|----|----|-----------|------|
+| 바운딩 박스 | ✅ | ✅ | ✅ | ✅ |
+| 폴리곤 | ✅ | ✅ | ❌ | ✅ |
+| 세그멘테이션 | ✅ | ✅ | ✅ | ❌ |
+| 키포인트 | ✅ | ✅ | ❌ | ✅ |
+| 분류 | ✅ | ✅ | ❌ | ❌ |

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

@@ -0,0 +1,24 @@
+---
+id: features
+title: 기능
+sidebar_position: 5
+---
+
+# 기능
+
+이 섹션에서는 Synapse SDK에서 제공하는 주요 기능과 기능성을 다룹니다.
+
+## [플러그인 시스템](./plugins/index.md)
+
+ML 워크플로우 구축 및 관리를 위한 포괄적인 플러그인 프레임워크입니다.
+
+- **[플러그인 카테고리](./plugins/index.md#plugin-categories)** - 신경망, 내보내기, 업로드, 스마트 도구 및 검증 플러그인
+- **[실행 방법](./plugins/index.md#execution-methods)** - Job, Task 및 REST API 실행 모드
+- **[개발 가이드](./plugins/index.md#creating-plugins)** - 커스텀 플러그인 생성, 테스트 및 배포
+
+## [데이터 변환기](./converters/index.md)
+
+컴퓨터 비전 데이터셋을 위한 포괄적인 데이터 형식 변환 유틸리티입니다.
+
+- **[형식 변환기](./converters/index.md)** - DM, COCO, Pascal VOC 및 YOLO 형식 간 변환
+- **[버전 마이그레이션](./converters/index.md#dm-version-converter)** - 버전 간 DM 데이터셋 마이그레이션

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

@@ -0,0 +1,30 @@
+---
+id: plugins
+title: 플러그인 시스템
+sidebar_position: 2
+---
+
+# 플러그인 시스템
+
+Synapse SDK는 다양한 카테고리와 실행 방법에 걸쳐 ML 플러그인을 구축하고 관리하기 위한 포괄적인 플러그인 시스템을 제공합니다. 플러그인 시스템은 다양한 환경에서 배포되고 실행될 수 있는 모듈식, 재사용 가능한 컴포넌트를 가능하게 합니다.
+
+## 개요
+
+플러그인 시스템은 **액션** 개념을 중심으로 구축됩니다 - 패키징, 배포 및 다양한 컨텍스트에서 실행될 수 있는 개별 작업들입니다. 각 플러그인은 특정 카테고리에 속하며 여러 액션을 지원할 수 있습니다.
+
+### 주요 기능
+
+- **🔌 모듈식 아키텍처**: 플러그인은 자체 종속성과 구성을 가진 자체 포함형입니다
+- **⚡ 다중 실행 방법**: Job, Task 및 REST API 엔드포인트 지원
+- **📦 분산 실행**: 확장 가능한 분산 컴퓨팅을 위해 구축됨
+- **🛠️ 템플릿 시스템**: 신속한 플러그인 개발을 위한 Cookiecutter 기반 스캐폴딩
+- **📊 진행률 추적**: 내장된 로깅, 메트릭 및 진행률 모니터링
+- **🔄 동적 로딩**: 런타임 플러그인 발견 및 등록
+
+## 플러그인 카테고리
+
+SDK는 플러그인을 특정 카테고리로 구성하며, 각각은 ML 워크플로우의 다양한 측면을 위해 설계되었습니다:
+
+### 1. 신경망 (`neural_net`)
+
+ML 모델 훈련, 추론 및 배포 작업들.

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

@@ -0,0 +1,94 @@
+---
+id: installation
+title: 설치 & 설정
+sidebar_position: 2
+---
+
+# 설치 & 설정
+
+Synapse SDK를 몇 분 안에 시작해보세요.
+
+## 사전 요구사항
+
+Synapse SDK를 설치하기 전에 다음을 확인하세요:
+
+- **Python 3.10 이상** 설치됨
+
+## 설치 방법
+
+### PyPI에서 설치
+
+Synapse SDK를 설치하는 가장 쉬운 방법은 pip를 사용하는 것입니다:
+
+```bash
+pip install synapse-sdk
+```
+
+### 선택적 종속성과 함께 설치
+
+추가 기능을 위해 extras와 함께 설치하세요:
+
+```bash
+# 모든 종속성과 함께 설치 (분산 컴퓨팅, 최적화 라이브러리)
+pip install synapse-sdk[all]
+
+# 대시보드 종속성과 함께 설치 (FastAPI, Uvicorn)
+pip install synapse-sdk[devtools]
+
+# 둘 다 설치
+pip install "synapse-sdk[all,devtools]"
+```
+
+### 소스에서 설치
+
+최신 개발 버전을 가져오려면:
+
+```bash
+git clone https://github.com/datamaker/synapse-sdk.git
+cd synapse-sdk
+pip install -e .
+
+# 선택적 종속성과 함께
+pip install -e ".[all,devtools]"
+```
+
+## 설치 확인
+
+설치 후 모든 것이 작동하는지 확인하세요:
+
+```bash
+# 버전 확인
+synapse --version
+
+# 대화형 CLI 실행
+synapse
+
+# devtools와 함께 실행
+synapse --dev-tools
+```
+
+## 문제 해결
+
+### 일반적인 문제들
+
+1. **ImportError: No module named 'synapse_sdk'**
+   - 가상 환경을 활성화했는지 확인하세요
+   - Python 경로 확인: `python -c "import sys; print(sys.path)"`
+
+2. **백엔드 연결 시간 초과**
+   - API 토큰이 올바른지 확인하세요
+   - 네트워크 연결을 확인하세요
+   - 백엔드 URL에 접근 가능한지 확인하세요
+
+### 도움 받기
+
+문제가 발생하면:
+
+1. [문제 해결 가이드](./troubleshooting.md)를 확인하세요
+2. [GitHub Issues](https://github.com/datamaker/synapse-sdk/issues) 검색
+3. [Discord 커뮤니티](https://discord.gg/synapse-sdk)에 참여하세요
+
+## 다음 단계
+
+- [빠른 시작 가이드](./quickstart.md) 따라하기
+- [핵심 개념](./concepts/index.md)에 대해 학습하기

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

@@ -0,0 +1,47 @@
+---
+id: introduction
+title: 소개
+sidebar_position: 1
+---
+
+# Synapse SDK
+
+ML 및 데이터 처리 플러그인을 구축하세요.
+
+## 개요
+
+Synapse SDK는...
+
+### 주요 기능
+
+- **🚀 플러그인 개발 및 테스트**: Synapse용 카테고리별로 구성된 모듈화되고 재사용 가능한 컴포넌트 개발
+- **⚡ 분산 컴퓨팅**: 확장 가능한 분산 실행을 위해 구축됨
+- **🔧 다중 실행 모드**: Job, Task 및 REST API 지원
+- **📦 격리된 런타임 환경**: 각 플러그인은 종속성 관리와 함께 자체 환경에서 실행됨
+- **📊 진행률 추적**: 내장된 진행률 모니터링 및 메트릭 보고
+
+### 플러그인 카테고리
+
+SDK는 플러그인을 특정 카테고리로 구성합니다:
+
+1. **신경망** (`NEURAL_NET`): ML 모델 학습, 추론 및 배포
+2. **내보내기** (`EXPORT`): 데이터 내보내기 및 변환 작업
+3. **업로드** (`UPLOAD`): 파일 및 데이터 업로드 기능
+4. **스마트 도구** (`SMART_TOOL`): 지능형 자동화 도구
+5. **사후 어노테이션** (`POST_ANNOTATION`): 데이터 어노테이션 후 후처리
+6. **사전 어노테이션** (`PRE_ANNOTATION`): 데이터 어노테이션 전 전처리
+7. **데이터 검증** (`DATA_VALIDATION`): 데이터 품질 및 검증 확인
+
+## 시작하기
+
+Synapse SDK를 시작하려면:
+
+1. [SDK 설치](./installation.md)
+2. [빠른 시작 가이드 따라하기](./quickstart.md)
+3. [API 참조 탐색](./api/index.md)
+4. [예제 확인](./examples/index.md)
+
+## 다음 단계
+
+- [핵심 개념](./concepts/index.md) 학습하기
+- [백엔드 연결](./configuration.md) 구성하기

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

@@ -0,0 +1,78 @@
+---
+id: quickstart
+title: 빠른 시작 가이드
+sidebar_position: 3
+---
+
+# 빠른 시작 가이드
+
+Synapse SDK를 몇 분 안에 시작하고 실행하세요.
+
+## 대화형 CLI
+
+모든 기능에 대화형 메뉴를 통해 접근하기 위해 Synapse CLI를 실행하세요:
+
+```bash
+synapse
+```
+
+다음 옵션들이 있는 메인 메뉴가 열립니다:
+
+- 🌐 **개발 도구**: 에이전트 및 작업 관리를 위한 웹 기반 대시보드
+- 💻 **Code-Server IDE**: 플러그인 개발을 위한 웹 기반 VS Code
+- ⚙️ **설정**: 백엔드 연결 및 에이전트 설정
+- 🔌 **플러그인 관리**: 플러그인 생성, 테스트 및 게시
+
+## 빠른 명령어
+
+특정 기능에 빠르게 접근하기 위해:
+
+```bash
+# 개발 도구 즉시 시작
+synapse --dev-tools
+
+# 백엔드 및 에이전트 구성
+synapse config
+
+# 코드 편집 환경 열기
+synapse code-server
+
+# 새 플러그인 생성
+synapse plugin create
+```
+
+## 첫 번째 플러그인
+
+1. **플러그인 생성**:
+
+   ```bash
+   synapse
+   # "🔌 플러그인 관리" → "새 플러그인 생성" 선택
+   ```
+
+2. **Code-Server에서 편집**:
+
+   ```bash
+   synapse
+   # "💻 Code-Server IDE 열기" 선택
+   ```
+
+3. **로컬에서 테스트**:
+
+   ```bash
+   synapse plugin run my_action '{"param": "value"}' --run-by script
+   ```
+
+4. **백엔드에 게시**:
+
+   ```bash
+   synapse
+   # "🔌 플러그인 관리" → "플러그인 게시" 선택
+   ```
+
+## 다음 단계
+
+- 완전한 [CLI 사용 가이드](./cli-usage.md) 읽기
+- [핵심 개념](./concepts/index.md)에 대해 학습하기
+- [API 참조](./api/index.md) 탐색하기
+- [자주 묻는 질문](./faq.md) 확인하기