Skip to content

Commit 5ff37b3

Browse files
committed
Fix useful typo
1 parent 1c081cf commit 5ff37b3

File tree

13 files changed

+35
-36
lines changed

13 files changed

+35
-36
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Developping a successful LM application in a profesional context, beyond statele
4646
- **Ensuring the correctness of the LMs output**: Synalinks combines constrained structured output with In-Context RL to ensure both format and content correctness.
4747
- **Optimizing async processes**: Synalinks automatically optimizes your pipelines by detecting parallel processes.
4848
- **Assessing the performance of your application**: Synalinks provides built-in metrics and rewards to evaluate your workflows.
49-
- **Configuring Language & Embedding Models**: Seamlessly integrate multiple LM providers like Ollama, OpenAI, Anthropic, or Groq.
49+
- **Configuring Language & Embedding Models**: Seamlessly integrate multiple LM providers like Ollama, OpenAI, Anthropic, Mistral or Groq.
5050
- **Documenting your ML workflows**: Plot your workflows, training history, and evaluations; document everything.
5151
- **Versioning the prompts/pipelines**: Each program is serializable into JSON so you can version it with git.
5252
- **Deploying REST APIs**: Compatible out-of-the-box with FastAPI so your Data Scientists and Web Developers can stop tearing each other apart.
@@ -101,7 +101,7 @@ async def main():
101101
inputs=x0,
102102
outputs=x1,
103103
name="chain_of_thought",
104-
description="Usefull to answer in a step by step manner.",
104+
description="Useful to answer in a step by step manner.",
105105
)
106106

107107
if __name__ == "__main__":
@@ -133,7 +133,7 @@ async def main():
133133
)
134134

135135
class ChainOfThought(synalinks.Program):
136-
"""Usefull to answer in a step by step manner.
136+
"""Useful to answer in a step by step manner.
137137
138138
The first line of the docstring is provided as description
139139
for the program if not provided in the `super().__init__()`.
@@ -230,7 +230,7 @@ async def main():
230230
),
231231
],
232232
name="chain_of_thought",
233-
description="Usefull to answer in a step by step manner.",
233+
description="Useful to answer in a step by step manner.",
234234
)
235235

