jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Add aria-labels to octicons (#55740)

Browse Source
This commit is contained in:
Kevin Heis
2025-05-20 16:45:25 -07:00
committed by GitHub
parent e9730d4590
commit 39beae4778
494 changed files with 758 additions and 758 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
content/github-models/use-github-models/optimizing-your-ai-powered-app-with-github-models.md
View File

@@ -33,7 +33,7 @@ You can access the **Comparisons** view directly from the **Models** tab in any
### 2. Creating a new prompt
1. On the main page of your new repository, click the **Models** tab.
1. In the "Prompts" section, click **{% octicon "plus" aria-hidden="true" %} New Prompt**.
1. In the "Prompts" section, click **{% octicon "plus" aria-hidden="true" aria-label="plus" %} New Prompt**.
1. In the upper-left corner, choose a model from the dropdown menu.
### 3. Writing a system prompt
@@ -68,7 +68,7 @@ When should I use rebase or merge?
### 6. Running the sample prompt
1. In the upper-right corner, click **{% octicon "play" aria-hidden="true" %} Play**.
1. In the upper-right corner, click **{% octicon "play" aria-hidden="true" aria-label="play" %} Play**.
1. Make a change to the model or prompt, then run the prompt again to see what results you get.
## Testing different models against a prompt
@@ -76,29 +76,29 @@ When should I use rebase or merge?
Now, let's determine which model will work best for our application, using the **Comparisons** view. This view allows you to test different models on the same input, revealing differences in accuracy, creativity, tone, reasoning, and reliability. That will help us choose the model that best fits our needs in terms of quality, speed, cost, and consistency.
1. In the upper-left corner, click **Comparisons**.
1. To compare different models, click **{% octicon "plus" aria-hidden="true" %} Add prompt** and select **{% octicon "repo-forked" aria-hidden="true" %} Copy original prompt** to duplicate your existing system and user prompts. Create at least two copies of the original prompt to evaluate three different models.
1. Next to each prompt, click {% octicon "pencil" aria-hidden="Edit prompt" %}. From the **Model** dropdown, choose a different model for each prompt you created.
1. Click **{% octicon "plus" aria-hidden="true" %} Add inputs** to create new rows for sample inputs.
1. To compare different models, click **{% octicon "plus" aria-hidden="true" aria-label="plus" %} Add prompt** and select **{% octicon "repo-forked" aria-hidden="true" aria-label="repo-forked" %} Copy original prompt** to duplicate your existing system and user prompts. Create at least two copies of the original prompt to evaluate three different models.
1. Next to each prompt, click {% octicon "pencil" aria-hidden="Edit prompt" aria-label="pencil" %}. From the **Model** dropdown, choose a different model for each prompt you created.
1. Click **{% octicon "plus" aria-hidden="true" aria-label="plus" %} Add inputs** to create new rows for sample inputs.
* Click **{% octicon "plus" aria-hidden="true" %} Add inputs**. Then, in the "Input" field, copy and paste the following text:
* Click **{% octicon "plus" aria-hidden="true" aria-label="plus" %} Add inputs**. Then, in the "Input" field, copy and paste the following text:
```text copy
How do I modify the most recent commit message in my current branch?
```
* Click **{% octicon "plus" aria-hidden="true" %} Add inputs** again, then paste the following input:
* Click **{% octicon "plus" aria-hidden="true" aria-label="plus" %} Add inputs** again, then paste the following input:
```text copy
How do I move a specific commit from one branch to a different branch?
```
* Click **{% octicon "plus" aria-hidden="true" %} Add inputs** one more time, and paste this input:
* Click **{% octicon "plus" aria-hidden="true" aria-label="plus" %} Add inputs** one more time, and paste this input:
```text copy
How do I find the author of a specific commit in a repository's history?
```
1. To run the prompts, in the upper-right corner, click **{% octicon "play" aria-hidden="true" %} Run**.
1. To run the prompts, in the upper-right corner, click **{% octicon "play" aria-hidden="true" aria-label="play" %} Run**.
1. Try out different models against your prompt, making note of the **Latency** and the **Input** and **Output** token usage of the different models.
## Testing prompt variations with a specific model
@@ -114,15 +114,15 @@ Now, let's use {% data variables.product.prodname_github_models %} to test promp
### 1. Adding prompt variations
For this example scenario, select the **same model for each column**, but provide a different prompt variation by editing the "User prompt" field of our existing prompts. Next to each prompt, click {% octicon "pencil" aria-hidden="Edit prompt" %}.
For this example scenario, select the **same model for each column**, but provide a different prompt variation by editing the "User prompt" field of our existing prompts. Next to each prompt, click {% octicon "pencil" aria-hidden="Edit prompt" aria-label="pencil" %}.
1. Click **{% octicon "pencil" aria-hidden="Edit prompt" %}** in "Prompt 2." Then, in the "User prompt" field, copy and paste the following text:
1. Click **{% octicon "pencil" aria-hidden="Edit prompt" aria-label="pencil" %}** in "Prompt 2." Then, in the "User prompt" field, copy and paste the following text:
```text copy
I want to learn how to use Git from the command line, but explain it to me like I am five years old. {{input}}
```
1. Click **{% octicon "pencil" aria-hidden="Edit prompt" %}** in "Prompt 3", then paste the following input:
1. Click **{% octicon "pencil" aria-hidden="Edit prompt" aria-label="pencil" %}** in "Prompt 3", then paste the following input:
```text copy
I want to learn how to use Git from the command line. Give me instructions in the form of a haiku. {{input}}
@@ -130,7 +130,7 @@ For this example scenario, select the **same model for each column**, but provid
### 2. Running prompt variations
1. To run the prompts, in the upper-right corner, click **{% octicon "play" aria-hidden="true" %} Run**.
1. To run the prompts, in the upper-right corner, click **{% octicon "play" aria-hidden="true" aria-label="play" %} Run**.
1. Try out different prompt variations, and compare the types of output the model gives you.
## Evaluating model output
@@ -151,14 +151,14 @@ Depending on the number of prompts and models you are evaluating, the model outp
For this example scenario, let's use the **String check** evaluator to check for a string in the output.
1. In the lower-right corner of the **Prompts** field, click **{% octicon "plus" aria-hidden="true" %} Add evaluator** and select **{% octicon "note" aria-hidden="true" %} String check**.
1. In the lower-right corner of the **Prompts** field, click **{% octicon "plus" aria-hidden="true" aria-label="plus" %} Add evaluator** and select **{% octicon "note" aria-hidden="true" aria-label="note" %} String check**.
1. In the **Name** field, enter "Amend check", then copy and paste the following input for the **Value** field:
```text copy
git commit --amend
```
1. To run the prompts, in the upper-right corner, click **{% octicon "play" aria-hidden="true" %} Run**.
1. To run the prompts, in the upper-right corner, click **{% octicon "play" aria-hidden="true" aria-label="play" %} Run**.
1. The prompt output will now show a **Pass** or **Fail** label, letting you know which model contained the required string.
To learn more about the pre-built evaluators like similarity, groundedness, and relevance, see [AUTOTITLE](/github-models/use-github-models/evaluating-ai-models#evaluating-outputs).

14
content/github-models/use-github-models/prototyping-with-ai-models.md
View File

@@ -73,7 +73,7 @@ The steps to use each model are similar. In general, you will need to:
All models can be used with the Azure AI Inference SDK, and some models support additional SDKs. If you want to easily switch between models, you should select "Azure AI Inference SDK". If you selected "REST" as the language, you won't use an SDK. Instead, you will use the API endpoint directly. {% ifversion fpt %} See [{% data variables.product.prodname_github_models %} REST API](/rest/models?apiVersion=2022-11-28). {% endif %}
1. Either open a codespace, or set up your local environment:
* To run in a codespace, click **{% octicon "codespaces" aria-hidden="true" %} Run codespace**, then click **Create new codespace**.
* To run in a codespace, click **{% octicon "codespaces" aria-hidden="true" aria-label="codespaces" %} Run codespace**, then click **Create new codespace**.
* To run locally:
* Create a {% data variables.product.company_short %} {% data variables.product.pat_generic %}. The token needs to have `models:read` permissions. See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
* Save your token as an environment variable.
@@ -89,16 +89,16 @@ You can save and share your progress in the playground with presets. Presets sav
* Your parameters
* Your chat history (optional)
To create a preset for your current context, select **Preset: PRESET-NAME** {% octicon "triangle-down" aria-hidden="true" %} at the top right of the playground, then click **{% octicon "plus" aria-hidden="true" %} Create new preset**. You need to name your preset, and you can also choose to provide a preset description, include your chat history, and allow your preset to be shared.
To create a preset for your current context, select **Preset: PRESET-NAME** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} at the top right of the playground, then click **{% octicon "plus" aria-hidden="true" aria-label="plus" %} Create new preset**. You need to name your preset, and you can also choose to provide a preset description, include your chat history, and allow your preset to be shared.
There are two ways to load a preset:
* Select the **Preset: PRESET-NAME** {% octicon "triangle-down" aria-hidden="true" %} dropdown menu, then click the preset you want to load.
* Select the **Preset: PRESET-NAME** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} dropdown menu, then click the preset you want to load.
* Open a shared preset URL
After you load a preset, you can edit, share, or delete the preset:
* To edit the preset, change the parameters and prompt the model. Once you are satisfied with your changes, select the **Preset: PRESET-NAME** {% octicon "triangle-down" aria-hidden="true" %} dropdown menu, then click **{% octicon "pencil" aria-hidden="true" %} Edit preset** and save your updates.
* To share the preset, select the **Preset: PRESET-NAME** {% octicon "triangle-down" aria-hidden="true" %} dropdown menu, then click **{% octicon "share" aria-hidden="true" %} Share preset** to get a shareable URL.
* To delete the preset, select the **Preset: PRESET-NAME** {% octicon "triangle-down" aria-hidden="true" %} dropdown menu, then click **{% octicon "trash" aria-hidden="true" %} Delete preset** and confirm the deletion.
* To edit the preset, change the parameters and prompt the model. Once you are satisfied with your changes, select the **Preset: PRESET-NAME** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} dropdown menu, then click **{% octicon "pencil" aria-hidden="true" aria-label="pencil" %} Edit preset** and save your updates.
* To share the preset, select the **Preset: PRESET-NAME** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} dropdown menu, then click **{% octicon "share" aria-hidden="true" aria-label="share" %} Share preset** to get a shareable URL.
* To delete the preset, select the **Preset: PRESET-NAME** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} dropdown menu, then click **{% octicon "trash" aria-hidden="true" aria-label="trash" %} Delete preset** and confirm the deletion.
## Using the prompt editor
@@ -108,7 +108,7 @@ The prompt editor in {% data variables.product.prodname_github_models %} is desi
* Fine-tune prompts for precision and relevance in your projects.
* Use a specialized space for single-turn scenarios to ensure consistent and optimized results.
To access the prompt editor, click **{% octicon "stack" aria-hidden="true" %} Prompt editor** at the top right of the playground.
To access the prompt editor, click **{% octicon "stack" aria-hidden="true" aria-label="stack" %} Prompt editor** at the top right of the playground.
![Screenshot of the 'Prompt editor' button, highlighted with a dark orange outline, at the top right of the playground.](/assets/images/help/models/model-playground-prompt-editor.png)