Skip to content

Commit

Permalink
missing docs on docker command.
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulMcHard committed May 13, 2024
1 parent ba13092 commit 7728f4b
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ RUN pip install --upgrade pip && pip install -r requirements.txt
COPY . .

# Expose gRPC server port
EXPOSE 50051
EXPOSE 500XX

# Define the command to run the server
CMD ["python", "regionDetection.py"]
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,21 @@ polylines, vertices = self.find_regions(image.copy(), min_edges=MIN_EDGES, preci

We advise you to use the provided jupyter notebook to play with the region detection service with visual feedback to understand it.

Finally, in order to build your docker image, please update the gRPC Port to a number unique to you. For the purposes of this demonstration, please use the ROS Domain ID on your sign up sheet. Your port number needs to be updated in the following places:

```
- region_detection.py, line 26, PORT = 500XX,
- Dockerfile, line 18, EXPOSE 500XX
```

In both these cases, please update XX to your provided ROS Domain ID.

Lastly, build your docker image using the command, providing a unique image name for your entry.

```bash
docker build -t your-name-region-detector .
```

Good luck and enjoy!

Paul McHard
2 changes: 1 addition & 1 deletion regionDetection.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
PRECISION = 0.01
THRESHOLD = 120

PORT = 50051
PORT = 500XX
ALIAS = "Paul McHard"

# End of Variables
Expand Down

0 comments on commit 7728f4b

Please sign in to comment.