WEAT - Revision history

Peterb at 21:37, 6 April 2024

2024-04-06T21:37:11Z

Peterb at 21:34, 6 April 2024

2024-04-06T21:34:50Z

Peterb at 21:33, 6 April 2024

2024-04-06T21:33:31Z

Peterb at 21:30, 6 April 2024

2024-04-06T21:30:31Z

Mhassany at 14:31, 4 April 2024

2024-04-04T14:31:07Z

Mhassany: changed image sizes

2024-04-02T04:45:25Z

changed image sizes

Mhassany at 22:15, 1 April 2024

2024-04-01T22:15:39Z

Mhassany at 22:14, 1 April 2024

2024-04-01T22:14:28Z

Mhassany: added video tutorial

2024-04-01T22:09:40Z

added video tutorial

Mhassany: fix images ref

2024-04-01T22:02:10Z

fix images ref

@@ Line 1: / Line 1: @@
 The '''Worked Example Authoring Tool (WEAT)''' is an innovative tool designed to facilitate the creation of worked examples for programming education through a ''human-AI collaboration'' approach. By integrating ChatGPT, WEAT assists instructors in generating line-by-line explanations for code examples in Java and Python. Instructors can provide the code and problem statement, and WEAT uses ChatGPT to generate explanations for each line of code. These explanations can then be reviewed, edited, and added into the worked examples, streamlining the process of creating educational programming materials.
