Docs /Templates/ sinapsis-sub-agents

SubAgentRay

sinapsis-sub-agentsSubAgents

Python template · sinapsis_sub_agents.templates.sub_agent_ray

Overview

Template to initialize sub agent instances as ray actors.

This allows executing the sub agent in distributed workflows.

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.

address

Set the address of the Ray cluster to connect to. Defaults to None.

str | None
Optional
Default: null
metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
num_cpus

Set the number of CPUs assigned to sub agent instance. Defaults to 1.

int
Optional
Default: 1
num_gpus

Set the number of GPUs assigned to sub agent instance. Defaults to 1.

int
Optional
Default: 1
lazy_agent
bool
Optional
Default: false
ready_timeout

Set a maximum time for a sub agent to finish its execution. If ready_timeout = 0.0, no timeout is set. Defaults to 0.0

float
Optional
Default: 0
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: "SubAgentRay"
    class_name: "SubAgentRay"
    attributes:
      address: null
      num_cpus: 1
      num_gpus: 1
      lazy_agent: false
      ready_timeout: 0
      agent_definition: "<required>"
View original docstring example

The source example references HelloWorld, not SubAgentRay.

yaml
agent:
  name: my_test_agent
templates:
  - template_name: InputTemplate
    class_name: InputTemplate
    attributes: {}
  - template_name: SubAgentRay
    class_name: SubAgentRay
    template_input: InputTemplate
    attributes:
      lazy_agent: false
      ready_timeout: 0.0
      num_cpus: 1
      num_gpus: 1
      agent_definition:
        agent:
          name: my_test_sub_agent_ray
        templates:
          - template_name: InputTemplate
            class_name: InputTemplate
            attributes: {}
          - template_name: HelloWorld
            class_name: HelloWorld
            template_input: InputTemplate
            attributes:
              display_text: Hello Sinapsis

Inheritance

Immediate parent: sinapsis_sub_agents.templates.sub_agent_base.SubAgentTemplate

Environment variables

Environment definitions belong to their canonical Python modules.

No directly related environment variables listed.