synapse-runtime-context-apilisted

# Synapse RuntimeContext API RuntimeContext provides logging, progress tracking, and client access for plugin actions. ## Quick Reference ```python from synapse_sdk.plugins.context import RuntimeContext def train(params: TrainParams, ctx: RuntimeContext) -> dict: # Progress tracking ctx.set_progress(0, 100) # Metrics recording ctx.set_metrics({'loss': 0.05}, 'training') # User-facing message ctx.log_message('Training started', 'info') # Event logging ctx.log('checkpoint', {'epoch': 5}, '/path/to/file') # Debug logging ctx.log_dev_event('Debug info', {'data': 'value'}) # Signal completion ctx.end_log() return {'status': 'completed'} ``` ## Context Attributes | Attribute | Type | Description | |-----------|------|-------------| | `ctx.logger` | BaseLogger | Logger instance | | `ctx.env` | PluginEnvironment | Environment variables | | `ctx.job_id` | str \| None | Job tracking ID | | `ctx.client` | BackendClient \| None | API client | | `ctx.agent_client` | AgentClient \| None | Ray operations client | | `ctx.checkpoint` | dict \| None | Pretrained model info | ## Progress Tracking ```python # Basic progress ctx.set_progress(current=50, total=100) # Progress with category (multi-phase) ctx.set_progress(5, 10, category='download') ctx.set_progress(3, 100, category='training') ``` ## Metrics Recording ```python ctx.set_metrics( value={'loss': 0.05, 'accuracy': 0.95}, category='training' ) ``` ## Logging M