236236
if __name__ == "__main__":
@@ -245,7 +245,7 @@ To print a tabular summary of your program:
245245
program.summary()
246246
```
247247

248-
Or a plot (usefull to document your system):
248+
Or a plot (Useful to document your system):
249249

250250
```python
251251
synalinks.utils.plot_program(

docs/FAQ.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Likewise, cached dataset files, such as those downloaded with `get_file()`, are
119119

120120
### How should I cite Synalinks?
121121

122-
Please cite Synalinks if it is usefull in your research. Here is the bibtex entry to use:
122+
Please cite Synalinks if it is Useful in your research. Here is the bibtex entry to use:
123123

124124
```bibtex
125125
@misc{sallami2025synalinks,
@@ -142,7 +142,7 @@ We provide consulting, development and technical support for companies that want
142142

143143
- **Sample**: A sample is one element of a dataset. For example, one DataModel is one sample.
144144
- **Batch**: A batch is a set of N samples. The samples in a batch are processed independently, in parallel. During training, a batch result in only one program update. A batch approximates the input distribution better than a single input. The larger the batch, the better the approximation; however a larger batch will take longer to process and still result in only one update.
145-
- **Epochs**: A epochs is an arbitrarly cutoff, generally defined as "one pass over the entire dataset", used to separate training into distinct phases, which is usefull for logging and periodic evaluation. When using `validation_split` or `validation_data` with the `fit` method of Synalinks programs, evaluation will be run at the end of every epoch.
145+
- **Epochs**: A epochs is an arbitrarly cutoff, generally defined as "one pass over the entire dataset", used to separate training into distinct phases, which is Useful for logging and periodic evaluation. When using `validation_split` or `validation_data` with the `fit` method of Synalinks programs, evaluation will be run at the end of every epoch.
146146

147147
---
148148

docs/Synalinks API/Built-in Datasets/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
The `synalinks.datasets` module provide a few datasets that can be used to debugging, evaluation or to create code examples.
44

5-
These datasets are leaked in nowadays LMs training data, which is a big concern in todays ML community, so they won't give you much information about the reasoning abilities of the underlying models. But they are still usefull as baseline to compare neuro-symbolic methods or when using small language models.
5+
These datasets are leaked in nowadays LMs training data, which is a big concern in todays ML community, so they won't give you much information about the reasoning abilities of the underlying models. But they are still useful as baseline to compare neuro-symbolic methods or when using small language models.
66

77
---
88

9-
- [GSM8K dataset](GSM8K.md): A dataset of 8.5K high quality linguistically diverse grade school math word problems. Usefull to evaluate reasoning capabilities.
9+
- [GSM8K dataset](GSM8K.md): A dataset of 8.5K high quality linguistically diverse grade school math word problems. Useful to evaluate reasoning capabilities.
1010

11-
- [ARC-AGI dataset](ARC-AGI.md): A dataset of 400 different tasks about general artificial intelligence, as a program synthesis benchmark. Usefull to evaluate general reasoning abilities and program synthesis applications.
11+
- [ARC-AGI dataset](ARC-AGI.md): A dataset of 400 different tasks about general artificial intelligence, as a program synthesis benchmark. Useful to evaluate general reasoning abilities and program synthesis applications.

docs/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ async def main():
4848
inputs=x0,
4949
outputs=x1,
5050
name="chain_of_thought",
51-
description="Usefull to answer in a step by step manner.",
51+
description="Useful to answer in a step by step manner.",
5252
)
5353

5454
if __name__ == "__main__":
@@ -80,7 +80,7 @@ async def main():
8080
)
8181

8282
class ChainOfThought(synalinks.Program):
83-
"""Usefull to answer in a step by step manner.
83+
"""Useful to answer in a step by step manner.
8484
8585
The first line of the docstring is provided as description
8686
for the program if not provided in the `super().__init__()`.
@@ -177,7 +177,7 @@ async def main():
177177
),
178178
],
179179
name="chain_of_thought",
180-
description="Usefull to answer in a step by step manner.",
180+
description="Useful to answer in a step by step manner.",
181181
)
182182

183183
if __name__ == "__main__":
@@ -192,7 +192,7 @@ To print a tabular summary of your program:
192192
program.summary()
193193
```
194194

195-
Or a plot (usefull to document your system):
195+
Or a plot (Useful to document your system):
196196

197197
```python
198198
synalinks.utils.plot_program(

synalinks/src/modules/agents/react.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,6 @@ def __init__(
180180
)
181181

182182
def build(self, inputs_schema):
183-
print(f"call build with: {inputs_schema}")
184183
inputs = Input(schema=inputs_schema)
185184
asyncio.get_event_loop().run_until_complete(self.initialize(inputs))
186185
self.built = True

synalinks/src/modules/core/branch.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ class AnswerWithCritique(synalinks.DataModel):
5757
inputs=x0,
5858
outputs=x3,
5959
name="adaptative_chain_of_thought",
60-
description="Usefull to answer step by step only when needed",
60+
description="Useful to answer step by step only when needed",
6161
)
6262
6363
if __name__ == "__main__":

synalinks/src/modules/core/branch_test.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class AnswerWithCritique(DataModel):
4949
inputs=x0,
5050
outputs=x3,
5151
name="adaptative_chain_of_thought",
52-
description="Usefull to answer step by step only when needed",
52+
description="Useful to answer step by step only when needed",
5353
)
5454

5555
decision_response = (

synalinks/src/modules/core/generator.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ class AnswerWithCritique(synalinks.DataModel):
167167
inputs=x0,
168168
outputs=x1,
169169
name="chain_of_thought_with_critique",
170-
description="Usefull to answer step by step and evaluate your answer",
170+
description="Useful to answer step by step and evaluate your answer",
171171
)
172172
173173
if __name__ == "__main__":

synalinks/src/programs/program.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class AnswerWithRationale(synalinks.DataModel):
5252
inputs=x0,
5353
outputs=x1,
5454
name="chain_of_thought",
55-
description="Usefull to answer in a step by step manner.",
55+
description="Useful to answer in a step by step manner.",
5656
)
5757
5858
if __name__ == "__main__":
@@ -81,7 +81,7 @@ class AnswerWithRationale(synalinks.DataModel):
8181
answer: str
8282
8383
class ChainOfThought(synalinks.Program):
84-
\"""Usefull to answer in a step by step manner.
84+
\"""Useful to answer in a step by step manner.
8585
8686
The first line of the docstring is provided as description for the program
8787
if not provided in the `super().__init__()`. In a similar way the name is
@@ -143,7 +143,7 @@ class AnswerWithRationale(synalinks.DataModel):
143143
),
144144
],
145145
name="chain_of_thought",
146-
description="Usefull to answer in a step by step manner.",
146+
description="Useful to answer in a step by step manner.",
147147
)
148148
149149
if __name__ == "__main__":

synalinks/src/programs/program_test.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ class AnswerWithRationale(DataModel):
3535
inputs=x0,
3636
outputs=x1,
3737
name="chain_of_thought",
38-
description="Usefull to answer in a step by step manner.",
38+
description="Useful to answer in a step by step manner.",
3939
)
4040

4141
state_tree = program.get_state_tree()
@@ -77,7 +77,7 @@ class AnswerWithRationale(DataModel):
7777
inputs=x0,
7878
outputs=x1,
7979
name="chain_of_thought",
80-
description="Usefull to answer in a step by step manner.",
80+
description="Useful to answer in a step by step manner.",
8181
)
8282

8383
state_tree = program.get_state_tree()
@@ -107,7 +107,7 @@ class AnswerWithRationale(DataModel):
107107
inputs=x0,
108108
outputs=x1,
109109
name="chain_of_thought",
110-
description="Usefull to answer in a step by step manner.",
110+
description="Useful to answer in a step by step manner.",
111111
)
112112

113113
program.compile(
@@ -157,7 +157,7 @@ class AnswerWithRationale(DataModel):
157157
inputs=x0,
158158
outputs=x1,
159159
name="chain_of_thought",
160-
description="Usefull to answer in a step by step manner.",
160+
description="Useful to answer in a step by step manner.",
161161
)
162162

163163
program.compile(
@@ -193,7 +193,7 @@ class AnswerWithRationale(DataModel):
193193
inputs=x0,
194194
outputs=x1,
195195
name="chain_of_thought",
196-
description="Usefull to answer in a step by step manner.",
196+
description="Useful to answer in a step by step manner.",
197197
)
198198

199199
program.compile(
@@ -233,7 +233,7 @@ class AnswerWithRationale(DataModel):
233233
inputs=x0,
234234
outputs=x1,
235235
name="chain_of_thought",
236-
description="Usefull to answer in a step by step manner.",
236+
description="Useful to answer in a step by step manner.",
237237
)
238238

239239
program.compile(
@@ -276,7 +276,7 @@ class AnswerWithRationale(DataModel):
276276
inputs=x0,
277277
outputs=x1,
278278
name="chain_of_thought",
279-
description="Usefull to answer in a step by step manner.",
279+
description="Useful to answer in a step by step manner.",
280280
)
281281

282282
program.compile(

0 commit comments

Comments
 (0)