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

Effectively manage API usability changes #7756

Open
miladm opened this issue Jul 26, 2024 · 0 comments
Open

Effectively manage API usability changes #7756

miladm opened this issue Jul 26, 2024 · 0 comments
Assignees
Labels
usability Bugs/features related to improving the usability of PyTorch/XLA

Comments

@miladm
Copy link
Collaborator

miladm commented Jul 26, 2024

📚 Documentation

Context: PyTorch/XLA is going through a heavy set of changes to its API surface area to make it easier for the users to take advantage of this technology.

While we go through this exercise in the next few quarters, it's crucial to ensure users easily follow the changes. To this end, I propose the following two tasks:

Task1: maintain a GH table that outlines the following information for any user-facing API/env-variable change. Maintain a table with these columns:

  • New API Name
  • Release version with new API
  • Nighly date with new API
  • Old API Name
  • Last release version supporting the old API
  • A RFC GH link explaining the API change

I suggest we pin this page on the GH Issue section for easy access by users.

Task2: update the deprecation logic to reflect more information. The following information should be included in the messaging:

  • old_name last release version support
  • Link to the GH page that tracks Task1

cc @will-cromar @JackCaoG

@miladm miladm added the usability Bugs/features related to improving the usability of PyTorch/XLA label Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
usability Bugs/features related to improving the usability of PyTorch/XLA
Projects
None yet
Development

No branches or pull requests

2 participants