-−
-===Try WEAT===
+== Try WEAT ==
 [http://adapt2.sis.pitt.edu/pcex-authoring/ <u>Click here</u>] to access the '''WEAT''', use your account credentials and login into the tool or create an account if you don't have one (''please send an email to Mohammad Hassany [[mailto:moh70@pitt.edu moh70@pitt.edu]] to activate your account'').
@@ Line 7: / Line 7: @@
 Please [https://youtu.be/IOfA0Ql3Zq0 <u>watch this video tutorial</u>] or read the [[WEAT_Tutorial|<u>user manual</u>]] to learn more about our tool.
-===WEAT Interface===
+== WEAT Interface ==
 [[File:weat_image8.png|768px]]
@@ Line 13: / Line 13: @@
 Worked Example Authoring Tool: Hub Page.
-===Publications===
+== Publications ==
 * Hassany, M., Brusilovsky, P., Ke, J., Akhuseyinoglu, K., and Lekshmi Narayanan, A. B. (2023) Authoring Worked Examples for Java Programming with Human-AI Collaboration,  Report No. arXiv:2312.02105, arXiv.
 * Hassany, M., Brusilovsky, P., Ke, J., Akhuseyinoglu, K., and Lekshmi Narayanan, A. B. (2024) Human-AI Co-Creation of Worked Examples for Programming Classes. In:  Proceedings of 5th Workshop on Human-AI Co-Creation with Generative Models (HA-GEN 20224) at IUI 2024, Greenville, SC, USA, March 18, 2024.
 * Hassany, M., Brusilovsky, P., Ke, J., Akhuseyinoglu, K., and Lekshmi Narayanan, A. B. (2024) Authoring Worked Examples for Java Programming with Human-AI Collaboration. In:  Proceedings of ACM/SIGAPP Symposium on Applied Computing, SAC 2024, Avila, Spain, April 8-12, 2024.

@@ Line 1: / Line 1: @@
 The '''Worked Example Authoring Tool (WEAT)''' is an innovative tool designed to facilitate the creation of worked examples for programming education through a ''human-AI collaboration'' approach. By integrating ChatGPT, WEAT assists instructors in generating line-by-line explanations for code examples in Java and Python. Instructors can provide the code and problem statement, and WEAT uses ChatGPT to generate explanations for each line of code. These explanations can then be reviewed, edited, and added into the worked examples, streamlining the process of creating educational programming materials.
-==Try WEAT==
+===Try WEAT===
 [http://adapt2.sis.pitt.edu/pcex-authoring/ <u>Click here</u>] to access the '''WEAT''', use your account credentials and login into the tool or create an account if you don't have one (''please send an email to Mohammad Hassany [[mailto:moh70@pitt.edu moh70@pitt.edu]] to activate your account'').
@@ Line 7: / Line 7: @@
 Please [https://youtu.be/IOfA0Ql3Zq0 <u>watch this video tutorial</u>] or read the [[WEAT_Tutorial|<u>user manual</u>]] to learn more about our tool.
-==WEAT Interface==
+===WEAT Interface===
 [[File:weat_image8.png|768px]]
@@ Line 13: / Line 13: @@
 Worked Example Authoring Tool: Hub Page.
-== Publications ==
+===Publications===
 * Hassany, M., Brusilovsky, P., Ke, J., Akhuseyinoglu, K., and Lekshmi Narayanan, A. B. (2023) Authoring Worked Examples for Java Programming with Human-AI Collaboration,  Report No. arXiv:2312.02105, arXiv.
 * Hassany, M., Brusilovsky, P., Ke, J., Akhuseyinoglu, K., and Lekshmi Narayanan, A. B. (2024) Human-AI Co-Creation of Worked Examples for Programming Classes. In:  Proceedings of 5th Workshop on Human-AI Co-Creation with Generative Models (HA-GEN 20224) at IUI 2024, Greenville, SC, USA, March 18, 2024.
 * Hassany, M., Brusilovsky, P., Ke, J., Akhuseyinoglu, K., and Lekshmi Narayanan, A. B. (2024) Authoring Worked Examples for Java Programming with Human-AI Collaboration. In:  Proceedings of ACM/SIGAPP Symposium on Applied Computing, SAC 2024, Avila, Spain, April 8-12, 2024.

@@ Line 1: / Line 1: @@
 The '''Worked Example Authoring Tool (WEAT)''' is an innovative tool designed to facilitate the creation of worked examples for programming education through a ''human-AI collaboration'' approach. By integrating ChatGPT, WEAT assists instructors in generating line-by-line explanations for code examples in Java and Python. Instructors can provide the code and problem statement, and WEAT uses ChatGPT to generate explanations for each line of code. These explanations can then be reviewed, edited, and added into the worked examples, streamlining the process of creating educational programming materials.
-== Try WEAT ==
+==Try WEAT==
 [http://adapt2.sis.pitt.edu/pcex-authoring/ <u>Click here</u>] to access the '''WEAT''', use your account credentials and login into the tool or create an account if you don't have one (''please send an email to Mohammad Hassany [[mailto:moh70@pitt.edu moh70@pitt.edu]] to activate your account'').
 Please [https://youtu.be/IOfA0Ql3Zq0 <u>watch this video tutorial</u>] or read the [[WEAT_Tutorial|<u>user manual</u>]] to learn more about our tool.
 [[File:weat_image8.png|768px]]

@@ Line 1: / Line 1: @@
 The '''Worked Example Authoring Tool (WEAT)''' is an innovative tool designed to facilitate the creation of worked examples for programming education through a ''human-AI collaboration'' approach. By integrating ChatGPT, WEAT assists instructors in generating line-by-line explanations for code examples in Java and Python. Instructors can provide the code and problem statement, and WEAT uses ChatGPT to generate explanations for each line of code. These explanations can then be reviewed, edited, and added into the worked examples, streamlining the process of creating educational programming materials.
 [http://adapt2.sis.pitt.edu/pcex-authoring/ <u>Click here</u>] to access the '''WEAT''', use your account credentials and login into the tool or create an account if you don't have one (''please send an email to Mohammad Hassany [[mailto:moh70@pitt.edu moh70@pitt.edu]] to activate your account'').
@@ Line 8: / Line 10: @@
 Worked Example Authoring Tool: Hub Page.

@@ Line 1: / Line 1: @@
 The '''Worked Example Authoring Tool (WEAT)''' is an innovative tool designed to facilitate the creation of worked examples for programming education through a ''human-AI collaboration'' approach. By integrating ChatGPT, WEAT assists instructors in generating line-by-line explanations for code examples in Java and Python. Instructors can provide the code and problem statement, and WEAT uses ChatGPT to generate explanations for each line of code. These explanations can then be reviewed, edited, and added into the worked examples, streamlining the process of creating educational programming materials.
-This tool consists of three important pages:
+[http://adapt2.sis.pitt.edu/pcex-authoring/ <u>Click here</u>] to access the '''WEAT''', use your account credentials and login into the tool or create an account if you don't have one (''please send an email to Mohammad Hassany [[mailto:moh70@pitt.edu moh70@pitt.edu]] to activate your account'').
-<ol style="list-style-type: decimal;">
+Please [https://youtu.be/IOfA0Ql3Zq0 <u>watch this video tutorial</u>] or read the [[WEAT_Tutorial|<u>user manual</u>]] to learn more about our tool.
 [[File:weat_image8.png|768px]]
-Fig 13) PCEX Authoring Tool: Hub Page.
+Worked Example Authoring Tool: Hub Page.

@@ Line 11: / Line 11: @@
 After opening the [http://adapt2.sis.pitt.edu/pcex-authoring/ <u>PCEX Authoring Tool</u>] ([https://youtu.be/IOfA0Ql3Zq0 Video Tutorial]), you will land on the ''Hub'' page. Click '''Login''', provide your account credentials and login into the tool. Then you will be redirected back to the ''Hub'' page.
-[[File:weat_image8.png|936px]]
+[[File:weat_image8.png|768px]]
 Fig 1) PCEX Authoring Tool: Hub Page.
@@ Line 20: / Line 20: @@
 In the ''Hub'' page, click on the navbar, then click on &quot;Sources&quot; to navigate to ''Sources'' page.
-[[File:weat_image21.png|936px]]
+[[File:weat_image21.png|768px]]
 Fig 2) PCEX Authoring Tool: Hub Page - when user is logged in.
@@ Line 26: / Line 26: @@
 This page contains the list of sources you have created. Click &quot;'''New Source'''&quot; to create a new source.
-[[File:weat_image18.png|936px]]
+[[File:weat_image18.png|768px]]
 Fig 3) PCEX Authoring Tool: List of defined sources.
@@ Line 32: / Line 32: @@
 A source has a title, problem description, and line-by-line annotated source code. Problem description can have multilines. Each line in the source code can be annotated either by providing explanations for it and/or marked as blank line.
-[[File:weat_image23.png|936px]]
+[[File:weat_image23.png|768px]]
 Fig 4) PCEX Authoring Tool: Creating a source (e.g: Hello World!).
@@ Line 38: / Line 38: @@
 In a PCEX challenge, a blank line creates a parson-style problem that can be filled by the student with available distractors (check Figure 5). A distractor can be defined in the &quot;'''Distractors'''&quot; section when creating or editing a source.
-[[File:weat_image1.png|936px]]
+[[File:weat_image1.png|768px]]
 Fig 5) PCEX Authoring Tool: A PCEX challenge preview.
-[[File:weat_image25.png|936px]]
+[[File:weat_image25.png|768px]]
 Fig 6) PCEX Authoring Tool: Define distractors (bottom section) for blank lines.
@@ Line 52: / Line 52: @@
 As described in the user interface, these explanations can be dragged by the bars into the Annotations panel to be used/added to the currently selected line (check Figure 8). By default, previously generated explanations for the currently selected line are shown; click the &quot;'''show all lines'''&quot; to show all generated explanations. In the history panel click on another date/time to load explanations specific to that generation session.
-[[File:weat_image26.jpg|936px]]
+[[File:weat_image26.jpg|768px]]
 Fig 7) Source Editor: ChatGPT Generated-Explanations (History).
-[[File:weat_image22.png|936px]]
+[[File:weat_image22.png|768px]]
 Fig 8) Source Editor: Dragging previously generated explanations from history into the Annotations panel.
@@ Line 64: / Line 64: @@
 In the Annotations panel, explanations can be dragged by the bars. Drag and drop an explanation on another explanation to change their order, or hold &quot;'''alt'''&quot; key while dropping to append/merge them together, or drop the explanation on to the red trash can area to remove it (you will be asked to confirm this action since it is irreversible).
-[[File:weat_image20.png|936px]]
+[[File:weat_image20.png|768px]]
 Fig 9) Source Editor: Drag explanations to reorder, merge or remove.
