Skip to content

Commit

Permalink
Added section on how to contribute a new transform (albumentations-te…
Browse files Browse the repository at this point in the history
…am#238)

* Added section on how to contribute a new transform

* Update README.md
  • Loading branch information
vfdev-5 authored and ternaus committed Mar 11, 2019
1 parent b21431c commit f818cb6
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,21 @@ Python and library versions: Python 3.6.8 | Anaconda, numpy 1.16.2, pillow 5.4.1
flake8
```

### Adding new transforms

If you are contributing a new transformation, make sure to update
["Pixel-level transforms"](#pixel-level-transforms) or/and ["Spatial-level transforms"](#spatial-level-transforms) sections
of this file (`README.md`). To do this, simply run (with python3 only):
```
python3 tools/make_transforms_docs.py make
```
and copy/paste the results in the corresponding sections. To validate your modifications, you
can run:
```
python3 tools/make_transforms_docs.py check README.md
```


## Building the documentation
1. Go to `docs/` directory
```
Expand Down

0 comments on commit f818cb6

Please sign in to comment.