Merge pull request #342 from iver56/ij/docs

Add links to sources

docs/waveform_transforms/add_background_noise.md

@@ -124,3 +124,7 @@ Here we add some music to a speech recording, targeting a signal-to-noise ratio
 
 [`lru_cache_size`](#lru_cache_size){ #lru_cache_size }: `int`
 :   :octicons-milestone-24: Default: `2`. Maximum size of the LRU cache for storing noise files in memory
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/add_background_noise.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/add_background_noise.py){target=_blank}

docs/waveform_transforms/add_color_noise.md

@@ -45,3 +45,6 @@ See [Colors of noise :octicons-link-external-16:](https://en.wikipedia.org/wiki/
 [`n_fft`](#n_fft){ #n_fft }: `int`
 :   :octicons-milestone-24: Default: `128`. The number of points the decay curve is computed (for coloring white noise).
 
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/add_color_noise.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/add_color_noise.py){target=_blank}

docs/waveform_transforms/add_gaussian_noise.md

@@ -39,3 +39,7 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=16000)
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/add_gaussian_noise.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/add_gaussian_noise.py){target=_blank}

docs/waveform_transforms/add_gaussian_snr.md

@@ -65,3 +65,7 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=16000)
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/add_gaussian_snr.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/add_gaussian_snr.py){target=_blank}

docs/waveform_transforms/add_short_noises.md

@@ -181,3 +181,7 @@ Here we add some short noise sounds to a voice recording.
 [`lru_cache_size`](#lru_cache_size){ #lru_cache_size }: `int`
 :   :octicons-milestone-24: Default: `64`. Maximum size of the LRU cache for storing
     noise files in memory
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/add_short_noises.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/add_short_noises.py){target=_blank}

docs/waveform_transforms/adjust_duration.md

@@ -62,3 +62,7 @@ Here we input an audio clip and remove a part of the start and the end, so the l
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/adjust_duration.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/adjust_duration.py){target=_blank}

docs/waveform_transforms/air_absorption.md

@@ -72,3 +72,7 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=48000)
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/air_absorption.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/air_absorption.py){target=_blank}

docs/waveform_transforms/aliasing.md

@@ -48,3 +48,7 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=44100)
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/aliasing.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/aliasing.py){target=_blank}

docs/waveform_transforms/apply_impulse_response.md

@@ -82,3 +82,7 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=48000)
 :   :octicons-milestone-24: Default: `True`. When set to `True`, the tail of the sound
     (e.g. reverb at the end) will be chopped off so that the length of the output is
     equal to the length of the input.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/apply_impulse_response.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/apply_impulse_response.py){target=_blank}

docs/waveform_transforms/band_pass_filter.md

@@ -64,3 +64,7 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=48000)
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/band_pass_filter.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/band_pass_filter.py){target=_blank}

docs/waveform_transforms/band_stop_filter.md

@@ -59,3 +59,7 @@ can hear that the timbre is different in the transformed sound than in the origi
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/band_stop_filter.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/band_stop_filter.py){target=_blank}

docs/waveform_transforms/bit_crush.md

@@ -42,3 +42,7 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=16000)
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/bit_crush.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/bit_crush.py){target=_blank}

docs/waveform_transforms/clip.md

@@ -26,3 +26,7 @@ sometimes be useful at the end of a data augmentation pipeline.
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/clip.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/clip.py){target=_blank}

docs/waveform_transforms/clipping_distortion.md

