Add self critique module

YoanSallami · YoanSallami · commit cfc7abfa9783 · 2025-04-28T16:20:16.000+02:00
diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@
 
 ![Beta](https://img.shields.io/badge/Release-Beta-blue.svg)
 ![Coverage Badge](https://raw.githubusercontent.com/SynaLinks/synalinks/refs/heads/main/coverage-badge.svg)
-![Pypi Downloads](https://img.shields.io/pypi/dm/synalinks)
+[![Pypi Downloads](https://img.shields.io/pypi/dm/synalinks)](https://pypistats.org/packages/synalinks)
 [![Discord](https://img.shields.io/discord/1118241178723291219)](https://discord.gg/82nt97uXcM)
 [![Python package](https://github.com/SynaLinks/Synalinks/actions/workflows/tests.yml/badge.svg)](https://github.com/SynaLinks/SynaLinks/actions/workflows/tests.yml)
 [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://opensource.org/license/apache-2-0)
diff --git a/coverage-badge.svg b/coverage-badge.svg
@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="114" height="20" role="img" aria-label="coverage: 69.36%"><title>coverage: 69.36%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="114" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="53" height="20" fill="#fe7d37"/><rect width="114" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text><text aria-hidden="true" x="865" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">69.36%</text><text x="865" y="140" transform="scale(.1)" fill="#fff" textLength="430">69.36%</text></g></svg>
+<svg xmlns="http://www.w3.org/2000/svg" width="114" height="20" role="img" aria-label="coverage: 69.51%"><title>coverage: 69.51%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="114" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="53" height="20" fill="#fe7d37"/><rect width="114" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text><text aria-hidden="true" x="865" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">69.51%</text><text x="865" y="140" transform="scale(.1)" fill="#fff" textLength="430">69.51%</text></g></svg>
diff --git a/docs/Synalinks API/Modules API/Core Modules/None module.md b/docs/Synalinks API/Modules API/Core Modules/None module.md
diff --git a/docs/Synalinks API/Modules API/Core Modules/Not module.md b/docs/Synalinks API/Modules API/Core Modules/Not module.md
@@ -0,0 +1,2 @@
+
+::: synalinks.src.modules.core.not_module
diff --git a/docs/Synalinks API/Modules API/Core Modules/index.md b/docs/Synalinks API/Modules API/Core Modules/index.md
@@ -2,7 +2,7 @@
 
 - [Input module](Input module.md)
 - [Identity module](Identity module.md)
-- [None module](None module.md)
+- [Not module](Not module.md)
 - [Generator module](Generator module.md)
 - [Decision module](Decision module.md)
 - [Action module](Action module.md)
diff --git a/docs/Synalinks API/Modules API/Test Time Compute Modules/SelfCritique module.md b/docs/Synalinks API/Modules API/Test Time Compute Modules/SelfCritique module.md
@@ -0,0 +1,2 @@
+
+::: synalinks.src.modules.ttc.self_critique
diff --git a/docs/Synalinks API/Modules API/Test Time Compute Modules/index.md b/docs/Synalinks API/Modules API/Test Time Compute Modules/index.md
@@ -1,3 +1,4 @@
 # Test Time Compute Modules
 
-- [ChainOfThought module](ChainOfThought module.md)
+- [ChainOfThought module](ChainOfThought module.md)
+- [SelfCritique module](SelfCritique module.md)
diff --git a/docs/Synalinks API/Modules API/index.md b/docs/Synalinks API/Modules API/index.md
@@ -47,7 +47,7 @@ if __name__ == "__main__":
 
 - [Input module](Core Modules/Input module.md)
 - [Identity module](Core Modules/Identity module.md)
-- [None module](Core Modules/None module.md)
+- [Not module](Core Modules/Not module.md)
 - [Generator module](Core Modules/Generator module.md)
 - [Decision module](Core Modules/Decision module.md)
 - [Action module](Core Modules/Action module.md)
@@ -67,6 +67,7 @@ if __name__ == "__main__":
 ### Test Time Compute Modules
 
 - [ChainOfThought module](Test Time Compute Modules/ChainOfThought module.md)
+- [SelfCritique module](Test Time Compute Modules/SelfCritique module.md)
 
 ---
 
diff --git a/synalinks/__init__.py b/synalinks/__init__.py
@@ -31,14 +31,15 @@
 from synalinks.api import LanguageModel
 from synalinks.api import Metric
 from synalinks.api import Module
-from synalinks.api import NoneModule
+from synalinks.api import Not
 from synalinks.api import Operation
 from synalinks.api import Or
 from synalinks.api import Prediction
 from synalinks.api import Program
 from synalinks.api import ReACTAgent
 from synalinks.api import RelationSchema
 from synalinks.api import Reward
+from synalinks.api import SelfCritique
 from synalinks.api import Sequential
 from synalinks.api import StatelessScope
 from synalinks.api import SymbolicDataModel
diff --git a/synalinks/api/__init__.py b/synalinks/api/__init__.py
@@ -71,13 +71,14 @@
 from synalinks.src.modules.core.generator import default_prompt_template
 from synalinks.src.modules.core.identity import Identity
 from synalinks.src.modules.core.input_module import Input
-from synalinks.src.modules.core.none import NoneModule
+from synalinks.src.modules.core.not_module import Not
 from synalinks.src.modules.merging.concat import Concat
 from synalinks.src.modules.merging.logical_and import And
 from synalinks.src.modules.merging.logical_or import Or
 from synalinks.src.modules.merging.logical_xor import Xor
 from synalinks.src.modules.module import Module
 from synalinks.src.modules.ttc.chain_of_thought import ChainOfThought
+from synalinks.src.modules.ttc.self_critique import SelfCritique
 from synalinks.src.ops.function import Function
 from synalinks.src.ops.operation import Operation
 from synalinks.src.programs.program import Program
diff --git a/synalinks/api/modules/__init__.py b/synalinks/api/modules/__init__.py
@@ -14,10 +14,11 @@
 from synalinks.src.modules.core.identity import Identity
 from synalinks.src.modules.core.input_module import Input
 from synalinks.src.modules.core.input_module import InputModule
-from synalinks.src.modules.core.none import NoneModule
+from synalinks.src.modules.core.not_module import Not
 from synalinks.src.modules.merging.concat import Concat
 from synalinks.src.modules.merging.logical_and import And
 from synalinks.src.modules.merging.logical_or import Or
 from synalinks.src.modules.merging.logical_xor import Xor
 from synalinks.src.modules.module import Module
 from synalinks.src.modules.ttc.chain_of_thought import ChainOfThought
+from synalinks.src.modules.ttc.self_critique import SelfCritique
diff --git a/synalinks/cli/constants.py b/synalinks/cli/constants.py
@@ -135,7 +135,7 @@ async def create_program():
     language_model = synalinks.LanguageModel(
         model=os.environ.get(
             "LANGUAGE_MODEL",
-            "ollama/deepseek-r1",
+            "{{config.model_provider}}/{{config.language_model}}",
         ),
         api_base=os.environ.get("MODEL_API_BASE", None),
     )
@@ -148,8 +148,8 @@ async def create_program():
     return synalinks.Program(
         inputs=inputs,
         outputs=outputs,
-        name="my-project",
-        description="My awesome project",
+        name="{{config.package_name}}",
+        description="{{config.project_description}}",
     )
     
 program = asyncio.run(create_program())
diff --git a/synalinks/src/backend/common/stateless_scope.py b/synalinks/src/backend/common/stateless_scope.py
@@ -14,7 +14,7 @@ class StatelessScope:
     should be passed via the `state_mapping` argument, a
     list of tuples `(k, v)` where `k` is a `Variable`
     and `v` is the intended value for this variable
-    (a backend tensor).
+    (a backend data model).
 
     Updated values can be collected on scope exit via
     `value = scope.get_current_value(variable)`. No updates
@@ -57,17 +57,14 @@ def __init__(
                     "all keys in argument `mapping` must be Variable "
                     f"instances. Received instead: {k}"
                 )
-            if isinstance(v, Variable):
-                v = backend.cast(v.value, dtype=k.dtype)
-            else:
-                v = backend.convert_to_tensor(v, dtype=k.dtype)
-            if k.shape != v.shape:
+            v = backend.convert_to_json_data_model(v, dtype=k.dtype)
+            if not backend.is_schema_equal(k.get_schema(), v.get_schema()):
                 raise ValueError(
                     "Invalid variable value in StatelessScope: "
-                    "all values in argument `mapping` must be tensors with "
-                    "a shape that matches the corresponding variable shape. "
-                    f"For variable {k}, received invalid value {v} with shape "
-                    f"{v.shape}."
+                    "all values in argument `mapping` must be data models with "
+                    "a schema that matches the corresponding variable schema. "
+                    f"For variable {k}, received invalid value {v} with schema "
+                    f"{v.prettify_schema()}."
                 )
             self.state_mapping[id(k)] = v
 
@@ -76,8 +73,8 @@ def __enter__(self):
         global_state.set_global_attribute("stateless_scope", self)
         return self
 
-    def add_eval(self, eval):
-        self.rewards.append(eval)
+    def add_reward(self, reward):
+        self.rewards.append(reward)
 
     def add_update(self, update):
         variable, value = update
diff --git a/synalinks/src/modules/__init__.py b/synalinks/src/modules/__init__.py
@@ -3,10 +3,13 @@
 from synalinks.src.modules.core.branch import Branch
 from synalinks.src.modules.core.decision import Decision
 from synalinks.src.modules.core.generator import Generator
+from synalinks.src.modules.core.identity import Identity
 from synalinks.src.modules.core.input_module import Input
 from synalinks.src.modules.core.input_module import InputModule
+from synalinks.src.modules.core.not_module import Not
 from synalinks.src.modules.module import Module
 from synalinks.src.modules.ttc.chain_of_thought import ChainOfThought
+from synalinks.src.modules.ttc.self_critique import SelfCritique
 from synalinks.src.saving import serialization_lib
 
 
diff --git a/synalinks/src/modules/agents/react.py b/synalinks/src/modules/agents/react.py
@@ -41,14 +41,20 @@ class ReACTAgent(Program):
     Example:
 
     ```python
+    import synalinks
+    import asyncio
 
-    async def main():
+    class Query(synalinks.DataModel):
+        query: str = synalinks.Field(
+            description="The user query",
+        )
 
-        class Query(DataModel):
-            query: str
+    class FinalAnswer(synalinks.DataModel):
+        answer: float = synalinks.Field(
+            description="The correct final answer",
+        )
 
-        class FinalAnswer(DataModel):
-            answer: float
+    async def main():
 
         async def calculate(expression: str):
             \"""Calculate the result of a mathematical expression.
@@ -76,7 +82,7 @@ async def calculate(expression: str):
                     "log": f"Error: {e}",
                 }
 
-        language_model = LanguageModel(model="ollama_chat/deepseek-r1")
+        language_model = LanguageModel(model="ollama/mistral")
 
         x0 = Input(data_model=Query)
         x1 = await ReACTAgent(
@@ -89,6 +95,8 @@ async def calculate(expression: str):
         program = Program(
             inputs=x0,
             outputs=x1,
+            name="math_agent",
+            description="A math agent that can use a calculator",
         )
 
     if __name__ == "__main__":
diff --git a/synalinks/src/modules/core/action.py b/synalinks/src/modules/core/action.py
@@ -74,7 +74,7 @@ async def calculate(expression: str):
                 }
 
         language_model = synalinks.LanguageModel(
-            model="ollama_chat/deepseek-r1",
+            model="ollama/mistral",
         )
 
         x0 = synalinks.Input(data_model=Query)
diff --git a/synalinks/src/modules/core/branch.py b/synalinks/src/modules/core/branch.py
@@ -33,7 +33,9 @@ class AnswerWithCritique(synalinks.DataModel):
             critique: str
             answer: str
 
-        language_model = synalinks.LanguageModel("ollama_chat/deepseek-r1")
+        language_model = synalinks.LanguageModel(
+            model="ollama/mistral",
+        )
 
         x0 = synalinks.Input(data_model=Query)
         (x1, x2) = await synalinks.Branch(
diff --git a/synalinks/src/modules/core/decision.py b/synalinks/src/modules/core/decision.py
@@ -39,7 +39,7 @@ class Decision(Module):
     async def main():
 
         language_model = synalinks.LanguageModel(
-            model="ollama_chat/deepseek-r1",
+            model="ollama/mistral",
         )
 
         x0 = synalinks.Input(data_model=synalinks.ChatMessages)
diff --git a/synalinks/src/modules/core/decision_test.py b/synalinks/src/modules/core/decision_test.py
@@ -18,7 +18,7 @@ class Query(DataModel):
             query: str
 
         language_model = LanguageModel(
-            model="ollama_chat/deepseek-r1",
+            model="ollama/mistral",
         )
 
         expected_string = (
diff --git a/synalinks/src/modules/core/generator.py b/synalinks/src/modules/core/generator.py
@@ -45,7 +45,7 @@ def default_prompt_template():
 {{ outputs_schema }}
 {% endif %}
 {% if examples %}
-Examples:
+### Examples
 {% for example in examples %}
 Input:
 {{ example[0] }}
@@ -54,7 +54,7 @@ def default_prompt_template():
 {% endfor %}
 {% endif %}
 {% if instructions %}
-Instructions:
+### Instructions:
 {% for instruction in instructions %}
  - {{ instruction }}
 {% endfor %}
@@ -77,7 +77,7 @@ def chat_prompt_template():
     return """
 <system>
 {% if instructions %}
-Instructions:
+### Instructions:
 {% for instruction in instructions %}
  - {{ instruction }}
 {% endfor %}{% endif %}
@@ -136,7 +136,7 @@ class AnswerWithCritique(synalinks.DataModel):
             )
 
         language_model = synalinks.LanguageModel(
-            model="ollama/deepseek-r1",
+            model="ollama/mistral",
         )
 
         x0 = synalinks.Input(data_model=Query)
diff --git a/synalinks/src/modules/core/generator_test.py b/synalinks/src/modules/core/generator_test.py
@@ -21,7 +21,9 @@ class AnswerWithRationale(DataModel):
             rationale: str
             answer: str
 
-        language_model = LanguageModel(model="ollama_chat/deepseek-r1")
+        language_model = LanguageModel(
+            model="ollama/mistral",
+        )
 
         msgs = Generator(
             data_model=AnswerWithRationale,
diff --git a/synalinks/src/modules/core/not_module.py b/synalinks/src/modules/core/not_module.py
@@ -7,9 +7,9 @@
 from synalinks.src.modules.module import Module
 
 
-@synalinks_export(["synalinks.modules.NoneModule", "synalinks.NoneModule"])
-class NoneModule(Module):
-    """None module.
+@synalinks_export(["synalinks.modules.Not", "synalinks.Not"])
+class Not(Module):
+    """Not module.
 
     This module should be used as a placeholder when no operation is to be
     performed and the output should be None.
diff --git a/synalinks/src/modules/core/not_test.py b/synalinks/src/modules/core/not_test.py
@@ -3,17 +3,17 @@
 from synalinks.src import testing
 from synalinks.src.backend import DataModel
 from synalinks.src.modules.core.input_module import Input
-from synalinks.src.modules.core.none import NoneModule
+from synalinks.src.modules.core.not_module import Not
 from synalinks.src.programs.program import Program
 
 
-class NoneModuleTest(testing.TestCase):
+class NotTest(testing.TestCase):
     async def test_single_inputs(self):
         class Query(DataModel):
             query: str
 
         inputs = Input(data_model=Query)
-        outputs = await NoneModule()(inputs)
+        outputs = await Not()(inputs)
 
         program = Program(
             inputs=inputs,
@@ -33,7 +33,7 @@ class Query(DataModel):
             Input(data_model=Query),
             Input(data_model=Query),
         )
-        outputs = await NoneModule()(inputs)
+        outputs = await Not()(inputs)
 
         program = Program(
             inputs=inputs,
@@ -61,7 +61,7 @@ class Query(DataModel):
             Input(data_model=Query),
             Input(data_model=Query),
         ]
-        outputs = await NoneModule()(inputs)
+        outputs = await Not()(inputs)
 
         program = Program(
             inputs=inputs,
@@ -89,7 +89,7 @@ class Query(DataModel):
             "b": Input(data_model=Query),
             "c": Input(data_model=Query),
         }
-        outputs = await NoneModule()(inputs)
+        outputs = await Not()(inputs)
 
         program = Program(
             inputs=inputs,
diff --git a/synalinks/src/modules/ttc/chain_of_thought.py b/synalinks/src/modules/ttc/chain_of_thought.py
diff --git a/synalinks/src/modules/ttc/chain_of_thought_test.py b/synalinks/src/modules/ttc/chain_of_thought_test.py
diff --git a/synalinks/src/modules/ttc/self_critique.py b/synalinks/src/modules/ttc/self_critique.py
diff --git a/synalinks/src/modules/ttc/self_critique_test.py b/synalinks/src/modules/ttc/self_critique_test.py
diff --git a/synalinks/src/optimizers/opro.py b/synalinks/src/optimizers/opro.py
diff --git a/synalinks/src/optimizers/opro_test.py b/synalinks/src/optimizers/opro_test.py
diff --git a/synalinks/src/rewards/lm_as_judge.py b/synalinks/src/rewards/lm_as_judge.py
diff --git a/synalinks/src/rewards/lm_as_judge_test.py b/synalinks/src/rewards/lm_as_judge_test.py
diff --git a/synalinks/src/version.py b/synalinks/src/version.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+`
	`2`	`+::: synalinks.src.modules.core.not_module`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+`
	`2`	`+::: synalinks.src.modules.ttc.self_critique`