Skip to content
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.

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

Update 2.3 readme #6957

Merged
merged 4 commits into from
Apr 24, 2024
Merged

Update 2.3 readme #6957

merged 4 commits into from
Apr 24, 2024

Conversation

lsy323
Copy link
Collaborator

@lsy323 lsy323 commented Apr 24, 2024

As @will-cromar mentioned in the release doc, the README will be shown on the PyPI page, so update README before the final build

@lsy323 lsy323 changed the base branch from master to r2.3 April 24, 2024 05:32
README.md Outdated
@@ -245,6 +245,7 @@ This is only required on Cloud TPU VMs.
| Version | Cloud TPU VMs Docker |
| --- | ----------- |
| 2.3 | `us-central1-docker.pkg.dev/tpu-pytorch-releases/docker/xla:r2.3.0_3.10_tpuvm` |
| 2.2 | `us-central1-docker.pkg.dev/tpu-pytorch-releases/docker/xla:r2.2.0_3.10_tpuvm` |
Copy link
Collaborator

Choose a reason for hiding this comment

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

can we make sure these docker actually exists before merging?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Cannot verify the 2.3 since it's not built yet, however, we need to update the readme before the final build. See title for reason.

Copy link
Collaborator

Choose a reason for hiding this comment

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

On this branch, just remove all of the image and package versions. We'll update master afterwards. This README cannot change after we upload the package. (See the 2.2 release branch for an example)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@will-cromar Thanks for the heads up, just removed

@lsy323 lsy323 requested a review from JackCaoG April 24, 2024 16:47
@lsy323
Copy link
Collaborator Author

lsy323 commented Apr 24, 2024

Updated the following:

  1. Remove links for whl and docker image, as the page will be on PyPI
  2. Remove the kaggle notebook links, point tutorials to GH main page.

Copy link
Collaborator

@will-cromar will-cromar left a comment

Choose a reason for hiding this comment

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

LGTM, thanks

@lsy323 lsy323 merged commit 8c33979 into r2.3 Apr 24, 2024
18 checks passed
@lsy323 lsy323 deleted the lsiyuan/update-2.3-readme-2 branch April 24, 2024 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants