feat: rename max_iterations into maxIterations (#961)

BREAKING CHANGE

--
Signed-off-by: Louis Mandel <[email protected]>

Author: mandel

docs/tutorial.md

@@ -695,7 +695,7 @@ can also contain either a string, or a block, or a list (and similarly for `else
 The chatbot keeps looping by making a call to a model, asking the user if the generated text is a good answer,
 and asking `why not?` if the answer (stored in variable `eval`) is `no`. The loop ends when `eval` becomes `yes`. This is specified with a Jinja expression on line 18.
 
-Notice that the `repeat` and `then` blocks are followed by `text`. This is because of the semantics of lists in PDL. If we want to aggregate the result by stringifying every element in the list and collating them together, then we need the keyword `text` to precede a list. The number of iterations of a loop can be bounded by adding a `max_iterations` field.
+Notice that the `repeat` and `then` blocks are followed by `text`. This is because of the semantics of lists in PDL. If we want to aggregate the result by stringifying every element in the list and collating them together, then we need the keyword `text` to precede a list. The number of iterations of a loop can be bounded by adding a `maxIterations` field.
 
 The way that the result of each iteration is collated with other iterations can be customized in PDL using
 the `join` feature (see the following section).
@@ -804,14 +804,14 @@ The following example shows a while loop in PDL:
 
 The `while` field indicates the looping condition and `repeat` contains the body of the loop.
 
-This loop can be rewritten using `max_iterations` to bound the number of iterations and `index` to name the iteration number.
+This loop can be rewritten using `maxIterations` to bound the number of iterations and `index` to name the iteration number.
 
 ```yaml
 --8<-- "./examples/tutorial/loop_index.pdl"
 ```
 
 
-Notice that `for`, `while`, `until`, and `max_iterations` can all be combined in the same `repeat` block. The loop exits as soon as one of the exit conditions is satisfied:
+Notice that `for`, `while`, `until`, and `maxIterations` can all be combined in the same `repeat` block. The loop exits as soon as one of the exit conditions is satisfied:
 
 ```yaml
 --8<-- "./examples/tutorial/repeat.pdl"

examples/gsm8k/gsm8k-plan-few-shots.pdl

@@ -89,7 +89,7 @@ text:
       pdl_context: []
       problem: ${ problem.question }
       demos: ${ demos }
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: plans
   join:
     as: array
@@ -101,7 +101,7 @@ text:
     args:
       pdl_context: []
       plan: ${ plan }
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: solutions
   join:
     as: array
@@ -113,7 +113,7 @@ text:
     args:
       pdl_context: []
       solution: ${ solution }
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: results
   join:
     as: array
@@ -127,7 +127,7 @@ text:
       pdl_context: []
       result: ${ result }
       truth: ${ problem.answer }
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: stats
   join:
     as: array

examples/gsm8k/gsm8k-plan.pdl

@@ -74,7 +74,7 @@ text:
     args:
       pdl_context: []
       problem: ${ problem.question }
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: plans
   join:
     as: array
@@ -86,7 +86,7 @@ text:
     args:
       pdl_context: []
       plan: ${ plan }
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: solutions
   join:
     as: array
@@ -98,7 +98,7 @@ text:
     args:
       pdl_context: []
       solution: ${ solution }
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: results
   join:
     as: array
@@ -112,7 +112,7 @@ text:
       pdl_context: []
       result: ${ result }
       truth: ${ problem.answer }
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: stats
   join:
     as: array

examples/gsm8k/gsm8k-tot-few-shot.pdl

@@ -122,10 +122,10 @@ text:
         pdl_context: []
         problem: ${ problem.question }
         demos: ${ demos }
-    max_iterations: ${ N }
+    maxIterations: ${ N }
     join:
       as: array
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: plans
   join:
     as: array
@@ -141,12 +141,12 @@ text:
         args:
           pdl_context: []
           plan: ${ plan }
-      max_iterations: ${ N }
+      maxIterations: ${ N }
       join:
         as: array
     join:
       as: array
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: solutions
   join:
     as: array
@@ -164,12 +164,12 @@ text:
         args:
           pdl_context: []
           solution: ${ solution_for_problem }
-      max_iterations: ${ N }
+      maxIterations: ${ N }
       join:
         as: array
     join:
       as: array
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: results
   join:
     as: array
@@ -184,10 +184,10 @@ text:
       args: 
         pdl_context: []
         results: ${ results_for_problem }
-    max_iterations: ${ N }
+    maxIterations: ${ N }
     join:
       as: array
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: per_plan_votes
   join:
     as: array
@@ -199,7 +199,7 @@ text:
     args: 
       pdl_context: []
       numbers: ${ votes }
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   join:
     as: array
   def: results
@@ -213,7 +213,7 @@ text:
       pdl_context: []
       result: ${ result }
       truth: ${ problem.answer }
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: stats
   join:
     as: array

examples/gsm8k/gsm8k-tot-multiplan.pdl

@@ -96,10 +96,10 @@ text:
       args:
         pdl_context: []
         problem: ${ problem.question }
-    max_iterations: ${ N }
+    maxIterations: ${ N }
     join:
       as: array
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: plans
   join:
     as: array
@@ -116,7 +116,7 @@ text:
         plan: ${ plan }
     join:
       as: array
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: solutions
   join:
     as: array
@@ -133,7 +133,7 @@ text:
         solution: ${ solution_for_problem }
     join:
       as: array
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: results
   join:
     as: array
@@ -145,7 +145,7 @@ text:
     args: 
       pdl_context: []
       results: ${ results_for_problem }
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: votes
   join:
     as: array
@@ -159,7 +159,7 @@ text:
       pdl_context: []
       result: ${ result }
       truth: ${ problem.answer }
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: stats
   join:
     as: array

examples/gsm8k/gsm8k-tot.pdl

@@ -109,10 +109,10 @@ text:
       args:
         pdl_context: []
         problem: ${ problem.question }
-    max_iterations: ${ N }
+    maxIterations: ${ N }
     join:
       as: array
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: plans
   join:
     as: array
@@ -128,12 +128,12 @@ text:
         args:
           pdl_context: []
           plan: ${ plan }
-      max_iterations: ${ N }
+      maxIterations: ${ N }
       join:
         as: array
     join:
       as: array
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: solutions
   join:
     as: array
@@ -151,12 +151,12 @@ text:
         args:
           pdl_context: []
           solution: ${ solution_for_problem }
-      max_iterations: ${ N }
+      maxIterations: ${ N }
       join:
         as: array
     join:
       as: array
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: results
   join:
     as: array
@@ -171,10 +171,10 @@ text:
       args: 
         pdl_context: []
         results: ${ results_for_problem }
-    max_iterations: ${ N }
+    maxIterations: ${ N }
     join:
       as: array
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: per_plan_votes
   join:
     as: array
@@ -186,7 +186,7 @@ text:
     args: 
       pdl_context: []
       numbers: ${ votes }
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   join:
     as: array
   def: results
@@ -200,7 +200,7 @@ text:
       pdl_context: []
       result: ${ result }
       truth: ${ problem.answer }
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: stats
   join:
     as: array

examples/skeleton-of-thought/tips.pdl

@@ -58,7 +58,7 @@ text:
       pdl_context: []
   join:
     as: array
-  max_iterations: ${ MAX_ITERATIONS }
+  maxIterations: ${ MAX_ITERATIONS }
   def: skeletons
 - "\n\n"
 - for:

examples/tutorial/loop_index.pdl

@@ -1,4 +1,4 @@
 index: i
 repeat:
   text: ${i + 1}
-max_iterations: 3
+maxIterations: 3

examples/tutorial/repeat.pdl

@@ -11,4 +11,4 @@ index: i
 repeat:
   "${i}: ${ name }'s number is ${ number }\n"
 until: ${ name == "Carol"}
-max_iterations: 3
+maxIterations: 3

pdl-live-react/src/pdl_ast.d.ts

@@ -1510,7 +1510,7 @@ export type Until = LocalizedExpression | boolean | string
  * Maximal number of iterations to perform.
  *
  */
-export type MaxIterations = LocalizedExpression | number | string | null
+export type Maxiterations = LocalizedExpression | number | string | null
 /**
  * Define how to combine the result of each iteration.
  *
@@ -3806,7 +3806,7 @@ export interface Defs9 {
  * Bounded loop:
  * ```PDL
  * index: i
- * max_iterations: 5
+ * maxIterations: 5
  * repeat:
  *     ${ i }
  * join:
@@ -3859,7 +3859,7 @@ export interface RepeatBlock {
   while?: While
   repeat: Repeat
   until?: Until
-  max_iterations?: MaxIterations
+  maxIterations?: Maxiterations
   join?: Join
   pdl__trace?: PdlTrace2
 }