Skip to content

Commit 32e4f7c

Browse files
authored
Improve README.md content and structure [skip ci]
Updated README.md for clarity and added detailed documentation links.
1 parent fd33c3b commit 32e4f7c

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# diffsptk
22

3-
*diffsptk* is a differentiable version of [SPTK](https://github.com/sp-nitech/SPTK) based on the PyTorch framework.
3+
*diffsptk* is a differentiable version of [SPTK](https://github.com/sp-nitech/SPTK) built on the PyTorch framework.
4+
It provides various speech signal processing modules as PyTorch layers,
5+
allowing users to integrate classic signal processing algorithms directly into neural network architectures and optimize them through backpropagation.
46

57
[![Manual](https://img.shields.io/badge/docs-stable-blue.svg)](https://sp-nitech.github.io/diffsptk/3.4.0/)
68
[![Downloads](https://static.pepy.tech/badge/diffsptk)](https://pepy.tech/project/diffsptk)
79
[![ClickPy](https://img.shields.io/badge/downloads-clickpy-yellow.svg)](https://clickpy.clickhouse.com/dashboard/diffsptk)
8-
[![Advisor](https://snyk.io/advisor/python/diffsptk/badge.svg)](https://snyk.io/advisor/python/diffsptk)
910
[![Python Version](https://img.shields.io/pypi/pyversions/diffsptk.svg)](https://pypi.python.org/pypi/diffsptk)
1011
[![PyTorch Version](https://img.shields.io/badge/pytorch-2.3.1%20%7C%202.9.1-orange.svg)](https://pypi.python.org/pypi/diffsptk)
1112
[![PyPI Version](https://img.shields.io/pypi/v/diffsptk.svg)](https://pypi.python.org/pypi/diffsptk)
@@ -21,19 +22,19 @@
2122

2223
## Documentation
2324

24-
- Online [documentation](https://sp-nitech.github.io/diffsptk/3.4.0/) for the reference manual
25-
- Conference [paper](https://www.isca-archive.org/ssw_2023/yoshimura23_ssw.html) on the ISCA Archive
26-
- Hands-on [tutorial](https://colab.research.google.com/drive/1xAoUKqXadvJXJ7RzN0OceB6y7q5i7Sn6?usp=drive_link) on Google Colab
25+
- [**Reference Manual**](https://sp-nitech.github.io/diffsptk/3.4.0/) - Detailed API documentation and module specifications.
26+
- [**Interactive Tutorial**](https://colab.research.google.com/drive/1xAoUKqXadvJXJ7RzN0OceB6y7q5i7Sn6?usp=drive_link) (Google Colab) - Hands-on examples to get started with `diffsptk` in your browser.
27+
- [**Conference Paper**](https://www.isca-archive.org/ssw_2023/yoshimura23_ssw.html) - Technical background and implementation details available on the ISCA Archive.
2728

2829
## Installation
2930

30-
The latest stable release can be installed through PyPI by running
31+
The latest stable release can be installed via PyPI:
3132

3233
```sh
3334
pip install diffsptk
3435
```
3536

36-
The development release can be installed from the master branch:
37+
Alternatively, the development version can be installed directly from the GitHub repository:
3738

3839
```sh
3940
pip install git+https://github.com/sp-nitech/diffsptk.git@master

0 commit comments

Comments
 (0)