Replace show_result by contribute

IBM · Sep 11, 2024 · 9e28ab8 · 9e28ab8
1 parent dc9fa52
commit 9e28ab8
Show file tree

Hide file tree

Showing 65 changed files with 468 additions and 335 deletions.
diff --git a/README.md b/README.md
@@ -179,7 +179,7 @@ document:
 - read: examples/code/data.yaml
   parser: yaml
   def: CODE
-  show_result: False
+  contribute: []
 - "\n{{ CODE.source_code }}\n"
 - model: meta-llama/llama-3-70b-instruct
   input:
@@ -233,7 +233,7 @@ document:
 - read: ./data.yaml
   parser: yaml
   def: CODE
-  show_result: False
+  contribute: []
 - "\n{{ CODE.source_code }}\n"
 - model: ibm/granite-34b-code-instruct
   def: EXPLANATION
@@ -250,7 +250,7 @@ document:
       {{ CODE.source_code }}```
 - read: ./ground_truth.txt
   def: TRUTH
-  show_result: False
+  contribute: []
 - |
 
 
@@ -307,13 +307,13 @@ document:
 - read: ./data.yaml
   parser: yaml
   def: CODE
-  show_result: False
+  contribute: []
 - read: ./ground_truth.txt
   def: TRUTH
-  show_result: False
+  contribute: []
 - model: ibm/granite-34b-code-instruct
   def: EXPLANATION
-  show_result: False
+  contribute: []
   input:
      |
       Here is some info about the location of the function in the repo.
@@ -327,7 +327,7 @@ document:
       ```
       {{ CODE.source_code }}```
 - def: EVAL
-  show_result: False
+  contribute: []
   lan: python
   code:
     |

diff --git a/docs/README.md b/docs/README.md
@@ -161,7 +161,7 @@ document:
 - read: ./data.json
   parser: json
   def: CODE
-  show_result: False
+  contribute: []
 - "\n{{ CODE.source_code }}\n"
 - model: ibm/granite-20b-code-instruct-v2
   input:
@@ -215,10 +215,10 @@ document:
 - read: ./data.json
   parser: json
   def: CODE
-  show_result: False
+  contribute: []
 - read: ./ground_truth.txt
   def: TRUTH
-  show_result: False
+  contribute: []
 - "\n{{ CODE.source_code }}\n"
 - model: ibm/granite-20b-code-instruct-v2
   def: EXPLANATION
@@ -292,13 +292,13 @@ document:
 - read: ./data.json
   parser: json
   def: CODE
-  show_result: False
+  contribute: []
 - read: ./ground_truth.txt
   def: TRUTH
-  show_result: False
+  contribute: []
 - model: ibm/granite-20b-code-instruct-v2
   def: EXPLANATION
-  show_result: False
+  contribute: []
   parameters:
     decoding_method: greedy
     max_new_tokens: 1024
@@ -315,7 +315,7 @@ document:
       ```
       {{ CODE.source_code }}```
 - def: EVAL
-  show_result: False
+  contribute: []
   lan: python
   code:
     |

diff --git a/docs/tutorial.md b/docs/tutorial.md
@@ -504,7 +504,7 @@ document:
     - "\nTranslate the sentence '{{ sentence }}' to {{ language }}\n"
     - model: ibm/granite-20b-multilingual
 - call: translate
-  show_result: false
+  contribute: []
   def: FRENCH
   args:
     sentence: Hello,{{ GEN }}
@@ -532,7 +532,7 @@ document:
   - def: NAME
     document:
       - model: "ibm/granite-20b-code-instruct-v2"
-        show_result: false # <-- MISTAKE:
+        contribute: [] # <-- MISTAKE:
         # `show_result` is specified on the document,
         # resulting in an _empty_ document and thus
         # an empty `NAME`
@@ -547,7 +547,7 @@ document:
   - get: NAME
   - "`!\n"
   - def: TWO
-    show_result: false # <-- CORRECT:
+    contribute: [] # <-- CORRECT:
     # `show_result` is set at the root of the block,
     # which behaves as expected.
     document:
