Docs /Templates/ sinapsis-sub-agents

AsyncFixedNumExecutions

sinapsis-sub-agentsSubAgents

Python template · sinapsis_sub_agents.templates.async_sub_agent

Overview

Async version of FixedNumExecutions template. Allows a template to be executed a fixed number of times.

Subsequent calls to execute will do nothing.

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-sub-agents==1.0.0
uv pip install sinapsis-sub-agents==1.0.0
uv add sinapsis-sub-agents==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
lazy_agent
bool
Optional
Default: false
num_executions
int
Optional
Default: 1
agent_definitionRequired
dict | sinapsis_core.agent.base_models.ProfilerAgentSchema | sinapsis_core.agent.base_models.AgentSchema | sinapsis_core.agent.base_models.MPIAgentSchema | str | pathlib._local.PosixPath
Required
Default: null

Configuration example

Generated from documented defaults. Replace any placeholders and complete required nested settings before running.

yaml
templates:
  - template_name: "AsyncFixedNumExecutions"
    class_name: "AsyncFixedNumExecutions"
    attributes:
      lazy_agent: false
      num_executions: 1
      agent_definition: "<required>"

Inheritance

Immediate parent: sinapsis_sub_agents.templates.async_sub_agent.AsyncSubAgentTemplate

Environment variables

Environment definitions belong to their canonical Python modules.

No directly related environment variables listed.