@@ -20,3 +20,7 @@ the two input parameters `min_percentile_threshold` and `max_percentile_threshol
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/clipping_distortion.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/clipping_distortion.py){target=_blank}

docs/waveform_transforms/gain.md

@@ -25,3 +25,7 @@ See also [https://en.wikipedia.org/wiki/Clipping_(audio)#Digital_clipping](https
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/gain.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/gain.py){target=_blank}

docs/waveform_transforms/gain_transition.md

@@ -43,3 +43,7 @@ end of the sound.
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/gain_transition.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/gain_transition.py){target=_blank}

docs/waveform_transforms/high_pass_filter.md

@@ -31,3 +31,7 @@ Can also be set for zero-phase filtering (will result in a 6 dB drop at cutoff).
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/high_pass_filter.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/high_pass_filter.py){target=_blank}

docs/waveform_transforms/high_shelf_filter.md

@@ -32,3 +32,7 @@ Filter coefficients are taken from [the W3 Audio EQ Cookbook :octicons-link-exte
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/high_shelf_filter.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/high_shelf_filter.py){target=_blank}

docs/waveform_transforms/lambda.md

@@ -38,3 +38,7 @@ augmented_sound = transform(my_stereo_waveform_ndarray, sample_rate=16000)
 
 [`**kwargs`](#**kwargs){ #**kwargs }
 :   :octicons-milestone-24: Optional extra parameters passed to the callable transform
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/lambda_transform.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/lambda_transform.py){target=_blank}

docs/waveform_transforms/limiter.md

@@ -82,3 +82,7 @@ In this example we apply the limiter with a threshold that is 10 dB lower than t
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/limiter.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/limiter.py){target=_blank}

docs/waveform_transforms/loudness_normalization.md

@@ -32,3 +32,7 @@ See also [https://en.wikipedia.org/wiki/Clipping_(audio)#Digital_clipping :octic
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/loudness_normalization.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/loudness_normalization.py){target=_blank}

docs/waveform_transforms/low_pass_filter.md

@@ -31,3 +31,7 @@ Can also be set for zero-phase filtering (will result in a 6 dB drop at cutoff).
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/low_pass_filter.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/low_pass_filter.py){target=_blank}

docs/waveform_transforms/low_shelf_filter.md

@@ -32,3 +32,7 @@ Filter coefficients are taken from [the W3 Audio EQ Cookbook :octicons-link-exte
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/low_shelf_filter.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/low_shelf_filter.py){target=_blank}

docs/waveform_transforms/mp3_compression.md

@@ -33,3 +33,7 @@ Warning: This transform writes to disk, so it may be slow.
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/mp3_compression.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/mp3_compression.py){target=_blank}

docs/waveform_transforms/normalize.md

@@ -10,3 +10,7 @@ Also known as peak normalization.
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/normalize.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/normalize.py){target=_blank}

docs/waveform_transforms/padding.md

@@ -22,3 +22,7 @@ with constant input length for padded inputs.
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/padding.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/padding.py){target=_blank}

docs/waveform_transforms/peaking_filter.md

@@ -28,3 +28,7 @@ Add a biquad peaking filter transform
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/peaking_filter.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/peaking_filter.py){target=_blank}

docs/waveform_transforms/pitch_shift.md

@@ -50,3 +50,7 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=44100)
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/pitch_shift.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/pitch_shift.py){target=_blank}

docs/waveform_transforms/polarity_inversion.md

@@ -14,3 +14,7 @@ training phase-aware machine learning models.
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/polarity_inversion.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/polarity_inversion.py){target=_blank}

docs/waveform_transforms/post_gain.md

@@ -26,3 +26,7 @@ by a (set of) transform(s), or for preventing clipping in the output.
     * `"peak_normalize_if_too_loud"`: The sound gets peak normalized if it is too
         loud (max absolute value greater than 1.0). This option can be useful for
         avoiding clipping.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/core/post_gain.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/core/post_gain.py){target=_blank}

docs/waveform_transforms/repeat_part.md

@@ -105,3 +105,7 @@ In this speech example, the audio was transformed with
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/repeat_part.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/repeat_part.py){target=_blank}

docs/waveform_transforms/resample.md

@@ -17,3 +17,7 @@ sampling rate and vice versa to do upsampling only.
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/resample.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/resample.py){target=_blank}

docs/waveform_transforms/reverse.md

@@ -32,3 +32,8 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=44100)
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/reverse.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/reverse.py){target=_blank}

docs/waveform_transforms/room_simulator.md

@@ -152,3 +152,7 @@ characteristics or simply to quickly add reverb for augmentation purposes
 [`ray_tracing_options`](#ray_tracing_options){ #ray_tracing_options }: `Optional[Dict]`
 :   :octicons-milestone-24: Default: `None`. Options for the ray tracer. See `set_ray_tracing` here:  
     [https://github.com/LCAV/pyroomacoustics/blob/master/pyroomacoustics/room.py](https://github.com/LCAV/pyroomacoustics/blob/master/pyroomacoustics/room.py)
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/room_simulator.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/room_simulator.py){target=_blank}

docs/waveform_transforms/seven_band_parametric_eq.md

@@ -38,3 +38,7 @@ The seven bands have center frequencies picked in the following ranges (min-max)
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/seven_band_parametric_eq.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/seven_band_parametric_eq.py){target=_blank}

docs/waveform_transforms/shift.md

@@ -73,3 +73,7 @@ version, you can check the ["Old Shift API (<=v0.32.0)" section](#old-shift-api-
 
 `p`: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/shift.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/shift.py){target=_blank}

docs/waveform_transforms/tanh_distortion.md

@@ -46,3 +46,7 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=16000)
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/tanh_distortion.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/tanh_distortion.py){target=_blank}

docs/waveform_transforms/time_mask.md

@@ -49,3 +49,7 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=16000)
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/time_mask.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/time_mask.py){target=_blank}

docs/waveform_transforms/time_stretch.md

@@ -56,3 +56,7 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=16000)
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/time_stretch.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/time_stretch.py){target=_blank}

docs/waveform_transforms/trim.md

@@ -35,3 +35,7 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=16000)
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.5`. The probability of applying this transform.
+
+## Source code :octicons-mark-github-16:
+
+[audiomentations/augmentations/trim.py :octicons-link-external-16:](https://github.com/iver56/audiomentations/blob/main/audiomentations/augmentations/trim.py){target=_blank}

mkdocs.yml

@@ -55,6 +55,8 @@ theme:
   name: material
   features:
     - navigation.expand
+  icon:
+    repo: fontawesome/brands/github
 repo_name: 'iver56/audiomentations'
 repo_url: 'https://github.com/iver56/audiomentations'
 edit_uri: edit/main/docs/