Skip to content

Commit 67950af

Browse files
authored
Merge pull request #232 from smsohan/doc-update
Updates README to indicate that the repo have CI enabled to auto publ…
2 parents 6e47f8b + 30dfe98 commit 67950af

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

Demos/Gemma-on-Cloudrun/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@ We provide pre-built Docker images for convenience. These images have the respec
2222
* `us-docker.pkg.dev/cloudrun/container/gemma/gemma3n-e2b`
2323
* `us-docker.pkg.dev/cloudrun/container/gemma/gemma3n-e4b`
2424

25+
These images are automatically built and published using [Cloud Build](./cloudbuild.yaml) when there's a code change in this directory.
26+
2527
## Quickstart - Deploying to Cloud Run
26-
This section guides you through deploying a Cloud Run service using our provided Docker images. If you've deployed Gemma to Cloud Run from AI Studio, it mirrors this process.
28+
This section guides you through deploying a Cloud Run service using our provided Docker images. If you've deployed Gemma to Cloud Run from AI Studio, it mirrors this process.
2729

2830
Use the following `gcloud run deploy` command to deploy your Cloud Run service:
2931
```bash
@@ -46,7 +48,7 @@ gcloud run deploy {SERVICE_NAME} \
4648
Explanation of Variables:
4749
* `SERVICE_NAME`: The unique name for your Cloud Run service.
4850
* `IMAGE`: The Docker image to deploy. This can be one of our [pre-built images](#pre-built-docker-images) or an image you built yourself from this repository
49-
* `YOUR_API_KEY`: **Crucial for authentication**. Set this to a strong, unique API key string of your choice. This key will be required to access your service. See the [Authentication](#authentication) section below for more details. If you're deploying from AI Studio, this is generated on your behalf. Note that this should *not* be an API key re-used from another service.
51+
* `YOUR_API_KEY`: **Crucial for authentication**. Set this to a strong, unique API key string of your choice. This key will be required to access your service. See the [Authentication](#authentication) section below for more details. If you're deploying from AI Studio, this is generated on your behalf. Note that this should *not* be an API key re-used from another service.
5052
* `REGION`: The Google Cloud region where your Cloud Run service will be deployed (e.g., us-central1). Ensure this region supports the specified GPU type. See [GPU support for Cloud Run services](https://cloud.google.com/run/docs/configuring/services/gpu) for more details. If you're deploying from AI Studio, this defaults to europe-west1.
5153
* For other flags and optimizing setting, see [Run LLM inference on Cloud Run GPUs with Gemma 3 and Ollama](https://cloud.google.com/run/docs/tutorials/gpu-gemma-with-ollama#build-and-deploy) for more details.
5254

@@ -65,7 +67,7 @@ For enhanced security, store your API key in Google Cloud Secret Manager and exp
6567
You will need to include this `YOUR_API_KEY` in every request to your Cloud Run service, as shown in the [Interacting with the Service](#interacting-with-the-cloud-run-service) section.
6668

6769
### Using IAM Authentication (recommended)
68-
For production, you should configure your Cloud Run service to use IAM Authentication. You can enable this by re-deploying your Cloud Run service with the `--no-allow-unauthenticated` flag. Note that this will require changes to your application code, to ensure incoming requests pass the appropriate identity token.
70+
For production, you should configure your Cloud Run service to use IAM Authentication. You can enable this by re-deploying your Cloud Run service with the `--no-allow-unauthenticated` flag. Note that this will require changes to your application code, to ensure incoming requests pass the appropriate identity token.
6971
To learn more about IAM authentication and Cloud Run, refer to [Authenticating service-to-service](https://cloud.google.com/run/docs/authenticating/service-to-service#use_the_authentication_libraries).
7072

7173
## Interacting with the Cloud Run Service
@@ -166,8 +168,8 @@ openAIclient = OpenAI(
166168
completion = openAIclient.chat.completions.create(
167169
model="<model>", # Example: "gemma3:4b" or your custom model name
168170
messages=[
169-
{
170-
"role": "developer",
171+
{
172+
"role": "developer",
171173
"content": "You are a helpful assistant."
172174
},
173175
{

0 commit comments

Comments
 (0)