Skip to content

Commit d7383d0

Browse files
authored
Update docs (#7)
* readme * doc
1 parent 843a382 commit d7383d0

File tree

3 files changed

+21
-6
lines changed

3 files changed

+21
-6
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,28 @@ Azure AI Content Understanding is a new Generative AI-based [Azure AI service](h
1717
| [analyzer_training.ipynb](notebooks/analyzer_training.ipynb) | Provide training data to improve the quality of your analyzer |
1818

1919

20-
## Getting started with GitHub Codespaces
21-
20+
## Getting started
21+
### GitHub Codespaces
2222
You can run this repo virtually by using GitHub Codespaces, which will open a web-based VS Code in your browser.
2323

2424
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?skip_quickstart=true&machine=basicLinux32gb&repo=899687170&ref=main&geo=UsEast&devcontainer_path=.devcontainer%2Fdevcontainer.json)
2525

26-
### Configure Azure AI service resource
26+
### Local environment
27+
28+
1. Make sure the following tools are installed:
29+
30+
* [Azure Developer CLI (azd)](https://aka.ms/install-azd)
31+
* [Python 3.9+](https://www.python.org/downloads/)
32+
33+
2. Make a new directory called `azure-ai-content-understanding-python` and clone this template into it using the `azd` CLI:
34+
35+
```shell
36+
azd init -t azure-ai-content-understanding-python
37+
```
38+
39+
You can also use git to clone the repository if you prefer.
40+
41+
## Configure Azure AI service resource
2742
### (Option 1) Use `azd` commands to auto create temporal resources to run sample
2843
1. Login Azure
2944
```shell
@@ -41,7 +56,7 @@ You can run this repo virtually by using GitHub Codespaces, which will open a we
4156
1. Copy `notebooks/.env.sample` to `notebooks/.env`
4257
1. Fill **AZURE_AI_ENDPOINT** with the endpoint from your Azure portal Azure AI Services instance.
4358

44-
### Open a Jupyter notebook and follow the step-by-step guidance
59+
## Open a Jupyter notebook and follow the step-by-step guidance
4560

4661
Navigate to the `notebooks` directory and select the sample notebook you are interested in. Since Codespaces is pre-configured with the necessary environment, you can directly execute each step in the notebook.
4762

notebooks/analyzer_training.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"\n",
1717
"\n",
1818
"## Prerequisites\n",
19-
"1. Follow steps in [README](../README.md#Configure-Azure-AI-Service-resource) to create `.env` file to configure your Azure AI Service.\n",
19+
"1. Ensure Azure AI service is configured following [steps](../README.md#configure-azure-ai-service-resource)\n",
2020
"1. Follow steps in [Set labeled data](../docs/set_env_for_labeled_data.md) to add training data related env variables in `.env`.\n",
2121
"1. Install packages needed to run the sample\n",
2222
"\n",

notebooks/field_extraction.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"metadata": {},
2020
"source": [
2121
"## Prerequisites\n",
22-
"1. Follow the steps in the [README](../README.md#Configure-Azure-AI-Service-resource) to create a `.env` file and configure your Azure AI Service.\n",
22+
"1. Ensure Azure AI service is configured following [steps](../README.md#configure-azure-ai-service-resource)\n",
2323
"2. Install the required packages to run the sample."
2424
]
2525
},

0 commit comments

Comments
 (0)