@@ -624,11 +624,11 @@ The following PDL program reads this content and assigns it to variable `PERSON`
 
 ```yaml
 description: Input block example with json input
+defs:
+  PERSON:
+    read: ./input.json
+    parser: json
 document:
-- read: examples/tutorial/input.json
-  parser: json
-  def: PERSON
-  show_result: false
 - "{{ PERSON.name }} lives at the following address:\n"
 - "{{ PERSON.address.number }} {{ PERSON.address.street }} in the town of {{ PERSON.address.town }}, {{ PERSON.address.state }}"
 ```
@@ -671,7 +671,7 @@ document:
 - read:
   def: QUERY
   message: "Ask a query: "
-  show_result: false
+  contribute: []
 - model: ibm/granite-20b-code-instruct-v2
   input: |-
       Question: What is the weather in London?
@@ -689,12 +689,12 @@ document:
     - '!'
     include_stop_sequence: false
   def: LOCATION
-  show_result: false
+  contribute: []
 - api: https
   url: https://api.weatherapi.com/v1/current.json?key=cf601276764642cb96224947230712&q=
   input: '{{ LOCATION }}'
   def: WEATHER
-  show_result: false
+  contribute: []
 - model: ibm/granite-20b-code-instruct-v2
   input: >
     Explain what the weather is from the following JSON:
@@ -727,13 +727,13 @@ document:
 - read: examples/code/data.json
   parser: json
   def: CODE
-  show_result: False
+  contribute: []
 - read: examples/code/ground_truth.txt
   def: TRUTH
-  show_result: False
+  contribute: []
 - model: ibm/granite-20b-code-instruct-v2
   def: EXPLANATION
-  show_result: False
+  contribute: []
   parameters:
     decoding_method: greedy
     max_new_tokens: 1024
@@ -750,7 +750,7 @@ document:
       ```
       {{ CODE.source_code }}```
 - def: EVAL
-  show_result: False
+  contribute: []
   lan: python
   code:
     |

diff --git a/examples/chatbot/chatbot.pdl b/examples/chatbot/chatbot.pdl
@@ -10,7 +10,7 @@ document:
   - read:
     def: eval
     message: "\nIs this a good answer[yes/no]?\n"
-    show_result: false
+    contribute: []
   - if: "{{ eval == 'no' }}"
     then:
       - read:

diff --git a/examples/cldk/cldk-assistant.pdl b/examples/cldk/cldk-assistant.pdl
@@ -3,11 +3,11 @@ document:
 - read:
   def: project
   message: "Please enter the path to your Java project:\n"
-  show_result: false
-- "***Analyzing..."
+  contribute: []
+- "***Analyzing...\n"
 - lan: python
   def: analysis
-  show_result: false
+  contribute: []
   code: |
     import os
     from rich import print  # Optional, for pretty printing.
@@ -30,13 +30,12 @@ document:
   - read:
     def: query
     message: "\n\nHow can I help you [Type 'quit' to quit]?\n"
-    show_result: false
+    contribute: []
   - "\n***Generating PDL code for your query:\n"
   - if: "{{ query != 'quit'}}"
     then: 
     - model: ibm/granite-20b-code-instruct
       def: PDL
-      show_result: true
       input: 
         - |
           Question: What are all the classes?
@@ -142,7 +141,7 @@ document:
         include_stop_sequence: false
     - "\n\n***Executing the above PDL code:\n\n"
     - lan: python
-      show_result: false
+      contribute: []
       code: | 
         from pdl import pdl_ast, pdl_interpreter
         from pdl.pdl_ast import Program

diff --git a/examples/code/code-eval.pdl b/examples/code/code-eval.pdl
@@ -3,7 +3,7 @@ document:
 - read: ./data.yaml
   parser: yaml
   def: CODE
-  show_result: False
+  contribute: []
 - "\n{{ CODE.source_code }}\n"
 - model: ibm/granite-34b-code-instruct
   def: EXPLANATION
