[doc] add project flag to gcloud TPU command #19664
Conversation
in case user doesn't have one set in gcloud config which might be result in this error. ``` $ gcloud compute tpus tpu-vm ssh TPU_NAME --zone ZONE ERROR: (gcloud.compute.tpus.tpu-vm.ssh) The required property [project] is not currently set. It can be set on a per-command basis by re-running your command with the [--project] flag. You may set it for your current workspace by running: $ gcloud config set project VALUE or it can be set temporarily by the environment variable [CLOUDSDK_CORE_PROJECT] ``` Signed-off-by: David Xia <david@davidxia.com>
|
👋 Hi! Thank you for contributing to the vLLM project. 💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels. Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging. To run CI, PR reviewers can either: Add 🚀 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @davidxia, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request improves the documentation for connecting to a TPU VM via SSH using the gcloud command. It addresses a potential issue where users might encounter an error if their project is not set in the gcloud configuration by explicitly adding the --project flag to the example command. Additionally, it clarifies that the command connects to a 'TPU VM'.
Highlights
- Documentation Update: Updated the
gcloud compute tpus tpu-vm sshcommand example in the TPU installation documentation to include the--project PROJECT_IDflag. - Clarity Improvement: Refined the description for connecting via SSH from 'Connect to your TPU' to 'Connect to your TPU VM' for better accuracy.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configureGemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
|
||
| ```bash | ||
| gcloud compute tpus tpu-vm ssh TPU_NAME --zone ZONE | ||
| gcloud compute tpus tpu-vm ssh TPU_NAME --project PROJECT_ID --zone ZONE |
There was a problem hiding this comment.
Adding the --project PROJECT_ID flag addresses a scenario where users encounter an error if a default project isn't set.
| @@ -90,10 +90,10 @@ gcloud alpha compute tpus queued-resources create QUEUED_RESOURCE_ID \ | |||
| | RUNTIME_VERSION | The TPU VM runtime version to use. For example, use `v2-alpha-tpuv6e` for a VM loaded with one or more v6e TPU(s). For more information see [TPU VM images]. | | |||
| | SERVICE_ACCOUNT | The email address for your service account. You can find it in the IAM Cloud Console under *Service Accounts*. For example: `tpu-service-account@<your_project_ID>.iam.gserviceaccount.com` | | |||
|
|
|||
| Connect to your TPU using SSH: | |||
| Connect to your TPU VM using SSH: | |||
There was a problem hiding this comment.
Clarify that the SSH connection is to the virtual machine.
github-actions
bot
added
the
ready
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
Signed-off-by: David Xia <david@davidxia.com>
Signed-off-by: David Xia <david@davidxia.com> Signed-off-by: minpeter <kali2005611@gmail.com>
Signed-off-by: David Xia <david@davidxia.com> Signed-off-by: Yang Wang <elainewy@meta.com>
Signed-off-by: David Xia <david@davidxia.com>
Signed-off-by: David Xia <david@davidxia.com>
Signed-off-by: David Xia <david@davidxia.com> Signed-off-by: avigny <47987522+avigny@users.noreply.github.com>
in case user doesn't have one set in gcloud config which might be result in this error.