search

pytorch / xla

Enabling PyTorch on XLA Devices (e.g. Google TPU)
https://pytorch.org/xla
Other
2.45k stars 457 forks source link

Documentation: Discoverability of http://pytorch.org/xla #7911

Open tengyifei opened 3 weeks ago

tengyifei commented 3 weeks ago

📚 Documentation: Discoverability of http://pytorch.org/xla

The docs are very hard to find despite being hosted on pytorch.org. If I visit pytorch.org I can't find any link that goes to pytorch.org/xla. The closest I could find is somewhere deep in https://pytorch.org/pytorch-domains and even then it links to version 2.1! I think the discoverability can use some support possibly after we've polished up the landing page.

tengyifei commented 3 weeks ago

cc @mikegre-google Milad mentioned you may be able to help with this. Putting it on your radar. Thanks!

tengyifei commented 2 weeks ago

@mikegre-google What are your thoughts on how this could be improved?

mikegre-google commented 2 weeks ago

@tengyifei I'm working on reorganizing the docs and their TOC. We'd have to create a PR to add a link to the Pytorch/XLA docs. The question is where the link should go. I'll look into this. I don't see a way to assign this issue to me. It may be a permissions issue. Can you assign it to me? Thanks!

tengyifei commented 2 weeks ago

Thanks! I think I set the assignee correctly now.

mikegre-google commented 2 weeks ago

Yes, it's assigned to me now. Thanks!

mikegre-google commented 5 days ago

I created a PR (https://github.com/pytorch/xla/pull/7988) that reorganizes the documentation on pytorch.org/xla. You can find the built docs here: https://drive.google.com/drive/folders/1_jmjS-pFTZFLuZt2p33Q_SQZVVkuG5-h?usp=drive_link start with index.html.