Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 25 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# PyTorch Out-of-tree Accelerator TestInfra
# PyTorch Accelerator Integration

Welcome! This repository is designed to facilitate the integration testing of
different accelerators with PyTorch. Our primary focus is to ensure seamless
integration and compatibility across various devices by running comprehensive
GitHub workflows.
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.

## Accelerator Integration Test Results
## Accelerator Integration Guide

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).

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.

## Accelerator Integration Tests

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.

### Key Features

- **Automated Integration Tests**: Run tests automatically for different devices using GitHub Actions.
- **Reusable Workflows**: Leverage modular and reusable workflows to streamline the testing process.

### Integration Test Results

<details>

Expand Down Expand Up @@ -123,41 +135,23 @@ GitHub workflows.

</details>

## Overview

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.

### Key Features

- **Automated Integration Tests**: Run tests automatically for different devices using GitHub Actions.
- **Reusable Workflows**: Leverage modular and reusable workflows to streamline the testing process.

## Usage

### Running Tests
## Contributing

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

### Customizing Workflows
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.

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

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

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

### Reporting Issues

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

## License

Expand Down