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

PR template & readme update #194

Merged
merged 2 commits into from
Jul 27, 2024
Merged
Show file tree
Hide file tree
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
19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Thank you for your contribution to the MindAudio repo.
Before submitting this PR, please make sure:

- [ ] You have read the [Contributing Guidelines on pull requests](https://github.com/mindspore-lab/mindaudio/blob/main/CONTRIBUTING.md)
- [ ] Your code builds clean without any errors or warnings
- [ ] You are using approved terminology
- [ ] You have added unit tests

## Motivation

(Write your motivation for proposed changes here.)

## Test Plan

(How should this PR be tested? Do you require special setup to run the test or repro the fixed bug?)

## Related Issues and PRs

(Is this PR part of a group of changes? Link the other relevant PRs and Issues here. Use https://help.github.com/en/articles/closing-issues-using-keywords for help on GitHub syntax)
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

[Introduction](#introduction) |
[Installation](#installation) |
[Get Started](#get-started)
[Get Started](#get-started-with-audio-data-analysis)

English | [中文](README_CN.md)

Expand All @@ -24,11 +24,11 @@ MindAudio is a toolbox of audio models and algorithms based on [MindSpore](https

The following is the corresponding `mindaudio` versions and supported `mindspore` versions.

| `mindspore` | `mindaudio` |
| `mindspore` | `mindaudio` |
|--------------|-------------|
| `master` | `master` |
| `2.3.0` | `0.4` |
| `2.2.10` | `0.3` |
| `master` | `master` |
| `2.3.0` | `0.4` |
| `2.2.10` | `0.3` |

### data processing

Expand Down
16 changes: 8 additions & 8 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

[Introduction](#introduction) |
[Installation](#installation) |
[Get Started](#get-started)
[介绍](#介绍) |
[安装](#安装) |
[快速入门](#快速入门音频数据分析)

[English](README.md) | 中文
</div>
Expand All @@ -22,11 +22,11 @@ MindAudio 是基于 [MindSpore](https://www.mindspore.cn/) 的音频模型和算

下表显示了相应的 `mindaudio` 版本和支持的 `mindspore` 版本。

| `mindspore` | `mindaudio` | `tested hardware` |
|--------------|-------------|------------------------------|
| `master` | `master` | `ascend 910*` |
| `2.3.0` | `0.4` | `ascend 910*` |
| `2.2.10` | `0.3` | `ascend 910` & `ascend 910*` |
| `mindspore` | `mindaudio` |
|--------------|-------------|
| `master` | `master` |
| `2.3.0` | `0.4` |
| `2.2.10` | `0.3` |

### 数据处理

Expand Down
Loading