Change loop combination default and syntax (#107)

Author: mandel

docs/tutorial.md

@@ -480,7 +480,6 @@ text:
       parameters:
         decoding_method: sample
         max_new_tokens: 512
-  as: text
 role: user
 ```
 
@@ -557,13 +556,11 @@ text:
               code: result = ${ EXPR }
             - ' >>'
       until: ${ "The answer is" in REASON_OR_CALC }
-      as: text
     - "\n\n"
-  as: text
   num_iterations: 3
 ```
 
-The first two blocks read math problem examples and include them in the document. These will be our few-shot examples. The next block is a repetion as indicated by the fields: `repeat` and the accompanying `num_iterations`. The field `repeat` can contain any document (string or block or list of strings and blocks), the `num_iterations` indicates how many times to repeat.
+The first two blocks read math problem examples and include them in the document. These will be our few-shot examples. The next block is a repetition as indicated by the fields: `repeat` and the accompanying `num_iterations`. The field `repeat` can contain any document (string or block or list of strings and blocks), the `num_iterations` indicates how many times to repeat.
 
 In the body of the `repeat` block, the program first asks granite to generate a question and add it to the document. Next we print `Answer: Let's think step by step.\n`. The following block is a repeat-until: the text in `repeat` is repeated until the condition in the `until` field becomes true. Here the condition states that we stop the iteration when variable `REASON_OR_CALC` contains `<<`. That variable is defined in the first block of the repeat-until -- we prompt a granite model and stop at the character `<<`.
 
@@ -578,66 +575,72 @@ Similarly, the `read` block has an annotation `as: text`. This means that the re
 ## For Loops
 
 PDL also offers `for` loops over lists.
-The following [example](https://github.com/IBM/prompt-declaration-language//blob/main/examples/tutorial/for.pdl) creates a list as a result of iteration.
+The following [example](https://github.com/IBM/prompt-declaration-language//blob/main/examples/tutorial/for.pdl) stringifies and outputs each number.
 
 ```
 description: for loop
-text:
-- for:
-    i: [1, 2, 3, 4]
-  repeat: 
-    ${ i }
+for:
+  i: [1, 2, 3, 4]
+repeat: 
+  ${ i }
 ```
 
-This program outputs the following list:
+This program outputs:
 ```
-[1, 2, 3, 4]
+1234
 ```
 
-To stringify and output each number on a line, we would write:
+To output a number of each line, we can specify which string to use to join the results.
 ```
 description: for loop
-text:
-- for:
-    i: [1, 2, 3, 4]
-  repeat: 
-    text:
-    - ${ i }
-    - "\n"
-  as: text
+for:
+  i: [1, 2, 3, 4]
+repeat: 
+  ${ i }
+join:
+  with: "\n"
 ```
 
-which outputs:
-
 ```
 1
 2
 3
 4
+```
+
 
+To creates an array as a result of iteration, we would write:
+```
+description: for loop
+for:
+  i: [1, 2, 3, 4]
+repeat: 
+  - ${ i }
+join:
+  as: array
 ```
 
+which outputs the following list:
+```
+[1, 2, 3, 4]
+```
+
+
 
 The `for` loop constructs also allows iterating over 2 or more lists of the same length simultaneously:
 
 ```
 description: for loop
 defs:
-  numbers: {
+  numbers:
     data: [1, 2, 3, 4]
-  }
-  names: {
+  names:
     data: ["Bob", "Carol", "David", "Ernest"]
-  }
-
-text:
-- for:
-    number: ${ numbers }
-    name: ${ names }
-  repeat:
-    text:
-      "${ name }'s number is ${ number }\n"
-  as: text
+for:
+  number: ${ numbers }
+  name: ${ names }
+repeat:
+  "${ name }'s number is ${ number }\n"
 ```
 
 This results in the following output:
@@ -675,7 +678,6 @@ text:
           - |
             ${ question }
             ${ answer }
-        as: text
       - > 
         Question: Create a JSON object with fields 'name' and 'age' 
         and set them appropriately. Write the age in letters.

examples/arith/Arith-simple.pdl

@@ -39,6 +39,5 @@ text:
           lan: python
           code: result = ${ EXPR }
         - ' >>'
-  as: text
   until: ${ "The answer is" in REASON_OR_CALC }
 - "\n"

examples/arith/arith.pdl

@@ -39,7 +39,5 @@ text:
               code: result = ${ EXPR }
             - ' >>'
       until: ${ "The answer is" in REASON_OR_CALC }
-      as: text
     - "\n\n"
-  as: text
   num_iterations: 3

examples/chatbot/chatbot.pdl

@@ -15,7 +15,6 @@ text:
         - read:
           message: "Why not?\n"
   until: ${ eval == 'yes'}
-  as: text
 role: user
 
 

examples/demo/1-gen-data.pdl

@@ -17,7 +17,6 @@ text:
           - |
             ${ question }
             ${ answer }
-        as: text
       - > 
         Question: Create a JSON object with fields 'name' and 'age' 
         and set them appropriately. Write the age in letters.

examples/demo/2-teacher.pdl

@@ -80,6 +80,8 @@ defs:
           icl_question: ${icl_question}
           icl_answer: ${icl_answer}
           question: ${question}
+      join:
+        as: array
 
   gen_questions_freeform:
     function:
@@ -98,6 +100,8 @@ defs:
               task_description: ${task_description}
               icl_question: ${example.question}
               icl_answer: ${example.answer}
+          join:
+            as: array
     - lan: python
       code: | # flatten list_of_lists into simple list
           result = [q for qs in ${list_of_lists} for q in qs]
@@ -181,6 +185,8 @@ defs:
           - data:
               question: ${question}
               keep: ${filter_output}
+          join:
+            as: array
         filtered:
           lan: python
           code: | # keep only if "keep" column is non-zero
@@ -274,6 +280,8 @@ defs:
             call: gen_answers_inner
             args:
               question: ${question}
+          join:
+            as: array
     - lan: python
       spec: [{question: str, answer: str}]
       code: | # keep only if answer non-empty
@@ -358,6 +366,8 @@ defs:
           - data:
               qa_pair: ${qa_pair}
               rating: ${filter_output}
+          join:
+            as: array
         filtered:
           lan: python
           spec: [{question: str, answer: str}]

examples/demo/4-translator.pdl

@@ -17,4 +17,3 @@ text:
         - "\n\nTranslate the above to ${ language }"
         - model: watsonx/ibm/granite-13b-chat-v2
   until: ${ language == 'stop' }
-  as: text

examples/granite/multi_round_chat.pdl

@@ -17,5 +17,4 @@ text:
       parameters:
         decoding_method: sample
         max_new_tokens: 512
-  as: text
 role: user

examples/hello/hello-for-loop.pdl

@@ -9,4 +9,4 @@ for:
   name: ${ names }
 repeat:
   "${ name }'s number is ${ number }\n"
-as: text
+

examples/hello/hello-iteration.pdl

@@ -4,5 +4,4 @@ text:
 - "\n"
 - repeat:
       "This is your first PDL program\n"
-  as: text
   num_iterations: 3

examples/hello/hello-parser-json.pdl

@@ -17,7 +17,6 @@ text:
           - |
             ${ question }
             ${ answer }
-        as: text
       - > 
         Question: Create a JSON object with fields 'name' and 'age' 
         and set them appropriately.

examples/joke/Joke.pdl

@@ -27,4 +27,3 @@ text:
         include_stop_sequence: true
     - "\n"
   num_iterations: 2
-  as: text

examples/multi-agent/react-fun.pdl

@@ -57,5 +57,4 @@ defs:
                   except wikipedia.WikipediaException as e:
                     result = str(e)
         until: ${ action.name != "Search" }
-        as: text
 

examples/oddOneOut/OddOneOut.pdl

@@ -35,4 +35,3 @@ text:
         include_stop_sequence: false
     - "\n\n"
   num_iterations: 2
-  as: text

examples/react/react_fun.pdl

@@ -11,7 +11,6 @@ defs:
           ex: ${ examples }
         repeat:
           "${ ex }\n"
-        as: text
       - "\n"
       - ${ question }
       - "\n"
@@ -66,7 +65,6 @@ defs:
             contribute: []
             data: ${ action }
         until: ${ action.name == "Finish" or exit }
-        as: text
 
   react:
     function:

examples/react/wikipedia.pdl

@@ -48,5 +48,4 @@ text:
             except wikipedia.WikipediaException as e:
               result = str(e)
   until: ${ action.name != "Search" }
-  as: text
 - "\n"

examples/talk/5-chatbot-roles.pdl

@@ -6,14 +6,11 @@ text:
   text: ${ SYSTEM_CONTENT_CHAT }
 - "Type `quit` to exit this chatbot.\n"
 - repeat:
-    text:
-    - read:
-      message: ">>> "
-      def: query
-      contribute: [context]
-    - model: watsonx/ibm/granite-13b-chat-v2
-    - "\n\n"
+  - read:
+    message: ">>> "
+    def: query
+  - model: watsonx/ibm/granite-13b-chat-v2
   until: ${ query == 'quit'}
-  as: text
+  join:
+    with: "\n\n"
 role: user
-

examples/talk/7-react.pdl

@@ -49,5 +49,4 @@ text:
             except wikipedia.WikipediaException as e:
               result = str(e)
   until: '${ action.name != "Search" }'
-  as: text
 

examples/talk/8-sdg.pdl

@@ -81,6 +81,8 @@ defs:
           icl_question: ${icl_question}
           icl_answer: ${icl_answer}
           question: ${question}
+      join:
+        as: array
 
   gen_questions_freeform:
     function:
@@ -99,6 +101,8 @@ defs:
               task_description: ${task_description}
               icl_question: ${example.question}
               icl_answer: ${example.answer}
+          join:
+            as: array
     - lan: python
       code: | # flatten list_of_lists into simple list
           result = [q for qs in ${list_of_lists} for q in qs]
@@ -182,6 +186,8 @@ defs:
           - data:
               question: ${question}
               keep: ${filter_output}
+          join:
+            as: array
         filtered:
           lan: python
           code: | # keep only if "keep" column is non-zero
@@ -275,6 +281,8 @@ defs:
             call: gen_answers_inner
             args:
               question: ${question}
+          join:
+            as: array
     - lan: python
       spec: [{question: str, answer: str}]
       code: | # keep only if answer non-empty
@@ -359,6 +367,8 @@ defs:
           - data:
               qa_pair: ${qa_pair}
               rating: ${filter_output}
+          join:
+            as: array
         filtered:
           lan: python
           spec: [{question: str, answer: str}]