Update README and requirements.txt

ouster-lidar · May 3, 2023 · c1cabb8 · c1cabb8
1 parent 4922f33
commit c1cabb8
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,18 +1,24 @@
 # ouster-yolov5-demo
+This repo contains sample code on how to utilize Ouster Lidar Data to perform
+common image processing tasks like object detection classification using YOLOv5.
+The sample codes can be ran locally or using Google Colab Notebooks. For a quick
+start we recommend using the Google Colab demo since it has additional notes.
 
-- [Running the demo on Google colab](#running-the-demo-on-google-colab)
-- [Running the demo locally](#running-the-demo-locally)
+- [ouster-yolov5-demo](#ouster-yolov5-demo)
+  - [Running the demo on Google Colab](#running-the-demo-on-google-colab)
+  - [Running the demo locally](#running-the-demo-locally)
     - [Requirements](#requirements)
     - [Getting Lidar Data](#getting-lidar-data)
     - [Ouster YOLOv5 Demo with OpenCV](#ouster-yolov5-demo-with-opencv)
-    - [Ouster YOLOv5 Demo with SimpleViz](#ouster-yolov5-demo-with-simplviz)
-## Running the demo on Google colab
-Follow the link ![Ouster_Yolo5_Demo](./Ouster_Yolo5_Demo.ipynb) to run the demo using Google Colab
+    - [Ouster YOLOv5 Demo with SimplViz](#ouster-yolov5-demo-with-simplviz)
+
+## Running the demo on Google Colab
+Follow the link ![Ouster_Yolo5_Demo](./Ouster_Yolo5_Demo.ipynb) to run the demo
+using Google Colab
 
 ## Running the demo locally
 
 ### Requirements
-TODO: Complete the list of requirements
 ```bash
 pip install -r requirements.txt
 ```
@@ -24,4 +30,4 @@ The repo [yolov5-ouster-lidar-data](https://github.com/ouster-lidar/yolov5-ouste
 ![Ouster YOLOv5 Demo](./yolo5_opencv.py)
 
 ### Ouster YOLOv5 Demo with SimplViz
-![Ouster YOLOv5 Demo / SimpleViz](./yolo5_simpleviz.py)
+![Ouster YOLOv5 Demo / SimpleViz](./yolo5_simpleviz.py)
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,19 @@
-torch>=2.0.0
+# pip install -r requirements.txt
+
+# ouster python sdk ---------------------------
 ouster-sdk>=0.8.1
 
-#TODO: add remaining requirements.txt
+# opencv / torch installs ---------------------
+torch>=2.0.0
+torchvision>=0.15.1
+opencv-python>=4.7.0
+tqdm>=4.41.0
+matplotlib>=3.7.1
+pandas>=1.1.4
+seaborn>=0.11.0
+gitpython>=3.1.30
+scipy>=1.4.1
+setuptools>=65.5.1
+psutil
+requests
+pyyaml