The Sinapsis CLI provides an easy way to run agents and get information about templates:

# Run an agent with a config file
sinapsis run config.yml

# Run an agent with profiler enabled
sinapsis run config.yml --enable-profiler

# List all available templates
sinapsis info --all-template-names

# Get detailed info about a specific template
sinapsis info --template TemplateName

# Get example config for a template
sinapsis info --example-template-config TemplateName

# Display info for all templates
sinapsis info --all

Create a config file my_test_agent.yml:

You can also use the ones defined under the src/configs/ folder

agent:
  name: my_test_agent

templates:
- template_name: InputTemplate-1
  class_name: InputTemplate
  attributes: {}

- template_name: HelloWorld-1
  class_name: HelloWorld
  template_input: InputTemplate-1
  attributes:
    display_text: "Hello, this is my first template!"

Run the agent:

sinapsis run my_test_agent.yml

Output

... | DEBUG |  my_test_agent:__instantiate_templates:105 - Initialized template: InputTemplate-1
... | DEBUG |  my_test_agent:__instantiate_templates:105 - Initialized template: HelloWorld-1
... | DEBUG |  my_test_agent:_log_agent_execution_order:119 - Execution Order
... | DEBUG |  my_test_agent:_log_agent_execution_order:122 - Order: <<0>>, template name: <<InputTemplate-1>>
... | DEBUG |  my_test_agent:_log_agent_execution_order:122 - Order: <<1>>, template name: <<HelloWorld-1>>
... | INFO |  my_test_agent:_lazy_init:63 - Agent and templates initialized
... | INFO |  my_test_agent:signal_block_if_needed:156 - Signaling block mode for HelloWorld-1 no: 2/2
... | INFO |  my_test_agent:all_templates_finished:192 - All templates returned finished, stopping execution...
... | DEBUG | .../run_agent_from_config.py:run_agent_from_config:41 - result: DataContainer(container_id=abc..., images=[], audios=[], texts=[TextPacket(content='Hello, this is my first template!', id='abc...', source='HelloWorld-1', modified_by_templates=['HelloWorld-1'], embedding=[], generic_data={}, annotations=None)], time_series=[], binary_data=[], generic_data={})

• Declarative workflows
• Multiple execution modes:
  • Generator
  • Single execute
  • Continuous execution
• Sophisticated template orchestration:
  • Topological sorting of execution order
  • Parallel template execution
  • Execution blocking control
• Built-in profiling capabilities:
  • Execution time tracking
• State management:
  • Dynamic attribute updates
• Failure handling

• Self-contained components
• Modular task-focused execution
• Eager or lazy evaluation
• Dynamic template definitions
• Composite templates
• SubAgents

• Universal data transport
• Domain agnostic design
• Native built-in support for images, audio, text, time series
• Multimodal data

• Data Validation and Type Safety through Pydantic
• YAML-based configuration files
• Command Line Interface

Sinapsis provides Docker images with all dependencies pre-configured. When you want to use docker to test an app within the project, you need to make sure the sinapsis base images are built in your system. To build the images:

1. Clone the repository:

git clone git@github.com:Sinapsis-ai/sinapsis.git
cd sinapsis

2. Build the image

docker compose -f docker/compose.yaml build

This will create two docker images:

• sinapsis:base: Contains UV package manager, git with SSH support, and Python 3.10 environment.
• sinapsis-nvidia:base: Same as base plus CUDA 12.4.0 support for GPU acceleration.

• sinapsis-data-readers

• sinapsis-data-writers

• sinapsis-data-visualization

• sinapsis-generic-data-tools

• sinapsis-langchain-readers

• sinapsis-image-transforms