diff --git a/docs/workshop/workshop.ipynb b/docs/workshop/workshop.ipynb index 06955675..bc4f2216 100644 --- a/docs/workshop/workshop.ipynb +++ b/docs/workshop/workshop.ipynb @@ -269,25 +269,39 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "## 4. Setting up automated evaluations with Github Actions \n", + "## 4. Setting up automated evaluations and deployment with Github Actions \n", "\n", "Contoso Creative Writer is set up to run a CI/CD pipeline, which stands for Continuous Integration and Continuous Deployment. This is a series of automated steps that streamline the process of delivering software.\n", "\n", - "- Continuous Integration (CI): This involves automatically integrating code changes from multiple contributors into a shared repository several times a day.\n", - "- Continuous Deployment (CD): This involves automatically deploying the integrated code to production environments. \n", - "\n", "In this sample code the CI/CD pipeline includes the following: \n", - "1. Build and Deploy: Automatically building and deploying the latest version of the code to production (This helps us confirm things are working as expected.)\n", - "2. Evaulations: Automatically sending example research, product and assignment instructions to Contoso Creative Writer and running evaulations on the produced article to see how fluent, grounded, relevant and x the final response was given the questions. \n", + "1. **Build and Deploy:** Automatically building and deploying the latest version of the code to production (This helps us confirm things are working as expected.)\n", + "2. **Evaulations:** Automatically sending example research, product and assignment instructions to Contoso Creative Writer and running evaulations on the produced article to see how fluent, grounded, relevant and x the final response was given the questions. \n", + "\n", + "\n", + "To set up CI/CD with GitHub actions on your repository, **open a new terminal** and: \n", + "\n", + "1. Run the following command:\n", + "\n", + " ```shell\n", + " azd pipeline config\n", + " ```\n", "\n", + " - select an environment name like yourname-aitour\n", + " - select the recommended subscription by pressing enter\n", + " - select `East US 2` as the Azure Location \n", + " - When asked to Log in using the Github CLI type in `Y`\n", + " - Choose `HTTPS` as the preferred protocol for Git Operations \n", + " - Select `Y` to Authenticate with your Github credentials. \n", + " - Choose Login with a web browser to authenticate Github CLI and follow the authentication instructions. \n", + " - You may be asked if you want to commit and push your local changes. Choose `n`\n", + " - You should see two links in your terminal. Select the Link to view your pipeline status. \n", "\n", - "To set up CI/CD with GitHub actions on your repository, open a new terminal and run the following command:\n", + "2. You should now be on a page that shows all the workflows. It should look similar to the image below. \n", "\n", - "```shell\n", - "azd pipeline config\n", - "```\n", + "- Click on the workflow named evaluate (outlined in red in the image).\n", + "- It may need a few minutes to complete but once complete you should see the evaluated results on the page. \n", "\n", - "To see the results " + "You should see a table with some scores for relevance, fluencey, coherence and groundedness. The scores are from 1-5, with 5 being the highest mark. These are used to help us know how well the model is performing. This is helpful as a metric and " ] } ], diff --git a/infra/hooks/postprovision.sh b/infra/hooks/postprovision.sh index f1aaa8b3..f3c81b4b 100755 --- a/infra/hooks/postprovision.sh +++ b/infra/hooks/postprovision.sh @@ -66,4 +66,4 @@ jupyter nbconvert --execute --to python --ExecutePreprocessor.timeout=-1 data/cr echo "--- ✅ | 3. Post-provisioning - populated data ---" -echo "--- 🎉 | 4. Access your ACA deployed web app here: $WEB_SERVICE_ACA_URI +echo "--- 🎉 | 4. Access your ACA deployed web app here: ${WEB_SERVICE_ACA_URI}"