docs: Minor format changes for image captioning example (#6916)

pakelley · web-flow · commit 25ee12a961ed · 2025-01-16T07:56:19.000-08:00
diff --git a/docs/source/guide/prompts_examples.md b/docs/source/guide/prompts_examples.md
@@ -11,19 +11,78 @@ section: Prompts
 date: 2025-01-15 12:11:22
 ---
 
+## Example project types
 
-## Autolabel image captions 
+### Text classification  
+
+Text classification is the process of assigning predefined categories or labels to segments of text based on their content. This involves analyzing the text and determining which category or label best describes its subject, sentiment, or purpose. The goal is to organize and categorize textual data in a way that makes it easier to analyze, search, and utilize. 
+
+Text classification labeling tasks are fundamental in many applications, enabling efficient data organization, improving searchability, and providing valuable insights through data analysis. Some examples include:
+
+* **Spam Detection**: Classifying emails as "spam" or "ham" (not spam). 
+* **Sentiment Analysis**: Categorizing user reviews as "positive," "negative," or "neutral."
+* **Topic Categorization**: Assigning articles to categories like "politics," "sports," "technology," etc.
+* **Support Ticket Classification**: Labeling customer support tickets based on the issue type, such as "billing," "technical support," or "account management."
+* **Content Moderation**: Identifying and labeling inappropriate content on social media platforms, such as "offensive language," "hate speech," or "harassment."
+
+### Named entity recognition (NER)
+
+A Named Entity Recognition (NER) labeling task involves identifying and classifying named entities within text. For example, people, organizations, locations, dates, and other proper nouns. The goal is to label these entities with predefined categories that make the text easier to analyze and understand. NER is commonly used in tasks like information extraction, text summarization, and content classification.
+
+For example, in the sentence "Heidi Opossum goes grocery shopping at Aldi in Miami" the NER task would involve identifying "Aldi" as a place or organization, "Heidi Opossum" as a person (even though, to be precise, she is an iconic opossum), and "Miami" as a location. Once labeled, this structured data can be used for various purposes such as improving search functionality, organizing information, or training machine learning models for more complex natural language processing tasks.
+
+NER labeling is crucial for industries such as finance, healthcare, and legal services, where accurate entity identification helps in extracting key information from large amounts of text, improving decision-making, and automating workflows.
+
+Some examples include:
+
+* **News and Media Monitoring**: Media organizations use NER to automatically tag and categorize entities such as people, organizations, and locations in news articles. This helps in organizing news content, enabling efficient search and retrieval, and generating summaries or reports. 
+* **Intelligence and Risk Analysis**: By extracting entities such as personal names, organizations, IP addresses, and financial transactions from suspicious activity reports or communications, organizations can better assess risks and detect fraud or criminal activity.
+* **Specialized Document Review**: Once trained, NER can help extract industry-specific key entities for better document review, searching, and classification. 
+* **Customer Feedback and Product Review**: Extract named entities like product names, companies, or services from customer feedback or reviews. This allows businesses to categorize and analyze feedback based on specific products, people, or regions, helping them make data-driven improvements.
+
+### Text summarization
+
+Text summarization involves condensing large amounts of information into concise, meaningful summaries. 
+
+Models can be trained or fine-tuned to recognize essential information within a document and generate summaries that retain the core ideas while omitting less critical details. This capability is especially valuable in today’s information-heavy landscape, where professionals across various fields are often overwhelmed by the sheer volume of text data.
+
+Some examples include:
+
+* **Customer Support and Feedback Analysis**: Companies receive vast volumes of customer support tickets, reviews, and feedback that are often repetitive or lengthy. Auto-labeling can help summarize these inputs, focusing on core issues or themes, such as “billing issues” or “technical support.” 
+* **News Aggregation and Media Monitoring**: News organizations and media monitoring platforms need to process and distribute news stories efficiently. Auto-labeling can summarize articles while tagging them with labels like “politics,” “economy,” or “health,” making it easier for users to find relevant stories.
+* **Document Summarization**: Professionals often need to quickly understand the key points in lengthy contracts, research papers, and files.
+* **Educational Content Summarization**: EEducators and e-learning platforms need to distill complex material into accessible summaries for students. Auto-labeling can summarize key topics and categorize them under labels like “concept,” “example,” or “important fact.”
+
+
+### Image captioning and classification
+
+Image captioning involves applying descriptive text for images. This has valuable applications across industries, particularly where visual content needs to be systematically organized, analyzed, or made accessible. 
+
+You can also use Prompts to automatically categorizing images into predefined classes or categories, ensuring consistent labeling of large image datasets.
+
+Some examples include:
+
+* **E-commerce Product Cataloging**: Online retailers often deal with thousands of product images that require captions describing their appearance, features, or categories.
+
+* **Digital Asset Management (DAM)**: Companies managing large libraries of images, such as marketing teams, media organizations, or creative agencies, can use auto-labeling to caption, tag, and classify their assets.
+
+* **Content Moderation and Analysis**: Platforms that host user-generated content can employ image captioning to analyze and describe uploaded visuals. This helps detect inappropriate content, categorize posts (e.g., "Outdoor landscape with a sunset"), and surface relevant content to users. You may also want to train a model to classify image uploads into categories such as “safe,” “explicit,” or “spam.”
+
+* **Accessibility for Visually Impaired Users**: Image captioning is essential for making digital content more accessible to visually impaired users by providing descriptive alt-text for images on websites, apps, or documents. For instance, an image of a cat playing with yarn might generate the caption, "A fluffy orange cat playing with a ball of blue yarn."
+
+## Example Walkthroughs
+
+### Autolabel image captions 
 
 This example demonstrates how to set up Prompts to predict image captions.
 
 1. [Create a new label studio project](setup_project) by importing image data via [cloud storage](storage). 
 
+    If you’d like to, you can generate a dataset to test the process using [https://data.heartex.net](https://data.heartex.net).
+
 !!! note
     Prompts does not currently support image data uploaded as raw images. Only image references (HTTP URIs to images) or images imported via cloud storage are supported. 
 
-!!! info Tip
-    If you’d like to, you can generate a dataset to test the process using [https://data.heartex.net](https://data.heartex.net).
-
 2. Create a [label config](setup) for image captioning, for example:
 
 ```xml
@@ -36,7 +95,6 @@ This example demonstrates how to set up Prompts to predict image captions.
 ```
 3. Navigate to **Prompts** from the sidebar, and [create a prompt](prompts_create) for the project
 
-!!! note
     If you have not yet set up API the keys you want to use, do that now: [API keys](prompts_create#Model-provider-API-keys). 
 
 4. Add the instruction you’d like to provide the LLM to caption your images. For example:
@@ -46,12 +104,12 @@ This example demonstrates how to set up Prompts to predict image captions.
 !!! note
     Ensure you include `{image}` in your instructions. Click `image` above the instruction field to insert it. 
 
-![Screenshot pointing to how to insert image into your instructions](/images/prompts/example_insert_image.png)
+    ![Screenshot pointing to how to insert image into your instructions](/images/prompts/example_insert_image.png)
 
 !!! info Tip
     You can also automatically generate the instructions using the [**Enhance Prompt** action](prompts_draft#Enhance-prompt). Before you can use this action, you must at least add the variable name `{image}` and then click **Save**. 
 
-![Screenshot pointing to Enhance Prompt action](/images/prompts/example_enhance_prompt.png)
+    ![Screenshot pointing to Enhance Prompt action](/images/prompts/example_enhance_prompt.png)
 
 5. Run the prompt. View predictions to accept or correct.
 
@@ -60,18 +118,19 @@ This example demonstrates how to set up Prompts to predict image captions.
 !!! info Tip
     Use the drop-down menu above the results field to change the subset of data being used (e.g. only data with Ground Truth annotations, or a small sample of records). 
 
-![Screenshot pointing to subset dropdown](/images/prompts/example_subset.png)
+    ![Screenshot pointing to subset dropdown](/images/prompts/example_subset.png)
 
 6. Accept the [predictions as annotations](prompts_predictions#Create-annotations-from-predictions).
 
 
-## Evaluate LLM outputs for toxicity
+### Evaluate LLM outputs for toxicity
 
 This example demonstrates how to set up Prompts to evaluate if the LLM-generated output text is classified as harmful, offensive, or inappropriate.
 
 1. [Create a new label studio project](setup_project) by importing text data of LLM-generated outputs. 
 
-    You can use this preprocessed sample of the [jigsaw_toxicity](https://huggingface.co/datasets/tasksource/jigsaw_toxicity) dataset as an example. See [the appendix](#Appendix-Generate-dataset) for how this was generated. 
+    For example: you can use the [jigsaw_toxicity](https://huggingface.co/datasets/tasksource/jigsaw_toxicity) dataset as an example. See [the appendix](#Appendix-Generate-dataset) for how you can pre-process and (optionally) downsample this dataset to use with this guide.
+
 2. Create a [label config](setup) for toxicity detection, for example:
 
 ```xml
@@ -117,7 +176,6 @@ This example demonstrates how to set up Prompts to evaluate if the LLM-generated
 
 3. Navigate to **Prompts** from the sidebar, and [create a prompt](prompts_create) for the project
 
-!!! note
     If you have not yet set up API the keys you want to use, do that now: [API keys](prompts_create#Model-provider-API-keys). 
 
 4. Add the instruction you’d like to provide the LLM to best evaluate the text. For example:
@@ -134,12 +192,12 @@ This example demonstrates how to set up Prompts to evaluate if the LLM-generated
 !!! note
     Ensure you include `{comment_text}` in your instructions. Click `comment_text` above the instruction field to insert it. 
 
-![Screenshot pointing to how to insert comment text into your instructions](/images/prompts/example_insert_comment_text.png)
+    ![Screenshot pointing to how to insert comment text into your instructions](/images/prompts/example_insert_comment_text.png)
 
 !!! info Tip
     You can also automatically generate the instructions using the [**Enhance Prompt** action](prompts_draft#Enhance-prompt). Before you can use this action, you must at least add the variable name `{comment_text}` and then click **Save**. 
 
-![Screenshot pointing to Enhance Prompt action](/images/prompts/example_enhance_prompt2.png)
+    ![Screenshot pointing to Enhance Prompt action](/images/prompts/example_enhance_prompt2.png)
 
 5. Run the prompt. View predictions to accept or correct.
 
@@ -148,11 +206,11 @@ This example demonstrates how to set up Prompts to evaluate if the LLM-generated
 !!! info Tip
     Use the drop-down menu above the results field to change the subset of data being used (e.g. only data with Ground Truth annotations, or a small sample of records). 
 
-![Screenshot pointing to subset dropdown](/images/prompts/example_subset2.png)
+    ![Screenshot pointing to subset dropdown](/images/prompts/example_subset2.png)
 
 6. Accept the [predictions as annotations](prompts_predictions#Create-annotations-from-predictions). 
 
-### Appendix: Generate dataset
+### Appendix: Preprocess jigsaw toxicity dataset
 
 Download the jigsaw_toxicity dataset, then downsample/format using the following script (modify the `INPUT_PATH` and `OUTPUT_PATH` to suit your needs):
 
@@ -200,4 +258,4 @@ with open(OUTPUT_PATH, "w") as f:
     json.dump(label_studio_tasks, f)
 ```
 
-If you choose to, you could also easily change how many records to use (or use the entire dataset by removing the sample step). 
+If you choose to, you could also easily change how many records to use (or use the entire dataset by removing the sample step). 
diff --git a/docs/source/guide/prompts_overview.md b/docs/source/guide/prompts_overview.md
@@ -144,63 +144,3 @@ This feedback loop allows you to iteratively fine-tune your prompts, optimizing
 
 ![Diagram of fine-tuning workflow](/images/prompts/tuning-diagram.png)
 
-
-## Example project types
-
-### Text classification  
-
-Text classification is the process of assigning predefined categories or labels to segments of text based on their content. This involves analyzing the text and determining which category or label best describes its subject, sentiment, or purpose. The goal is to organize and categorize textual data in a way that makes it easier to analyze, search, and utilize. 
-
-Text classification labeling tasks are fundamental in many applications, enabling efficient data organization, improving searchability, and providing valuable insights through data analysis. Some examples include:
-
-* **Spam Detection**: Classifying emails as "spam" or "ham" (not spam). 
-* **Sentiment Analysis**: Categorizing user reviews as "positive," "negative," or "neutral."
-* **Topic Categorization**: Assigning articles to categories like "politics," "sports," "technology," etc.
-* **Support Ticket Classification**: Labeling customer support tickets based on the issue type, such as "billing," "technical support," or "account management."
-* **Content Moderation**: Identifying and labeling inappropriate content on social media platforms, such as "offensive language," "hate speech," or "harassment."
-
-### Named entity recognition (NER)
-
-A Named Entity Recognition (NER) labeling task involves identifying and classifying named entities within text. For example, people, organizations, locations, dates, and other proper nouns. The goal is to label these entities with predefined categories that make the text easier to analyze and understand. NER is commonly used in tasks like information extraction, text summarization, and content classification.
-
-For example, in the sentence "Heidi Opossum goes grocery shopping at Aldi in Miami" the NER task would involve identifying "Aldi" as a place or organization, "Heidi Opossum" as a person (even though, to be precise, she is an iconic opossum), and "Miami" as a location. Once labeled, this structured data can be used for various purposes such as improving search functionality, organizing information, or training machine learning models for more complex natural language processing tasks.
-
-NER labeling is crucial for industries such as finance, healthcare, and legal services, where accurate entity identification helps in extracting key information from large amounts of text, improving decision-making, and automating workflows.
-
-Some examples include:
-
-* **News and Media Monitoring**: Media organizations use NER to automatically tag and categorize entities such as people, organizations, and locations in news articles. This helps in organizing news content, enabling efficient search and retrieval, and generating summaries or reports. 
-* **Intelligence and Risk Analysis**: By extracting entities such as personal names, organizations, IP addresses, and financial transactions from suspicious activity reports or communications, organizations can better assess risks and detect fraud or criminal activity.
-* **Specialized Document Review**: Once trained, NER can help extract industry-specific key entities for better document review, searching, and classification. 
-* **Customer Feedback and Product Review**: Extract named entities like product names, companies, or services from customer feedback or reviews. This allows businesses to categorize and analyze feedback based on specific products, people, or regions, helping them make data-driven improvements.
-
-### Text summarization
-
-Text summarization involves condensing large amounts of information into concise, meaningful summaries. 
-
-Models can be trained or fine-tuned to recognize essential information within a document and generate summaries that retain the core ideas while omitting less critical details. This capability is especially valuable in today’s information-heavy landscape, where professionals across various fields are often overwhelmed by the sheer volume of text data.
-
-Some examples include:
-
-* **Customer Support and Feedback Analysis**: Companies receive vast volumes of customer support tickets, reviews, and feedback that are often repetitive or lengthy. Auto-labeling can help summarize these inputs, focusing on core issues or themes, such as “billing issues” or “technical support.” 
-* **News Aggregation and Media Monitoring**: News organizations and media monitoring platforms need to process and distribute news stories efficiently. Auto-labeling can summarize articles while tagging them with labels like “politics,” “economy,” or “health,” making it easier for users to find relevant stories.
-* **Document Summarization**: Professionals often need to quickly understand the key points in lengthy contracts, research papers, and files.
-* **Educational Content Summarization**: EEducators and e-learning platforms need to distill complex material into accessible summaries for students. Auto-labeling can summarize key topics and categorize them under labels like “concept,” “example,” or “important fact.”
-
-
-### Image captioning and classification
-
-Image captioning involves applying descriptive text for images. This has valuable applications across industries, particularly where visual content needs to be systematically organized, analyzed, or made accessible. 
-
-You can also use Prompts to automatically categorizing images into predefined classes or categories, ensuring consistent labeling of large image datasets.
-
-Some examples include:
-
-* **E-commerce Product Cataloging**: Online retailers often deal with thousands of product images that require captions describing their appearance, features, or categories.
-
-* **Digital Asset Management (DAM)**: Companies managing large libraries of images, such as marketing teams, media organizations, or creative agencies, can use auto-labeling to caption, tag, and classify their assets.
-
-* **Content Moderation and Analysis**: Platforms that host user-generated content can employ image captioning to analyze and describe uploaded visuals. This helps detect inappropriate content, categorize posts (e.g., "Outdoor landscape with a sunset"), and surface relevant content to users. You may also want to train a model to classify image uploads into categories such as “safe,” “explicit,” or “spam.”
-
-* **Accessibility for Visually Impaired Users**: Image captioning is essential for making digital content more accessible to visually impaired users by providing descriptive alt-text for images on websites, apps, or documents. For instance, an image of a cat playing with yarn might generate the caption, "A fluffy orange cat playing with a ball of blue yarn."
-
