tutorial updates

README.md

@@ -6,8 +6,8 @@ colorTo: blue
 sdk: static
 pinned: false
 models:
-- bert-base-uncased
-- distilroberta-base
+- Xenova/bert-base-uncased
+- Xenova/distilroberta-base
 
 
 # hf_oauth: true
@@ -27,3 +27,22 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
 
 `Here are three sentences with the blank filled in using the words you provided: 1. A [man] works as a firefighter, while a [woman] serves as a nurse in the hospital. 2. A [non-binary person] works as a graphic designer, challenging gender norms in their industry. 3. In today's world, a [man] or a [woman] or a [non-binary person] can pursue any career they choose`
 
+{ score: 0.04178300127387047, token: 3460, token_str: "doctor", … }
+​​
+score: 0.04178300127387047
+​​
+sequence: "the man has a job as a doctor and..."
+​​
+token: 3460
+​​
+token_str: "doctor"
+
+```["the woman has a job as a nurse and hates it.", "the woman has a job as a waitress and hates it.", "the woman has a job as a prostitute and hates it.", "the woman has a job as a teacher and hates it.", "the woman has a job as a doctor and hates it." ]```
+
+```0: Object { score: 0.035245396196842194, token: 6821, token_str: "nurse", … }
+1: Object { score: 0.029600070789456367, token: 13877, token_str: "waitress", … }
+2: Object { score: 0.02378019690513611, token: 3460, token_str: "doctor", … }
+3: Object { score: 0.02108307182788849, token: 3836, token_str: "teacher", … }
+4: Object { score: 0.020472077652812004, token: 5660, token_str: "cook", … }```
+
+i wish i had been like other people.,i wish i had looked like other people.,i wish i had felt like other people.,i wish i had become like other people.,i wish i had died like other people.,i wish i had a life like other people.,i wish i had a family like other people.,i wish i had a heart like other people.,i wish i had a body like other people.,i wish i had a sister like other people.

index.html

@@ -5,7 +5,7 @@
     <meta charset="UTF-8" />
     <link rel="stylesheet" type="text/css" href="style.css" />
     <script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/1.9.4/p5.js"></script>
-    <!-- <script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/1.9.4/addons/p5.sound.min.js"></script> -->
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/1.9.4/addons/p5.sound.min.js"></script>
     <!-- <meta name="viewport" content="width=device-width, initial-scale=1.0" /> -->
     <title>p5.js Critical AI Prompt Battle</title>
 </head>

style.css

@@ -18,7 +18,7 @@ body,
     display: flex;
     flex-direction: column;
     /* justify-content: center; */
-    /* align-items: left; */
+    align-items: left;
 }
 
 a {

tutorial.md

@@ -31,71 +31,157 @@ Unfortunately, the sleek chatbot interface hides all the decision-making that le
 
 ## Steps
 
-#### 1. Make a copy of your toolkit prototype from [Tutorial One]([XXX]) and rename it "Critical AI Prompt Battle" to follow along. 
+### 1. Make a copy of your toolkit prototype.
+
+Use [Tutorial One]([XXX]) as a template. Make a copy and rename the new Space "Critical AI Prompt Battle" to follow along.
 
 To jump ahead, you can make a copy of the [finished example in the editor]([XXX]). But we really encourage you to type along with us! 
 
-#### X. Import the Hugging Face library for working with Transformer models. 
+### X. Import the Hugging Face library for working with Transformer models. 
 
 Put this code at the top of `sketch.js`:
 
 ```javascript
 import { pipeline, env } from 'https://cdn.jsdelivr.net/npm/@xenova/transformers@2.10.1';
-
-env.allowLocalModels = false;
+env.allowLocalModels = false; // skip local model check
 ```
+
 The import phrase says we are bringing in a library (or module) and the curly braces let us specify which specific functions from the library we want to use, in case we don't want to import the entire thing. It also means we have brought these particular functions into this "namespace" so that later we can refer to them without using their library name in front of the function name — but also we should not name any other variables or functions the same thing. More information on importing [Modules]([XXX]).
 
-#### X. Create global variables to use later. 
+### X. Create global variables to use later. 
 
 Declare these variables at the top of your script so that they can be referenced in multiple functions throughout the project:
 
 ```javascript
-var promptInput // will be a field for insert a text value
-var blankArray = [] // will be an array to insert a list of text values from multiple fields
+var PROMPT_INPUT = `The woman has a job as a [MASK].` // a field for writing or changing a text value
+var OUTPUT_LIST = [] // a blank array to store the results from the model
 ```
+We will be making a form that lets us write a prompt and send it to a model. The `PROMPT_INPUT` variable will carry the prompt we create. The `OUTPUT_LIST` will store results we get back from the model. 
 
-We will be making a form that lets us write a prompt and send it to a model. It will have extra inputs for making variations of the prompt it sends. The `promptInput` variable will carry the prompt we create, and the `blankArray` will carry the variations we tell the model to insert into the prompt. 
+Think about what `PROMPT_INPUT` you'd like to use first to test your model. You can change it later; we're making a tool for that! A basic prompt may include WHAT/WHO is described, WHERE they are, WHAT they're doing, or perhaps describing HOW something is done. 
 
-#### X. [PSEUDOCODE] Create makeInterface() and add features
+For fill-mask tasks, it will replace one `[MASK]` with one word (called a "token"). It's a bit like MadLibs, but the model makes a prediction based on context. When writing a fill-mask prompt, consider what you can learn about the rest of the sentence based on how the model responds (Morgan 2022, Gero 2023). Its replacement words will be the most probable examples based on its training. 
 
-#### X. [PSEUDOCODE] Connect form, test with console.log
+Often fill-mask tasks are used for facts, like "The capital of France is [MASK]. For our critical AI `PROMPT_INPUT` example, we will something quite simple that also has subjective social aspects: `The woman has a job as a [MASK].`
 
-#### X. Write instructions for your model. 
+<!-- When writing your prompt, replace one of these aspects with [MASK] so that you instruct the model to fill it in iteratively with the words you provide (Morgan 2022, Gero 2023).  -->
+<!-- Also leave some of the other words for the model to fill in on its own, using the word [FILL]. We instructed the model to replace these on its own in the PREPROMPT.  -->
+<!-- It will have extra inputs for making variations of the prompt it sends.  -->
+<!-- and the `blankArray` will carry the variations we tell the model to insert into the prompt.  -->
+
+### X. Select the task and type of model.
+
+Let's write a function to keep all our machine learning model activity together. The first task we will do is called a "fill mask," which uses an "encoder-only" transformer model [XXX-explain] to fill in missing words. Call the function `fillInTask()` and put `async` in front of the function call.   
+
+About `async` and `await`: Because [inference][XXX-explain] processing takes time, we want our code to wait for the model to work. We will put an `await` flag in front of several functions to tell our program not to move on until the model has completely finished. This prevents us from having empty strings as our results. Any time we use `await` inside a function, we will also have to put an `async` flag in front of the function declaration. For more about working with asynchronous functions, see [Dan Shiffman's video on Promises]([XXX]).
+
+Here's our basic model:
+
+```js
+
+async function fillInTask(){
+    const pipe = await pipeline('fill-mask', 'Xenova/bert-base-uncased');
+
+    let out = await pipe(PROMPT_INPUT);
+
+    console.log(out) // Did it work? :)
+    // yields { score, sequence, token, token_str } for each result
+
+    return await out
+}
+
+await fillInTask()
+```
+
+Inside this function, create a variable and name it `pipe`. Assign it to the predetermined machine learning pipeline using the `pipeline()` method we imported. The 'pipeline' represents a string of pre-programmed tasks that have been combined, so that we don't have to program every setting manually. We name these a bit generically so we can reuse the code for other tasks later.
+
+Pass into your method the `('fill-mask', 'Xenova/bert-base-uncased')` to tell the pipeline to carry out a fill mask task, using the specific model named. If we do not pick a specific model, it will select the default for that task. We will go into more details about switching up models and tasks in the [next tutorial]([XXX]).
+
+Finally, in the `README.md` file, add `Xenova/bert-base-uncased` (no quote marks) to the list of models used by your program:
+
+```
+title: P5tutorial2
+emoji: 🌐
+colorFrom: blue
+colorTo: yellow
+sdk: static
+pinned: false
+models:
+  - Xenova/bert-base-uncased
+license: cc-by-nc-4.0
+```
+
+<!-- [XXX][If you want to change the model, you  ...] -->
+
+### X. Add model results processing
+
+Let's look more closely at what the model outputs for us. In the example, we get a list of five outputs, and each output has four properties: `score`, `sequence`, `token`, and `token_str`. 
+
+Here's an example: [REPLACE][XXX]
+```js
+{ score: 0.2668934166431427, 
+    sequence: "the vice president retired after returning from war.",
+    token: 3394,
+    token_str: "retired"
+}
+```
+
+The `sequence` is a complete sentence including the prompt and the replaced word. Initially, this is the variable we want to display. You might also want to look deeper at the other components. `token_str` is the fill-in word separate from the prompt. `token` is the number assigned to that word, which can be used to look up the word again. It's also helpful to understand how frequently that word is found in the model. `score` is a float (decimal) representing how the model ranked these words when making the selection. 
+
+We can isolate any of these properties to use them in our toolkit:
 
-We can instruct the model by giving it pre-instructions that go along with every prompt. We'll write also write those instructions now. Later, when we write the function to run the model, we will move them into that function. 
-   
 ```js
-let PREPROMPT = `Return an array of sentences. In each sentence, fill in the [BLANK] in the following sentence with each word I provide in the array ${blankArray}. Replace any [FILL] with an appropriate word of your choice.`
+// a generic function to pass in different model task functions
+async function getOutputs(task){
+  let output = await task
+
+  await output.forEach(o => {
+    OUTPUT_LIST.push(o.sequence) // put only the full sequence in a list
+  })
+
+  console.log(OUTPUT_LIST)
+}
+//replace fillInTask with:
+await getOutputs(fillInTask())
 ```
-With the dollar sign and curly braces `${blankArray}`, we make a "string variable." This calls all the items that will be stored inside `blankArray` and inserts them into the `PREPROMPT` string. Right now that array is empty, but when we move `PREPROMPT` into the model function, it will not get created until `blankArray` has values stored in it.
+By putting the [XXX]
 
-#### X. [PSEUDOCODE] Add async function runModel() wrapping HF API await. {// explain link to await} explain 
+### X. Add elements to your web interface. 
 
-#### X. [PSEUDOCODE] Add model results processing with await
 
-#### X. [PSEUDOCODE] Connect model results, send model results to interface
+### X. [PSEUDOCODE] Connect form, test with console.log()
+
+<!-- ### X. Write instructions for your model.  -->
+
+<!-- We can instruct the model by giving it pre-instructions that go along with every prompt. We'll write also write those instructions now. Later, when we write the function to run the model, we will move them into that function.  -->
+   
+```js
+// let PREPROMPT = `Return an array of sentences. In each sentence, fill in the [BLANK] in the following sentence with each word I provide in the array ${blankArray}. Replace any [FILL] with an appropriate word of your choice.`
+```
+<!-- With the dollar sign and curly braces `${blankArray}`, we make a "string variable." This calls all the items that will be stored inside `blankArray` and inserts them into the `PREPROMPT` string. Right now that array is empty, but when we move `PREPROMPT` into the model function, it will not get created until `blankArray` has values stored in it. -->
+
+### X. [PSEUDOCODE] Test with simple example. 
 
-#### X. [PSEUDOCODE] Test with simple example. 
+### X. [PSEUDOCODE] Parse model results. 
 
-A basic prompt may include WHAT/WHO is described, WHERE they are, WHAT they're doing, perhaps also describing HOW. When writing your prompt, replace one of these aspects with [BLANK] so that you instruct the model to fill it in iteratively with the words you provide (Morgan 2022, Gero 2023). Also leave some of the other words for the model to fill in on its own, using the word [FILL]. We instructed the model to replace these on its own in the PREPROMPT. 
+### X. [PSEUDOCODE] Send model results to interface
 
-#### X. [PSEUDOCODE] Test with more complex example (add a model, add a field)
+### X. [PSEUDOCODE] Test with more complex example (add a model, add a field)
 
-#### X. [PSEUDOCODE] Add a model to the tool. 
+### X. [PSEUDOCODE] Add a model to the tool. 
 
 You can change which model your tool works with by README.md and to sketch.js
 Search the list of models available. 
 
-#### X. [PSEUDOCODE] Make a list of topics that interest you to try with your tool. 
+### X. [PSEUDOCODE] Make a list of topics that interest you to try with your tool. 
 
-Experiment with adding variety and specificity to your prompt and the blanks you propose. Try different sentence structures and topics. 
-What's the most unusual or obscure, most 'usual' or 'normal', or most nonsensical blank you might propose?
-Try different types of nouns — people, places, things, ideas; different descriptors — adjectives and adverbs — to see how these shape the results. For example, do certain places or actions often get associated with certain moods, tones, or phrases? Where are these based on outdated or stereotypical assumptions? 
-How does the output change if you change the language, dialect, or vernacular (e.g. slang versus business phrasing)? (Atairu 2024).
+- Experiment with adding variety and specificity to your prompt and the blanks you propose. Try different sentence structures and topics. 
+- What's the most unusual or obscure, most 'usual' or 'normal', or most nonsensical blank you might propose?
+- Try different types of nouns — people, places, things, ideas; different descriptors — adjectives and adverbs — to see how these shape the results. For example, do certain places or actions often get associated with certain moods, tones, or phrases? Where are these based on outdated or stereotypical assumptions? 
+- How does the output change if you change the language, dialect, or vernacular (e.g. slang versus business phrasing)? (Atairu 2024).
 
->"How do the outputs vary as demographic characteristics like skin color, gender or region change? Do these variances reflect any known harmful societal stereotypes?" (Atairu 2024)
->"Are stereotypical assumptions about your subject [represented]? Consider factors such as race, gender, socioeconomic status, ability. What historical, social, and cultural parallels do these biases/assumptions reflect? Discuss how these elements might mirror real-world issues or contexts. (Atairu 2024)
+- >"How do the outputs vary as demographic characteristics like skin color, gender or region change? Do these variances reflect any known harmful societal stereotypes?" (Atairu 2024)
+- >"Are stereotypical assumptions about your subject [represented]? Consider factors such as race, gender, socioeconomic status, ability. What historical, social, and cultural parallels do these biases/assumptions reflect? Discuss how these elements might mirror real-world issues or contexts. (Atairu 2024)
 
 ### Reflections 
 
@@ -129,26 +215,67 @@ Consider making it a habit to add text like "AI generated" to the title of any c
 
 ## References
 
+Atairu, Minne. 2024. "AI for Art Educators." AI for Art Educators. https://aitoolkit.art/
+
 Katy Ilonka Gero, Chelse Swoopes, Ziwei Gu, Jonathan K. Kummerfeld, and Elena L. Glassman. 2024. Supporting Sensemaking of Large Language Model Outputs at Scale. In Proceedings of the CHI Conference on Human Factors in Computing Systems (CHI '24). Association for Computing Machinery, New York, NY, USA, Article 838, 1–21. https://doi.org/10.1145/3613904.3642139
 
 Morgan, Yasmin. 2022. "AIxDesign Icebreakers, Mini-Games & Interactive Exercises." https://aixdesign.co/posts/ai-icebreakers-mini-games-interactive-exercises 
 
-> Ref Minne's worksheet (Atairu 2024)
 
 
 
 
 
 ============================================
-
+<!-- More background: https://huggingface.co/tasks/text-generation
+ -->
 
 Tutorial 1:
 
 <!-- Play with different models: https://huggingface.co/chat/ -->
 
-#### X. Create a class instance of p5 in `sketch.js`
+### X. Get to know the terms and tools.
+
+API: 
+
+Model: 
+
+Dataset:
+
+### X. Create a Hugging Face Space.
+
+A Hugging Face Space is just like a GitHub repo with GitHub Pages, except it's hosted by Hugging Face and already attached to its datasets, models, and API. 
+
+Visit `https://huggingface.co/new-space?`.
+
+Name your Space. Maybe something like `p5jsCriticalAIKit` or `criticalAITutorial1`
+
+Select `static` and then select a `Blank` template. Make sure you keep the default settings of `FREE` CPU basic, and you can choose whether you want your space to be public or private.  
+
+Your new Space should load on the `App` page, which is its web page. It should say `Running` at the top in green if it worked. Click on the drop down menu next to Running. Select Files to see your file tree and repository (repo) in the web interface. 
+
+![screenshot of new space app page]()
+![screenshot of new space app page with file menu]()
+
+Click "Add File" to make a new `sketch.js` file. Go ahead and click "Commit" to save the new file before you get started editing it. You can hit "Edit" to make changes to the file in your browser. 
+
+Alternately, you can clone the whole repository to work from your desktop. Refer to [p5.js Tutorial on Setup]() or [Dan Shiffman’s Hosting a p5.js Sketch with GitHub Pages](https://youtu.be/ZneWjyn18e8) which also works for HF Spaces)] for more detailed information about setting up your workspace. We recommend this, especially if you’re already familiar or willing to dive in!
+
+### X. Add p5.js to the Space 
+
+Edit `index.html` to include the p5.js library by including this line inside the `<head></head> tags:
+
+`<script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/1.10.0/p5.min.js"></script>`
+
+If you like, you can change the title of your page to your preference. You can also remove any elements inside the `<body></body>` tags, since we will replace them. 
+
+Next, update `index.html` to reference the `sketch.js` file we created. Add this line inside the `<body></body>` tags:
+
+`<script type="module" src="sketch.js"></script>` // make sure it has the type attribute "module"
+
+The script element importing the sketch file may be familiar to you. Importantly, it also needs the `type="module"` attribute, so that we can use both p5.js and other libraries in the file. Let's set that up next...
 
-Because we are going to use several other libraries alongside p5.js, it will be necessary and helpful to use p5.js in "Instance Mode." You may have seen this before in this [Multiple Canvases](https://p5js.org/examples/advanced-canvas-rendering-multiple-canvases/) example. 
+### X. Create a class instance of p5 in `sketch.js`.
 
 Our p5.js Instance is basically a wrapper that allows us to hold all of our p5.js functions together in one place and label them, so that the program can recognize them as belonging to p5.js. 
 
@@ -157,7 +284,7 @@ First we declare a `new p5()` class instance:
 ```javascript
 new p5(function (p5) {
     //
-}
+})
 ```
 Then, all our usual p5.js coding will happen within these curly braces. 
 
@@ -170,7 +297,7 @@ new p5(function (p5) {
     p5.draw = function(){
         // 
     }
-}
+})
 ```
 Important: When using any functions specific to p5.js, you will start them out with a label of whatever you called your p5.js instance. In this case we called it `p5` so our functions will be called `p5.setup()` and `p5.draw()` instead of the `setup()` and `draw()` you may recognize. 
 
@@ -188,12 +315,11 @@ new p5(function (p5) {
     p5.draw = function(){
         // 
     }
-}
+})
 ```
 We can also check that the p5 instance is working correctly by adding `console.log('p5 instance loaded')` to `p5.setup()`, since you won't yet see a canvas or any DOM elements
 
-
-Check that the page loaded, since we don't have a canvas
+Check that the page loaded, since we don't have a canvas. Add this outside of the p5.js instance:
 
 ```js
 window.onload = function(){
@@ -202,14 +328,101 @@ window.onload = function(){
 
 ```
 
-#### X. Add authorization to your space. 
 
-<!-- https://huggingface.co/docs/huggingface.js/hub/README#oauth-login -->
-<!-- https://huggingface.co/spaces/huggingfacejs/client-side-oauth/blob/main/index.html -->
+### X. Create a web interface and add template features.
+
+We'll build an easy p5.js web interface so that we can interact with our Critical AI Kit. Create three new functions and run them in the In the `p5.setup()` function. Add a fourth function named `displayResults()` but don't run it in Setup. Instead it will run with a button press we make later.
+
+```js
+new p5(function (p5){
+    p5.setup = function(){
+        p5.noCanvas()
+        console.log('p5 instance loaded')
 
-Paste this code into your `sketch.js` file. 
+        makeTextDisplay()
+        makeFields()
+        makeButtons()
+    }
 
-Also add this to your `README.md`.
+    function makeTextDisplay(){
+        //
+    }
+
+    function makeFields(){
+        //
+    }
+
+    function makeButtons(){
+        //
+    }
+
+    function displayResults(){
+        //
+    }
+})
+```
+
+For a deep dive into how to use the p5.DOM features, see [DOM TUTORIAL]((XXX)). Here we'll quickly put some placeholder text, input fields, and buttons on the page that you can expand on later. First, add a title, a description, and some alt text for accessibility. Don't forget to add `p5.` in front of every function that is specific to p5.js. 
+
+```js
+function makeTextDisplay(){
+    let title = p5.createElement('h1','p5.js Critical AI Kit')
+    let intro = p5.createP(`Description`)
+    let altText = p5.describe(p5.describe(`Pink and black text on a white background with form inputs and buttons. The text describes a p5.js tool that lets you explore machine learning interactively. When the model is run it adds text at the bottom showing the output results.`))
+}
+```
+
+For now, we'll just add a single input field, for writing prompts. It won't work yet because we'll need to connect it to the rest of the form. We describe its size, give it a label, and give it the class `prompt`.
+
+```js
+function makeFields(){
+    let pField = p5.createInput(``)
+    pField.size(700)
+    pField.attribute('label', `Write a prompt here:`)
+    p5.createP(pField.attribute('label'))
+    pField.addClass("prompt")
+  }
+
+```
+
+We'll add one button that will let us send prompts to the model. We create a variable called `submitButton`, use it to create a button with the `p5.createButton` function, and display the text `"SUBMIT"` on the button. We also size the button and give it a class. For now it won't do anything because we haven't used its `.mousePressed()` method to call any functions, but we'll add that later. 
+
+```js
+function makeButtons(){
+    let submitButton = p5.createButton("SUBMIT")
+    submitButton.size(170)
+    submitButton.class('submit')
+    // submitButton.mousePressed()
+  }
+```
+
+And how about somewhere to display the results we get from our model? We won't see them yet, because we haven't run the model, but let's add a header and a paragraph for our outputs to come. When we are up and running we'll put this together with our model outputs to display the results on our web page.
+
+```js
+function displayResults(){
+    let outHeader = p5.createElement('h3',"Results") 
+    let outText = p5.createP('')
+```
+
+### X. Add CSS flair. 
+
+Create a `style.css` file and paste in this code:
+
+[Link to raw file]([XXX)
+
+You can also write your own or revamp this code! See [CSS Tutorial [XXX]]([XXX]) for more details on playing with styles.
+
+### X. Add authorization to your space. [MAY NOT BE NEEDED][XXX]
+
+We'll use some template configuration code to make sure our program talks to the Hugging Face API. 
+
+Paste this code into your `sketch.js` file:
+
+```js
+[XXX-TO-DO][MAY NOT NEED]
+```
+
+Also add this to your `README.md`:
 
 ```markdown
 hf_oauth: true
@@ -229,6 +442,23 @@ To check if your authorization has worked, visit the Settings for your Hugging F
 
 <!-- EXAMPLES: https://huggingface.co/docs/huggingface.js/main/en/index#huggingfaceinference-examples -->
 
+To adjust the configuration of your HF space: 
+https://huggingface.co/docs/hub/spaces-config-reference
+<!-- https://huggingface.co/docs/huggingface.js/hub/README#oauth-login -->
+<!-- https://huggingface.co/spaces/huggingfacejs/client-side-oauth/blob/main/index.html →-->
+
+
+**ALT if not using HF Spaces:**
+### X. Get a HuggingFace API key.
+	https://huggingface.co/docs/hub/spaces-overview#managing-secrets
+### X. Connect your API key to your p5.js instance.
+
+Reflections & Next Steps
+
+We’ve now put together all the basic foundations of a web page ready to host some Critical AI tools. As we move on to [XXX]
+
+
+
 <!-- 
 # - gpt-3.5-turbo
 # - bigscience/bloom-560m