signaloid-cli samples

Retrieve random samples from Signaloid task outputs.

Synopsis

signaloid-cli samples <command> [options]

Description

The samples command group allows you to retrieve random samples from Signaloid task outputs.

Commands

from-value-id - Get samples from a Reference Core task using output Value IDs
from-ux-string - Get samples from Ux strings

Understanding Samples

When Signaloid executes code with uncertainty tracking, it represents uncertain values as distributions. The samples API allows you to generate random samples:

From distributions encoded in the Signaloid Ux Data format
From the output of Reference core runs, that is encoded in the form of Value IDs

Sample Workflow

# 1. Create and run a task
TASK_ID=$(signaloid-cli tasks create --build-id bld_abc | jq -r '.TaskID')

# 2. Wait for completion
signaloid-cli tasks watch --task-id $TASK_ID

# 3. Get output to find value IDs
signaloid-cli tasks output --task-id $TASK_ID

# 4. Extract samples for specific Ux string
signaloid-cli samples from-ux-string \
  --task-id $TASK_ID \
  --value-id value_xyz \
  --count 1000

Exit Codes

Code	Description
`0`	Success
`1`	Error (task not found, value not found, invalid parameters)

Tips and Tricks

Export to CSV

# Convert samples to CSV format
signaloid-cli samples from-ux-string \
  --task-id $TASK_ID \
  --value-id $VALUE_ID \
  --count 5000 | \
  jq -r '.Samples[]' > samples.csv

Synopsis​

Description​

Commands​

Understanding Samples​

Sample Workflow​

Exit Codes​

Tips and Tricks​

Export to CSV​

See Also​