@@ Line 70: / Line 70: @@
 In case you want to merge, cut, copy, or delete multiple explanations, click on the [[File:weat_image12.png|33x30px]] button to see more actions. Select explanations by clicking either the &quot;'''Select'''&quot; (to start the selection, then click on the[[File:weat_image15.png|22x20px]]checkboxes next to explanations to select), or &quot;'''Select all'''&quot; to select all the explanations. Then you can cut, copy, and delete the selected explanations.
-[[File:weat_image19.png|936px]]
+[[File:weat_image19.png|768px]]
 Fig 10) Source Editor: Annotations panel more actions.
@@ Line 79: / Line 79: @@
 This page contains the list of activities you have created. Click &quot;'''New Activity'''&quot; to create a new activity.
-[[File:weat_image7.png|936px]]
+[[File:weat_image7.png|768px]]
 Fig 11) PCEX Authoring Tool: List of defined activities.
@@ Line 87: / Line 87: @@
 After creating/updating a source or activity, click the preview button to ensure the activity is processed (/cached) and can be previewed by students later.
-[[File:weat_image16.png|936px]]
+[[File:weat_image16.png|768px]]
 Fig 12) PCEX Authoring Tool: Creating an activity(e.g: HelloWorld!).
@@ Line 96: / Line 96: @@
 This page lists all publicly shared activities by different authors. You can click on the title to preview the activity, or click the open-in-new-tab icon next to the title to open it in a new tab (this url can be embedded in an iframe within your tools)
-[[File:weat_image8.png|936px]]
+[[File:weat_image8.png|768px]]
 Fig 13) PCEX Authoring Tool: Hub Page.
-[[File:weat_image4.png|936px]]
+[[File:weat_image4.png|768px]]
 Fig 14) PCEX Authoring Tool: Activity Preview.

@@ Line 4: / Line 4: @@
 <ol style="list-style-type: decimal;">
-<li>'''Sources''', a source is a PCEX example or challenge; which has a title, problem description, and line-by-line annotated source code.</li>
+<li>'''Sources''', a source is a [[PCEX]] example or challenge; which has a title, problem description, and line-by-line annotated source code.</li>
 <li>'''Activities''', an activity is a bundle of multiple sources either as an example or challenge.</li>
 <li>'''Hub''', is where all publicly available activities are listed which can be searched by title, used, or embedded within your tool (through iframe).</li>