Skip to content

Commit 272730b

Browse files
committed
Fix nits
Signed-off-by: Rajvaibhav Rahane <[email protected]>
1 parent 7cd1995 commit 272730b

File tree

1 file changed

+9
-14
lines changed

1 file changed

+9
-14
lines changed

DEVELOPER_GUIDE.md

+9-14
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ git clone https://github.com/[username]/remote-vector-index-builder.git
3131
### Install Prerequisites
3232

3333
#### Python Dependencies
34+
35+
The following are commands to install dependencies during local development and testing.
36+
The required dependencies are installed during Docker image creation onto the image.
37+
3438
Core Dependencies:
3539
```
3640
pip install -r remote_vector_index_builder/core/requirements.txt
@@ -65,7 +69,7 @@ The static type checking can be done with:
6569
```
6670
mypy remote_vector_index_builder/ test_remote_vector_index_builder/
6771
```
68-
The python tests can be run with:
72+
The Python tests can be run with:
6973
```
7074
pytest test_remote_vector_index_builder/
7175
```
@@ -101,7 +105,7 @@ docker build -f ./remote_vector_index_builder/core/Dockerfile . -t opensearchst
101105

102106
## Provisioning an instance for development
103107

104-
A NVIDIA GPU Powered machine with CUDA Toolkit installed is required to build a Faiss Base Image, and to run the docker images to build an index.
108+
A NVIDIA GPU Powered machine with CUDA Toolkit installed is required to build a Faiss Base Image, and to run the Docker images to build an index.
105109

106110
Typically an [EC2 G5](https://aws.amazon.com/ec2/instance-types/g5/) 2xlarge instance running a Deep Learning OSS Nvidia Driver AMI, with Docker CLI installed is recommended for development use.
107111

@@ -113,24 +117,15 @@ Simple memory profiling can be done during development to get memory usage stati
113117

114118
### GPU Memory Profiling with NVIDIA SMI
115119

116-
1. Install [py3nvml](https://pypi.org/project/py3nvml/):
120+
1. Install [py3nvml](https://pypi.org/project/py3nvml/): In [`/remote_vector_index_builder/core/requirements.txt`](/remote_vector_index_builder/core/requirements.txt) add py3nvml on a newline.
117121

118-
In [`/remote_vector_index_builder/core/requirements.txt`](/remote_vector_index_builder/core/requirements.txt) add py3nvml on a newline.
119-
120-
2. Run the following command:
121-
```
122-
pip install --no-cache-dir --upgrade -r /remote_vector_index_builder/core/requirements.txt
123-
```
124-
125-
3. Add import statement and initialize method in the file containing the driver code.
122+
2. Add import statement and initialize method in the file containing the driver code.
126123
```
127124
from py3nvml import nvidia_smi
128125
nvidia_smi.nvmlInit()
129126
```
130127

131-
4. Define and call the below method wherever necessary.
132-
133-
e.g. before and after calling the GPU index cleanup method.
128+
3. Define and call the below method wherever necessary. e.g. before and after calling the GPU index cleanup method.
134129
```
135130
from py3nvml import nvidia_smi
136131

0 commit comments

Comments
 (0)