Skip to content

Add docker build instructions to README #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add docker build instructions to README #37

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
648bfcd
Add docker build instructions to README
nikochiko Aug 13, 2025
c76ca7a
fix: use -f option for docker build
nikochiko Aug 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,16 +198,19 @@ gooey-gpu also provides a small python helper library to make it easy to write c

10. Once you are confident that the model is working as expected, upload the docker image to a container registry.

For exaxmple, if building the 5th version of `gooey-gpu-common` from the `common` directory:

Comment on lines +201 to +202
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix typo in user-facing docs ("For exaxmple" → "For example").

Spelling error in a prominent header; fix to maintain polish.

-    For exaxmple, if building the 5th version of `gooey-gpu-common` from the `common` directory:
+    For example, if building version 5 of `gooey-gpu-common` from the `common` directory:
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
For exaxmple, if building the 5th version of `gooey-gpu-common` from the `common` directory:
For example, if building version 5 of `gooey-gpu-common` from the `common` directory:
🧰 Tools
🪛 LanguageTool

[grammar] ~201-~201: Ensure spelling is correct
Context: ...image to a container registry. For exaxmple, if building the 5th version of `gooey-...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents 
In README.md around lines 201-202, fix the spelling typo in the sentence
beginning "For exaxmple..." by replacing "exaxmple" with "example" so the line
reads "For example, if building the 5th version of `gooey-gpu-common` from the
`common` directory:" and ensure punctuation/spacing remains correct.

```bash
docker tag gooey-gpu-common <registry>/<image>:<tag>
docker push <registry>/<image>:<tag>
docker build -f common/Dockerfile -t gooey-gpu-common .
docker tag gooey-gpu-common <registry>/gooey-gpu-common:5
docker push <registry>/gooey-gpu-common:5
```

You might need to login to your container registry before pushing the image. Eg for azure:
```bash
az acr login --name <registry>
```
11. Update the `model-values.yaml` file with the new image (or create a new file)
12. Update the `model-values.yaml` file with the new image (or create a new file)
- Under `rabbitmqAutoscaling`, add the new env var name
```yaml
rabbitmqAutoscaling:
Expand Down
Loading