Skip to content

Commit

Permalink
Add colab badges (#64)
Browse files Browse the repository at this point in the history
* 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 <zoep@devfair0307.h2.fair>
Co-authored-by: Zoe Papakipos <zoep@fb.com>
  • Loading branch information
3 people authored Jun 25, 2021
1 parent 5a4fe38 commit f79e583
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 13 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
<a href="https://pypi.python.org/pypi/augly">
<img alt="PyPI Version" src="https://img.shields.io/pypi/v/augly"/>
</a>
<a href="https://colab.research.google.com/github/facebookresearch/AugLy/blob/main/examples/AugLy_image.ipynb">
<img alt="Image Colab notebook" src="https://colab.research.google.com/assets/colab-badge.svg"/>
</a>
<a href="https://doi.org/10.5281/zenodo.5014032">
<img alt="DOI" src="https://zenodo.org/badge/DOI/10.5281/zenodo.5014032.svg">
</a>
Expand Down
5 changes: 2 additions & 3 deletions augly/audio/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# Audio

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

Try running some AugLy audio augmentations in [Colab](https://colab.research.google.com/github/facebookresearch/AugLy/blob/main/examples/AugLy_audio.ipynb)!

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

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.

Expand Down
5 changes: 2 additions & 3 deletions augly/image/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# Image

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

Try running some AugLy image augmentations in [Colab](https://colab.research.google.com/github/facebookresearch/AugLy/blob/main/examples/AugLy_image.ipynb)!

For a full list of available augmentations, see [here](__init__.py).
Try running some AugLy image augmentations! For a full list of available augmentations, see [here](__init__.py).

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.

Expand Down
4 changes: 2 additions & 2 deletions augly/text/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## Augmentations

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

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

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.

Expand Down
7 changes: 2 additions & 5 deletions augly/video/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

## Installation Notes

Try running some AugLy video augmentations in [Colab](https://colab.research.google.com/github/facebookresearch/AugLy/blob/main/examples/AugLy_video.ipynb)!

For a full list of available augmentations, see [here](__init__.py).

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:
```bash
conda install -c conda-forge ffmpeg
Expand All @@ -26,8 +22,9 @@ export AUGLY_FFPROBE_PATH='<ffprobe_path>'
```

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

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

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.

Expand Down

0 comments on commit f79e583

Please sign in to comment.