Skip to content

Commit f79e583

Browse files
zpapakiposZoe PapakiposZoe Papakipos
authored
Add colab badges (#64)
* Add CI testing Github action * Merge python & reqs steps * Fix python step * Use conda * Fix spaces * Add conda init * Remove making new conda env * Add colab badges to readmes * Update READMEs * Try formatting * Try formatting * Update README.md * Update README.md * Update README.md * Update README.md * Delete ci_testing workflow Co-authored-by: Zoe Papakipos <[email protected]> Co-authored-by: Zoe Papakipos <[email protected]>
1 parent 5a4fe38 commit f79e583

File tree

5 files changed

+11
-13
lines changed

5 files changed

+11
-13
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
<a href="https://pypi.python.org/pypi/augly">
1010
<img alt="PyPI Version" src="https://img.shields.io/pypi/v/augly"/>
1111
</a>
12+
<a href="https://colab.research.google.com/github/facebookresearch/AugLy/blob/main/examples/AugLy_image.ipynb">
13+
<img alt="Image Colab notebook" src="https://colab.research.google.com/assets/colab-badge.svg"/>
14+
</a>
1215
<a href="https://doi.org/10.5281/zenodo.5014032">
1316
<img alt="DOI" src="https://zenodo.org/badge/DOI/10.5281/zenodo.5014032.svg">
1417
</a>

augly/audio/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# Audio
22

33
## Augmentations
4+
[![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/facebookresearch/AugLy/blob/main/examples/AugLy_audio.ipynb)
45

5-
Try running some AugLy audio augmentations in [Colab](https://colab.research.google.com/github/facebookresearch/AugLy/blob/main/examples/AugLy_audio.ipynb)!
6-
7-
For a full list of available augmentations, see [here](__init__.py).
6+
Try running some AugLy audio augmentations in Colab! For a full list of available augmentations, see [here](__init__.py).
87

98
Our audio augmentations use `librosa`, `torchaudio`, and NumPy as their backend. All functions accept an audio path or an audio array to be augmented as input and return the augmented audio array. If an output path is specified, the audio will also be saved to a file.
109

augly/image/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# Image
22

33
## Augmentations
4+
[![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/facebookresearch/AugLy/blob/main/examples/AugLy_image.ipynb)
45

5-
Try running some AugLy image augmentations in [Colab](https://colab.research.google.com/github/facebookresearch/AugLy/blob/main/examples/AugLy_image.ipynb)!
6-
7-
For a full list of available augmentations, see [here](__init__.py).
6+
Try running some AugLy image augmentations! For a full list of available augmentations, see [here](__init__.py).
87

98
Our image augmentations use `PIL` as their backend. All functions accept a path to the image or a PIL Image object to be augmented as input and return the augmented PIL Image object. If an output path is specified, the image will also be saved to a file.
109

augly/text/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Augmentations
44

5-
Try running some AugLy text augmentations in [Colab](https://colab.research.google.com/github/facebookresearch/AugLy/blob/main/examples/AugLy_text.ipynb)!
5+
[![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/facebookresearch/AugLy/blob/main/examples/AugLy_text.ipynb)
66

7-
For a full list of available augmentations, see [here](__init__.py).
7+
Try running some AugLy text augmentations in Colab! For a full list of available augmentations, see [here](__init__.py).
88

99
Our text augmentations use `nlpaug` as their backbone. All functions accept a list of original texts to be augmented as input and return the list of augmented texts.
1010

augly/video/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
## Installation Notes
44

5-
Try running some AugLy video augmentations in [Colab](https://colab.research.google.com/github/facebookresearch/AugLy/blob/main/examples/AugLy_video.ipynb)!
6-
7-
For a full list of available augmentations, see [here](__init__.py).
8-
95
In order to run the video tests and/or use the augmentations, please install `ffmpeg`. If you're using conda you can do this with:
106
```bash
117
conda install -c conda-forge ffmpeg
@@ -26,8 +22,9 @@ export AUGLY_FFPROBE_PATH='<ffprobe_path>'
2622
```
2723

2824
## Augmentations
25+
[![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/facebookresearch/AugLy/blob/main/examples/AugLy_video.ipynb)
2926

30-
For a full list of available augmentations, see [here](__init__.py).
27+
Try running some AugLy video augmentations in Colab! For a full list of available augmentations, see [here](__init__.py).
3128

3229
Our video augmentations use `ffmpeg` & OpenCV as their backend. All functions accept a path to the video to be augmented as input and output a file containing the augmented video. If no output path is specified, the original video input path will be overwritten. The file path to which the augmented video was written will also be returned by all augmentations.
3330

0 commit comments

Comments
 (0)