Release v1.0.0

devbruce · Jan 1, 2020 · 37db514 · 37db514
1 parent f6b6d2c
commit 37db514
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 4 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,4 @@
+include MANIFEST.in
+include README.md
+include LICENSE
+include requirements.txt
diff --git a/README.md b/README.md
@@ -1,12 +1,21 @@
 # CutMixImageDataGenerator (Keras)
 
-![Python-v3.7.3](https://img.shields.io/badge/Python-v3.7.3-blue)
-![Keras-v2.2.4](https://img.shields.io/badge/Keras-v2.2.4-brightgreen)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/DevBruce/CutMixImageDataGenerator_For_Keras)
 
-**Version 0.1 (Beta)**  
+> Paper: [CutMix: Regularization Strategy to Train Strong Classifiers with Localizable Features](https://arxiv.org/abs/1905.04899)
 
 <br>
 
+## Install
+
+```bash
+$ pip install cutmix-keras
+```
+
+<br>
+
+## How To Use
+
 ```python
 class CutMixImageDataGenerator():
     def __init__(self, generator1, generator2, img_size, batch_size):
@@ -33,9 +42,13 @@ So there would no augmentation
 
 <br>
 
-## Using Example
+### Using Example
 
 ```python
+# (some codes) ...
+from cutmix_keras import CutMixImageDataGenerator  # Import CutMix
+
+
 train_datagen = ImageDataGenerator(
     rescale=1./255,
 )

diff --git a/CutMixImageDataGenerator.py → cutmix_keras.py b/CutMixImageDataGenerator.py → cutmix_keras.py
diff --git a/requirements.txt b/requirements.txt
diff --git a/setup.py b/setup.py
@@ -0,0 +1,21 @@
+from setuptools import setup
+import os
+
+
+ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
+README_PATH = os.path.join(ROOT_DIR, 'README.md')
+
+setup(
+    name='cutmix-keras',
+    author='devbruce',
+    author_email='[email protected]',
+    description='CutMuxImageDataGenerator For Keras',
+    long_description=open(README_PATH, encoding='utf-8').read(),
+    long_description_content_type='text/markdown',
+    license='MIT',
+    version='1.0.0',
+    url='https://github.com/DevBruce/CutMixImageDataGenerator_For_Keras',
+    py_modules=['cutmix_keras'],
+    keywords=['cutmix', 'keras'],
+    # install_requires=['keras'],
+)