@@ -20,7 +20,7 @@ document:
       {{ CODE.source_code }}```
 - read: ./ground_truth.txt
   def: TRUTH
-  show_result: False
+  contribute: []
 - |
 
 

diff --git a/examples/code/code-json.pdl b/examples/code/code-json.pdl
@@ -3,13 +3,13 @@ document:
 - read: ./data.yaml
   parser: yaml
   def: CODE
-  show_result: False
+  contribute: []
 - read: ./ground_truth.txt
   def: TRUTH
-  show_result: False
+  contribute: []
 - model: ibm/granite-34b-code-instruct
   def: EXPLANATION
-  show_result: False
+  contribute: []
   input:
      |
       Here is some info about the location of the function in the repo.
@@ -23,7 +23,7 @@ document:
       ```
       {{ CODE.source_code }}```
 - def: EVAL
-  show_result: False
+  contribute: []
   lan: python
   code:
     |

diff --git a/examples/code/code.pdl b/examples/code/code.pdl
@@ -1,9 +1,9 @@
 description: Code explanation example
+defs:
+  CODE:
+    read: ./data.yaml
+    parser: yaml
 document:
-- read: ./data.yaml
-  parser: yaml
-  def: CODE
-  show_result: False
 - "\n{{ CODE.source_code }}\n"
 - model: ibm/granite-34b-code-instruct
   input:
@@ -17,4 +17,3 @@ document:
         Explain the following code:
         ```
         {{ CODE.source_code }}```
-- "\n"
diff --git a/examples/demo/3-weather.pdl b/examples/demo/3-weather.pdl
@@ -3,7 +3,7 @@ document:
 - read:
   def: QUERY
   message: "Ask a query: "
-  show_result: false
+  contribute: []
 - model: ibm/granite-34b-code-instruct
   input: |
       Question: What is the weather in London?
@@ -20,12 +20,12 @@ document:
     - '!'
     include_stop_sequence: false
   def: LOCATION
-  show_result: false
+  contribute: []
 - api: https
   url: https://api.weatherapi.com/v1/current.json?key=cf601276764642cb96224947230712&q=
   input: '{{ LOCATION }}'
   def: WEATHER
-  show_result: false
+  contribute: []
 - model: ibm/granite-20b-code-instruct
   input: |
       Explain the weather from the following JSON.

diff --git a/examples/demo/4-arith-detector.pdl b/examples/demo/4-arith-detector.pdl
@@ -3,7 +3,7 @@ document:
 - read:
   multiline: True
   def: QUERY
-  show_result: false
+  contribute: []
 - model: ibm/granite-20b-code-instruct
   input:
     document:
@@ -37,7 +37,7 @@ document:
     - get: QUERY
     - "\n\n"
   def: QUERY1
-  show_result: false
+  contribute: []
 
 
 - model: ibm/granite-20b-code-instruct
@@ -118,7 +118,7 @@ document:
     - get: QUERY1
     - "\n\n"
   def: PDL
-  show_result: false
+  contribute: []
 
 - lan: python
   code: | 
@@ -136,5 +136,5 @@ document:
     data = Program.model_validate(obj)
     _, result, _, _ = process_prog(state, empty_scope, data)
   def: RESULT
-  show_result: false
+  contribute: []
 - "\n"
diff --git a/examples/fibonacci/fib.pdl b/examples/fibonacci/fib.pdl
@@ -11,7 +11,6 @@ document:
   code: |
     import random
     result = random.randint(1, 20)
-  show_result: true
 - "\nNow computing fib("
 - get: N
 - ")\n"
@@ -20,7 +19,7 @@ document:
   code: |
     {{ CODE }}
     result = fib({{ N }})
-  show_result: false
+  contribute: []
 - 'The result is: '
 - get: RESULT
 - "\n\nExplain what the above code does and what the result means\n\n"

diff --git a/examples/granite/multi_round_chat.pdl b/examples/granite/multi_round_chat.pdl
@@ -5,7 +5,7 @@ document:
   parser: json
   def: prompts
   spec: {prompts: [str]}
-  show_result:  false
+  contribute: []
 - "{{ SYSTEM_CONTENT_CHAT }}"
 - for:
     prompt: "{{ prompts.prompts }}"

diff --git a/examples/gsm8k/math-base.pdl b/examples/gsm8k/math-base.pdl
@@ -7,4 +7,3 @@ document:
   params:
     stop_sequences: ["Question"]
     include_stop_sequence: false
-  show_result: true