Skip to content

Commit 2ec3053

Browse files
committedMar 27, 2017
Documentation changes relating to PyPI release.
1 parent 214aedf commit 2ec3053

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed
 

‎README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@
44

55
Image augmentation library in Python for machine learning. A Julia version of the package is also being developed as a sister project and is available [here](https://github.com/Evizero/Augmentor.jl).
66

7-
## Documentation
8-
9-
Complete documentation can be found on Read the Docs: <http://augmentor.readthedocs.io/>
10-
117
## Installation
128

139
Install using `pip` from the command line:
@@ -18,6 +14,10 @@ pip install Augmentor
1814

1915
See the documentation for building from source.
2016

17+
## Documentation
18+
19+
Complete documentation can be found on Read the Docs: <http://augmentor.readthedocs.io/>
20+
2121
## Quick Start Guide and Usage
2222
The purpose of _Augmentor_ is to automate image augmentation (artificial data generation) in order to expand datasets as input for machine learning algorithms, especially neural networks and deep learning.
2323

@@ -112,4 +112,6 @@ Out[3]: ('ISIC_0000000.jpg', <httplib.HTTPMessage instance at 0x7f7bd949a950>)
112112

113113
## Asciicast
114114

115+
Click the preview below to view a video demonstration of Augmentor in use:
116+
115117
[![asciicast](https://asciinema.org/a/105368.png)](https://asciinema.org/a/105368?autoplay=1)

‎docs/userguide/install.rst

+4
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,7 @@ Then enter the ``Augmentor`` directory and build the package:
3535
python setup.py install
3636
3737
Alternatively you can first run ``python setup.py build`` followed by ``python setup.py install``. This can be useful for debugging.
38+
39+
.. attention::
40+
41+
If you are compiling from source you may need to compile the dependencies also, including Pillow. On Linux this means having libpng (``libpng-dev``) and zlib (``zlib1g-dev``) installed.

‎setup.cfg

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
[bdist_wheel]
2-
universal=1
2+
universal=1
3+
4+
[metadata]
5+
license_file = LICENSE.md

0 commit comments

Comments
 (0)