Skip to content
Synalinks OSS
Masking Modules
Search
SynaLinks/synalinks
Synalinks OSS
SynaLinks/synalinks
Quickstart
Introduction
Project Templates
Guides
Guides
Getting Started
Data Models
Programs
Modules
Control Flow
Decision Models
Agents
Knowledge Base
Knowledge Graph Extraction
Free form Knowledge Graph Extraction
GraphRAG
Input Guard
Output Guard
Observability
Datasets
Trainable Variables
Rewards
Metrics
Training
Callbacks
Multimodal Inputs
Hyperparameter Search
Multi Objective LM Selection
Recursive Language Model Agent
SQL Agent
Cypher Agent
Vector RAG Agent
Deep Agent
Mixture of Models
Consul of Models
FastAPI Deployment
FastMCP Deployment
Python Synthesis
Code Examples
Code Examples
First Steps
Functional API
Subclassing
Sequential API
Mixing Strategy
Parallel Branches
Decisions
Conditional Branches
Data Model Operators
JSON Ops
Conversational Applications
Reward Metrics And Optimizers
Training Programs
Implementing Custom Modules Via Subclassing
Autonomous Agent
Interactive Agent
Recursive Language Model Agent
Knowledge Extraction and Storage
Document RAG
Vector RAG Agent
MCP Agent
SQL Agent
Cypher Agent
Deep Agent
Python Synthesis
Modules
Rewards
Metrics
FAQ
CheatSheet
Differences with Keras
Differences with DSPy
Synalinks API
Synalinks API
Language Models API
Embedding Models API
Decision Models API
Knowledge Base API
Knowledge Base API
Knowledge Base
Database Adapters
Database Adapters
DuckDB Adapter
LanceDB Adapter
Graph Database Adapters
Graph Database Adapters
Ladybug Adapter
Data Models API
Data Models API
Data Models API
The DataModel class
The JsonDataModel class
The SymbolicDataModel class
The Variable class
The Base DataModels
Knowledge Data Models
Multimodal Data Models
Score Data Models
Programs API
Programs API
Programs API
The Program class
The Sequential class
Program training API
Program Saving API
Program Saving API
Program saving and loading
Variable saving and loading
Modules API
Modules API
Modules API
Base Module class
Core Modules
Core Modules
Core Modules
Input module
Identity module
Not module
Generator module
Decision module
MultiDecision module
Action module
Branch module
Tool module
Agents Modules
Agents Modules
Agents Modules
FunctionCallingAgent module
CypherAgent module
RLMAgent module
SQLAgent module
VectorRAGAgent module
DeepAgent module
Knowledge Modules
Knowledge Modules
Knowledge Modules
EmbedKnowledge module
UpdateKnowledge module
RetrieveKnowledge module
Masking Modules
Masking Modules
Masking Modules
InMask module
OutMask module
Merging Modules
Merging Modules
Merging Modules
Concat module
And module
Or module
Xor module
Test Time Compute Modules
Test Time Compute Modules
Test Time Compute Modules
ChainOfThought module
SelfCritique module
Synthesis Modules
Synthesis Modules
Synthesis Modules
PythonSynthesis module
SequentialPlanSynthesis module
Retrievers Modules
Retrievers Modules
Retrievers Modules
SimilaritySearch module
FullTextSearch module
RegexSearch module
HybridFTSSearch module
HybridRegexSearch module
EntitySimilaritySearch module
EntityFullTextSearch module
EntityRegexSearch module
EntityHybridFTSSearch module
EntityHybridRegexSearch module
RelationSimilaritySearch module
RelationFullTextSearch module
RelationRegexSearch module
RelationHybridFTSSearch module
RelationHybridRegexSearch module
PathSimilaritySearch module
PathFullTextSearch module
PathRegexSearch module
PathHybridFTSSearch module
PathHybridRegexSearch module
LocalGraphSearch module
GlobalGraphSearch module
GlobalGraphMapReduce module
Rerankers Modules
Rerankers Modules
Rerankers Modules
RRFReranker module
Callbacks API
Callbacks API
Callbacks API
Base Callback class
ProgramCheckpoint
CSVLogger
BackUpAndRestore
EarlyStopping
BudgetStopping
Monitor
Hooks API
Hooks API
Hooks API
Base Hook class
Logger
Monitor
Recorder
Ops API
Ops API
Ops API
JSON Ops
Optimizers API
Optimizers API
Optimizers API
Base Optimizer class
RandomFewShot
OMEGA
Metrics
Metrics
Metrics
Base Metric class
Metric wrappers and reduction metrics
Accuracy metrics
Precision and Recall metrics
FScore metrics
Regression metrics
Language Model operational metrics
Embedding Model operational metrics
Program operational metrics
Accuracy metric
BinaryAccuracy metric
CategoricalAccuracy metric
GapK metric
PassAtK metric
PassHatK metric
BatchMetric metric
AvgEmbeddingCachedTokensPerCall metric
AvgEmbeddingCostPerCall metric
AvgEmbeddingLatency metric
AvgEmbeddingTokensPerCall metric
AvgEmbeddingVectorsPerCall metric
AvgOptimizerEmbeddingCachedTokensPerCall metric
AvgOptimizerEmbeddingCostPerCall metric
AvgOptimizerEmbeddingLatency metric
AvgOptimizerEmbeddingTokensPerCall metric
AvgOptimizerEmbeddingVectorsPerCall metric
AvgRewardEmbeddingCachedTokensPerCall metric
AvgRewardEmbeddingCostPerCall metric
AvgRewardEmbeddingLatency metric
AvgRewardEmbeddingTokensPerCall metric
AvgRewardEmbeddingVectorsPerCall metric
EmbeddingCacheHitRate metric
EmbeddingCachedTokens metric
EmbeddingCost metric
EmbeddingErrorRate metric
EmbeddingFailedCalls metric
EmbeddingFallbackActivations metric
EmbeddingModelOperationalMetric metric
EmbeddingModelOptimizersOperationalMetric metric
EmbeddingModelRewardsOperationalMetric metric
EmbeddingThroughput metric
EmbeddingTokens metric
EmbeddingTokensPerSecond metric
EmbeddingVectors metric
EmbeddingVectorsPerSecond metric
OptimizerEmbeddingCacheHitRate metric
OptimizerEmbeddingCachedTokens metric
OptimizerEmbeddingCost metric
OptimizerEmbeddingErrorRate metric
OptimizerEmbeddingFailedCalls metric
OptimizerEmbeddingFallbackActivations metric
OptimizerEmbeddingThroughput metric
OptimizerEmbeddingTokens metric
OptimizerEmbeddingTokensPerSecond metric
OptimizerEmbeddingVectors metric
OptimizerEmbeddingVectorsPerSecond metric
RewardEmbeddingCacheHitRate metric
RewardEmbeddingCachedTokens metric
RewardEmbeddingCost metric
RewardEmbeddingErrorRate metric
RewardEmbeddingFailedCalls metric
RewardEmbeddingFallbackActivations metric
RewardEmbeddingThroughput metric
RewardEmbeddingTokens metric
RewardEmbeddingTokensPerSecond metric
RewardEmbeddingVectors metric
RewardEmbeddingVectorsPerSecond metric
BinaryF1Score metric
BinaryFBetaScore metric
CategoricalF1Score metric
ListF1Score metric
CategoricalFBetaScore metric
ListFBetaScore metric
F1Score metric
FBetaScore metric
AvgCacheCreationTokensPerCall metric
AvgCachedTokensPerCall metric
AvgCostPerCall metric
AvgInputTokensPerCall metric
AvgLatency metric
AvgOptimizerCacheCreationTokensPerCall metric
AvgOptimizerCachedTokensPerCall metric
AvgOptimizerCostPerCall metric
AvgOptimizerInputTokensPerCall metric
AvgOptimizerLatency metric
AvgOptimizerOutputTokensPerCall metric
AvgOptimizerReasoningTokensPerCall metric
AvgOptimizerTotalTokensPerCall metric
AvgOutputTokensPerCall metric
AvgReasoningTokensPerCall metric
AvgRewardCacheCreationTokensPerCall metric
AvgRewardCachedTokensPerCall metric
AvgRewardCostPerCall metric
AvgRewardInputTokensPerCall metric
AvgRewardLatency metric
AvgRewardOutputTokensPerCall metric
AvgRewardReasoningTokensPerCall metric
AvgRewardTotalTokensPerCall metric
AvgTimeToFirstToken metric
AvgTimeToLastToken metric
AvgTotalTokensPerCall metric
AvgTrajectoryTimeToFirstToken metric
CacheCreationTokens metric
CacheHitRate metric
CachedTokens metric
Cost metric
ErrorRate metric
FailedCalls metric
FallbackActivations metric
InputTokens metric
LMOperationalMetric metric
LMOptimizersOperationalMetric metric
LMRewardsOperationalMetric metric
OptimizerCacheCreationTokens metric
OptimizerCacheHitRate metric
OptimizerCachedTokens metric
OptimizerCost metric
OptimizerErrorRate metric
OptimizerFailedCalls metric
OptimizerFallbackActivations metric
OptimizerInputTokens metric
OptimizerOutputTokens metric
OptimizerReasoningTokenShare metric
OptimizerReasoningTokens metric
OptimizerThroughput metric
OptimizerTokensPerSecond metric
OptimizerTotalTokens metric
OutputTokens metric
ReasoningTokenShare metric
ReasoningTokens metric
RewardCacheCreationTokens metric
RewardCacheHitRate metric
RewardCachedTokens metric
RewardCost metric
RewardErrorRate metric
RewardFailedCalls metric
RewardFallbackActivations metric
RewardInputTokens metric
RewardOutputTokens metric
RewardReasoningTokenShare metric
RewardReasoningTokens metric
RewardThroughput metric
RewardTokensPerSecond metric
RewardTotalTokens metric
Throughput metric
TokensPerSecond metric
TotalTokens metric
Metric metric
BinaryPrecision metric
BinaryRecall metric
CategoricalPrecision metric
CategoricalRecall metric
Precision metric
Recall metric
ProgramAvgCostPerInvocation metric
ProgramCalls metric
ProgramCallsPerSecond metric
ProgramCost metric
ProgramElapsedTime metric
ProgramOperationalMetric metric
Mean metric
MeanMetricWrapper metric
Sum metric
CosineSimilarity metric
Rewards
Rewards
Rewards
Base Reward class
ExactMatch reward
CosineSimilarity reward
LMAsJudge reward
AgentAsJudge reward
RLMAsJudge reward
DeepAgentAsJudge reward
RubricsAsJudge reward
ComposableReward reward
Rubric preset rewards
AnswerRelevancy reward
Faithfulness reward
Hallucination reward
Summarization reward
ArgumentCorrectness reward
ContextualRelevancy reward
ContextualPrecision reward
ContextualRecall reward
CitationFaithfulness reward
Bias reward
Toxicity reward
PIILeakage reward
Misuse reward
NonAdvice reward
PromptAlignment reward
TaskCompletion reward
ToolCorrectness reward
ToolUse reward
ToolPermission reward
GoalAccuracy reward
RoleAdherence reward
RoleViolation reward
PlanQuality reward
PlanAdherence reward
StepEfficiency reward
AgentLoopDetection reward
ConversationCompleteness reward
KnowledgeRetention reward
TopicAdherence reward
TurnRelevancy reward
TurnFaithfulness reward
RewardFunctionWrapper reward
ProgramAsJudge reward
BatchReward reward
BatchRewardFunctionWrapper reward
Reward wrappers
Batch reward wrappers
Datasets
Datasets
Dataset
HuggingFaceDataset
MLflowDataset
ImageFolderDataset
Built-in Datasets
Built-in Datasets
Built-in Datasets
GSM8K
HotpotQA
ARC AGI
ARC Challenge
BBH
BBQ
BoolQ
DROP
HellaSwag
HumanEval
IFEval
LAMBADA
LogiQA
MMLU
SQuAD
TruthfulQA
WinoGrande
Utilities
Utilities
Program plotting utilities
More plotting utilities
NLP utilities
Utils API
Utils API
Utils API
Disable keras backend
Tuners
Observability API
Config
Observability
Observability
Observability with MLflow
Masking Modules
InMask module
OutMask module