Unverified Commit 9ad450ac authored by ProGamerGov's avatar ProGamerGov Committed by GitHub
Browse files

Fix multiple grammar and spelling mistakes in README (#1062)

parent 1fe0a40c
...@@ -10,7 +10,7 @@ the audio domain. By supporting PyTorch, torchaudio follows the same philosophy ...@@ -10,7 +10,7 @@ the audio domain. By supporting PyTorch, torchaudio follows the same philosophy
of providing strong GPU acceleration, having a focus on trainable features through of providing strong GPU acceleration, having a focus on trainable features through
the autograd system, and having consistent style (tensor names and dimension names). the autograd system, and having consistent style (tensor names and dimension names).
Therefore, it is primarily a machine learning library and not a general signal Therefore, it is primarily a machine learning library and not a general signal
processing library. The benefits of PyTorch is be seen in torchaudio through processing library. The benefits of PyTorch can be seen in torchaudio through
having all the computations be through PyTorch operations which makes it easy having all the computations be through PyTorch operations which makes it easy
to use and feel like a natural extension. to use and feel like a natural extension.
...@@ -32,7 +32,7 @@ Dependencies ...@@ -32,7 +32,7 @@ Dependencies
* libsox v14.3.2 or above (only required when building from source) * libsox v14.3.2 or above (only required when building from source)
* [optional] vesis84/kaldi-io-for-python commit cb46cb1f44318a5d04d4941cf39084c5b021241e or above * [optional] vesis84/kaldi-io-for-python commit cb46cb1f44318a5d04d4941cf39084c5b021241e or above
The following is the corresponding ``torchaudio`` versions and supported Python versions. The following are the corresponding ``torchaudio`` versions and supported Python versions.
| ``torch`` | ``torchaudio`` | ``python`` | | ``torch`` | ``torchaudio`` | ``python`` |
| ------------------------ | ------------------------ | ------------------------------- | | ------------------------ | ------------------------ | ------------------------------- |
...@@ -46,7 +46,7 @@ The following is the corresponding ``torchaudio`` versions and supported Python ...@@ -46,7 +46,7 @@ The following is the corresponding ``torchaudio`` versions and supported Python
Installation Installation
------------ ------------
### Binary Distibutions ### Binary Distributions
To install the latest version using anaconda, run: To install the latest version using anaconda, run:
...@@ -127,7 +127,7 @@ BUILD_SOX=1 MACOSX_DEPLOYMENT_TARGET=10.9 CC=clang CXX=clang++ python setup.py i ...@@ -127,7 +127,7 @@ BUILD_SOX=1 MACOSX_DEPLOYMENT_TARGET=10.9 CC=clang CXX=clang++ python setup.py i
``` ```
This is known to work on linux and unix distributions such as Ubuntu and CentOS 7 and macOS. This is known to work on linux and unix distributions such as Ubuntu and CentOS 7 and macOS.
If you try this on a new system and found a solution to make it work, feel free to share it by opening and issue. If you try this on a new system and find a solution to make it work, feel free to share it by opening an issue.
#### Troubleshooting #### Troubleshooting
...@@ -195,16 +195,16 @@ Conventions ...@@ -195,16 +195,16 @@ Conventions
With torchaudio being a machine learning library and built on top of PyTorch, With torchaudio being a machine learning library and built on top of PyTorch,
torchaudio is standardized around the following naming conventions. Tensors are torchaudio is standardized around the following naming conventions. Tensors are
assumed to have channel as the first dimension and time as the last assumed to have channels as the first dimension and time as the last
dimension (when applicable). This makes it consistent with PyTorch's dimensions. dimension (when applicable). This makes it consistent with PyTorch's dimensions.
For size names, the prefix `n_` is used (e.g. "a tensor of size (`n_freq`, `n_mel`)") For size names, the prefix `n_` is used (e.g. "a tensor of size (`n_freq`, `n_mel`)")
whereas dimension names do not have this prefix (e.g. "a tensor of whereas dimension names do not have this prefix (e.g. "a tensor of
dimension (channel, time)") dimension (channels, time)")
* `waveform`: a tensor of audio samples with dimensions (channel, time) * `waveform`: a tensor of audio samples with dimensions (channels, time)
* `sample_rate`: the rate of audio dimensions (samples per second) * `sample_rate`: the rate of audio dimensions (samples per second)
* `specgram`: a tensor of spectrogram with dimensions (channel, freq, time) * `specgram`: a tensor of spectrogram with dimensions (channels, freq, time)
* `mel_specgram`: a mel spectrogram with dimensions (channel, mel, time) * `mel_specgram`: a mel spectrogram with dimensions (channels, mel, time)
* `hop_length`: the number of samples between the starts of consecutive frames * `hop_length`: the number of samples between the starts of consecutive frames
* `n_fft`: the number of Fourier bins * `n_fft`: the number of Fourier bins
* `n_mel`, `n_mfcc`: the number of mel and MFCC bins * `n_mel`, `n_mfcc`: the number of mel and MFCC bins
...@@ -216,16 +216,16 @@ dimension (channel, time)") ...@@ -216,16 +216,16 @@ dimension (channel, time)")
Transforms expect and return the following dimensions. Transforms expect and return the following dimensions.
* `Spectrogram`: (channel, time) -> (channel, freq, time) * `Spectrogram`: (channels, time) -> (channels, freq, time)
* `AmplitudeToDB`: (channel, freq, time) -> (channel, freq, time) * `AmplitudeToDB`: (channels, freq, time) -> (channels, freq, time)
* `MelScale`: (channel, freq, time) -> (channel, mel, time) * `MelScale`: (channels, freq, time) -> (channels, mel, time)
* `MelSpectrogram`: (channel, time) -> (channel, mel, time) * `MelSpectrogram`: (channels, time) -> (channels, mel, time)
* `MFCC`: (channel, time) -> (channel, mfcc, time) * `MFCC`: (channels, time) -> (channel, mfcc, time)
* `MuLawEncode`: (channel, time) -> (channel, time) * `MuLawEncode`: (channels, time) -> (channels, time)
* `MuLawDecode`: (channel, time) -> (channel, time) * `MuLawDecode`: (channels, time) -> (channels, time)
* `Resample`: (channel, time) -> (channel, time) * `Resample`: (channels, time) -> (channels, time)
* `Fade`: (channel, time) -> (channel, time) * `Fade`: (channels, time) -> (channels, time)
* `Vol`: (channel, time) -> (channel, time) * `Vol`: (channels, time) -> (channels, time)
Complex numbers are supported via tensors of dimension (..., 2), and torchaudio provides `complex_norm` and `angle` to convert such a tensor into its magnitude and phase. Here, and in the documentation, we use an ellipsis "..." as a placeholder for the rest of the dimensions of a tensor, e.g. optional batching and channel dimensions. Complex numbers are supported via tensors of dimension (..., 2), and torchaudio provides `complex_norm` and `angle` to convert such a tensor into its magnitude and phase. Here, and in the documentation, we use an ellipsis "..." as a placeholder for the rest of the dimensions of a tensor, e.g. optional batching and channel dimensions.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment