Skip to content

Commit 94849bb

Browse files
authored
Update common-prerequisites.md (NVIDIA#203)
1 parent c84959d commit 94849bb

File tree

1 file changed

+29
-42
lines changed

1 file changed

+29
-42
lines changed

docs/common-prerequisites.md

Lines changed: 29 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -3,66 +3,53 @@
33
SPDX-License-Identifier: Apache-2.0
44
-->
55

6-
# Common Prerequisites for RAG Examples
7-
<!-- TOC -->
6+
# Prerequisites
87

9-
* [Clone the Repository and Install Software](#clone-the-repository-and-install-software)
10-
* [Get an API Key for the Accessing Models on the API Catalog](#get-an-api-key-for-the-accessing-models-on-the-api-catalog)
11-
* [Get an NVIDIA NGC API Key](#get-an-nvidia-ngc-api-key)
8+
1. Clone the Generative AI examples Git repository using Git LFS:
129

13-
<!-- /TOC -->
10+
```console
11+
sudo apt -y install git-lfs
12+
git clone [email protected]:NVIDIA/GenerativeAIExamples.git
13+
cd GenerativeAIExamples/
14+
git lfs pull
15+
```
1416

15-
## Clone the Repository and Install Software
17+
2. Install Docker Engine. Refer to these instructions for [Ubuntu](https://docs.docker.com/engine/install/ubuntu/).
1618

17-
- Clone the Generative AI examples Git repository using Git LFS:
19+
3. Install Docker Compose. Refer to these instructions to [install the Compose plugin](https://docs.docker.com/compose/install/linux/).
1820

19-
```console
20-
sudo apt -y install git-lfs
21-
git clone [email protected]:NVIDIA/GenerativeAIExamples.git
22-
cd GenerativeAIExamples/
23-
git lfs pull
24-
```
21+
a. Ensure the Docker Compose plugin version is 2.20 or higher.
2522

26-
- Install Docker Engine and Docker Compose.
27-
Refer to the instructions for [Ubuntu](https://docs.docker.com/engine/install/ubuntu/).
23+
b. After you get the Docker Compose plugin installed, run `docker compose version` to confirm.
24+
25+
4. Optional: You can run some containers with GPU acceleration, such as Milvus and NVIDIA NIM for LLMs. To configure Docker for GPU-accelerated containers, [install](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) the NVIDIA Container Toolkit.
2826

29-
Ensure the Docker Compose plugin version is 2.29.1 or higher.
30-
Run `docker compose version` to confirm.
31-
Refer to [Install the Compose plugin](https://docs.docker.com/compose/install/linux/)
32-
in the Docker documentation for more information.
27+
5. Get an API key to access models in the API Catalog. You can use different model API endpoints with the same API key.
3328

34-
- Optional: You can run some containers with GPU acceleration, such as Milvus and NVIDIA NIM for LLMs.
35-
To configure Docker for GPU-accelerated containers, [install](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) the NVIDIA Container Toolkit.
29+
a. Navigate to [https://build.nvidia.com/explore/discover](https://build.nvidia.com/explore/discover).
3630

37-
## Get an API Key for the Accessing Models on the API Catalog
31+
b. Find the **Llama 3.1 70B Instruct** card and click the card.
3832

39-
Perform the following steps if you do not already have an API key.
40-
You can use different model API endpoints with the same API key.
33+
![Llama 3 70B Instruct model card](images/llama3-70b-instruct-model-card.png)
4134

42-
1. Navigate to <https://build.nvidia.com/explore/discover>.
35+
c. Click **Get API Key**.
4336

44-
2. Find the **Llama 3 70B Instruct** card and click the card.
37+
![API section of the model page.](images/llama3-70b-instruct-get-api-key.png)
4538

46-
![Llama 3 70B Instruct model card](images/llama3-70b-instruct-model-card.png)
39+
d. Click **Generate Key**.
4740

48-
3. Click **Get API Key**.
41+
![Generate key window.](images/api-catalog-generate-api-key.png)
4942

50-
![API section of the model page.](images/llama3-70b-instruct-get-api-key.png)
43+
e. Click **Copy Key** and then save the API key. The key begins with the letters ``nvapi-``.
5144

52-
4. Click **Generate Key**.
45+
![Key Generated window.](images/key-generated.png)
5346

54-
![Generate key window.](images/api-catalog-generate-api-key.png)
47+
6. Get an NGC license. Choose one of the following methods.
5548

56-
5. Click **Copy Key** and then save the API key.
57-
The key begins with the letters nvapi-.
49+
a. Try before you buy and [request a 90-day trial](https://enterpriseproductregistration.nvidia.com/?LicType=EVAL&ProductFamily=NVAIEnterprise). For more information, refer to the [NVIDIA AI Enterprise Overview](https://www.nvidia.com/en-us/data-center/products/ai-enterprise/).
5850

59-
![Key Generated window.](images/key-generated.png)
51+
b. Create an account with the [NVIDIA Developer Program](https://developer.nvidia.com/login). For more information, refer to the [NVIDIA Developer Program Overview](https://developer.nvidia.com/developer-program).
6052

61-
## Get an NVIDIA NGC API Key
53+
7. Get an NVIDIA NGC API key. The NVIDIA NGC API key is required to log in to the NVIDIA container registry, nvcr.io, and to pull secure base container images used in the examples. Refer to these instructions to [generate an NGC API key](https://docs.nvidia.com/ngc/gpu-cloud/ngc-user-guide/index.html#generating-api-key).
6254

63-
The NVIDIA NGC API Key is required to log in to the NVIDIA container registry, nvcr.io, and to pull secure base container images used in the RAG examples.
64-
65-
Refer to [Generating NGC API Keys](https://docs.nvidia.com/ngc/gpu-cloud/ngc-user-guide/index.html#generating-api-key)
66-
in the _NVIDIA NGC User Guide_ for more information.
67-
68-
After you get your NGC API key, you can run `docker login nvcr.io` to confirm the key is valid.
55+
a. After you get your NGC API key, you can run `docker login nvcr.io` to confirm the key is valid.

0 commit comments

Comments
 (0)