Skip to content

Commit 86872e3

Browse files
authored
Update ReadMe to contain working group items (#31)
Fix #22
1 parent 0a132dd commit 86872e3

File tree

1 file changed

+25
-31
lines changed

1 file changed

+25
-31
lines changed

README.md

Lines changed: 25 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
1-
# PyTorch Out-of-tree Accelerator TestInfra
1+
# PyTorch Accelerator Integration
22

3-
Welcome! This repository is designed to facilitate the integration testing of
4-
different accelerators with PyTorch. Our primary focus is to ensure seamless
5-
integration and compatibility across various devices by running comprehensive
6-
GitHub workflows.
3+
This repository is dedicated to improving and streamlining the integration of diverse AI hardware accelerators with PyTorch. It supports the efforts of the Accelerator Integration Working Group to reduce integration complexity, enhance the integration mechanism, and establish reliable CI infrastructure for out-of-tree accelerators. The goal is to build a scalable and inclusive PyTorch hardware ecosystem.
74

8-
## Accelerator Integration Test Results
5+
## Accelerator Integration Guide
6+
7+
New hardware accelerators can integrate with PyTorch using the shared dispatch key [PrivateUse1](https://docs.pytorch.org/tutorials/advanced/privateuseone.html). We're currently working on a comprehensive guide to help developers connect their custom hardware to PyTorch. This guide will include step-by-step instructions and practical examples based on the [OpenReg](https://github.com/pytorch/pytorch/tree/main/test/cpp_extensions/open_registration_extension/torch_openreg) reference implementation. For more details, refer to the related [RFC](https://github.com/pytorch/rfcs/blob/f6048cbd4fcc7877de6b049f96c0b9dece74cbd8/RFC-0045-PyTorch-Accelerator-Integration-Enhancements.md).
8+
9+
This effort is actively in progress. You can follow related discussions and open issues labeled [OpenReg](https://github.com/pytorch-fdn/accelerator-integration-wg/issues?q=is%3Aissue%20state%3Aopen%20label%3AOpenReg). Community contributions are highly encouraged and welcome.
10+
11+
## Accelerator Integration Tests
12+
13+
This repository contains workflows and scripts that automate the testing process for integrating different hardware devices with PyTorch. The tests aim to validate that PyTorch's device-specific functionalities are working correctly and efficiently across different platforms.
14+
15+
### Key Features
16+
17+
- **Automated Integration Tests**: Run tests automatically for different devices using GitHub Actions.
18+
- **Reusable Workflows**: Leverage modular and reusable workflows to streamline the testing process.
19+
20+
### Integration Test Results
921

1022
<details>
1123

@@ -123,41 +135,23 @@ GitHub workflows.
123135

124136
</details>
125137

126-
## Overview
127138

128-
This repository contains workflows and scripts that automate the testing
129-
process for integrating different hardware devices with PyTorch. The tests aim
130-
to validate that PyTorch's device-specific functionalities are working
131-
correctly and efficiently across different platforms.
132-
133-
### Key Features
134-
135-
- **Automated Integration Tests**: Run tests automatically for different devices using GitHub Actions.
136-
- **Reusable Workflows**: Leverage modular and reusable workflows to streamline the testing process.
137-
138-
## Usage
139-
140-
### Running Tests
139+
## Contributing
141140

142-
To run the integration tests, the repository leverages GitHub Actions.
143-
You can trigger the tests by pushing code to the repository or by manually
144-
triggering the workflows.
141+
We welcome contributions to all aspects of the PyTorch accelerator integration mechanism — including APIs, tooling, CI infrastructure, documentation, and device support.
145142

146-
### Customizing Workflows
143+
You can explore open tasks and priorities on our [project dashboard](https://github.com/orgs/pytorch-fdn/projects/13/views/2), and look for issues labeled `help wanted` to get started. Feel free to submit issues, pull requests, or suggestions to help us build a more flexible and scalable hardware integration ecosystem. See the [CONTRIBUTING](CONTRIBUTING.md) guide for details.
147144

148-
For customize your own workflows, here are some reference configuration in [workflow](https://github.com/pytorch-fdn/oota/tree/main/.github/workflows).
145+
Stay connected:
149146

150-
## Contributing
147+
* **Slack channel**: `#tac-accelerator-integration-wg` on the [PyTorch Slack](https://pytorch.slack.com/)
148+
* **Participate working group meeting**: [Meeting Notes](https://docs.google.com/document/d/10G2fib_76CV4TCf47S-r6R6sg845-ty_ujur_giMNMI)
151149

152-
We welcome contributions to enhance the integration testing process. Feel free
153-
to submit issues, pull requests, or suggestions to help us improve the
154-
compatibility and performance of PyTorch on various devices. See the
155-
[CONTRIBUTING](CONTRIBUTING.md) for more details.
156150

157151
### Reporting Issues
158152

159153
If you encounter any issues while using the workflows or integrating a device,
160-
please report them via the [Issues](https://github.com/pytorch-fdn/oota/issues) tab.
154+
please report them via the [Issues](https://github.com/pytorch-fdn/accelerator-integration-wg/issues) tab.
161155

162156
## License
163157

0 commit comments

Comments
 (0)