Skip to content

Commit

Permalink
fix: input image transforms in API doc
Browse files Browse the repository at this point in the history
  • Loading branch information
beniz authored and sileht committed Sep 29, 2020
1 parent 7f0437a commit f513f17
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,10 +180,15 @@ Parameter | Type | Optional | Default | Description
--------- | ---- | -------- | ------- | -----------
width | int | yes | 227 | Resize images to width (`image` only)
height | int | yes | 227 | Resize images to height (`image` only)
bw | bool | yes | false | Treat images as black & white (Caffe only)
mean | float | yes | 128 | mean pixel value to be subtracted to input image (`tensorflow` only)
mean | array of int | yes | N/A | mean pixel value per channel to be subtracted to input image (`caffe` only)
std | float | yes | 128 | standard pixel value deviation to be applied to input image (`tensorflow` only)
bw | bool | yes | false | Treat images as black & white
rgb | bool | yes | false | Use RGB images
histogram_equalization | bool | yes | false | Whether to equalize the image histogram
mean | float | yes | 128 | mean pixel value to be subtracted to input image
mean | array of int | yes | N/A | mean pixel value per channel to be subtracted to input image
std | float | yes | 128 | standard pixel value deviation to be applied to input image
scale | float | yes | 1.0 | whether to scale the size of an image
scale_min | float | yes | 600 | min scaling dim size
scale_max | float | yes | 1000 | max scaling dim size
segmentation | bool | yes | false | whether to setup an image connector for a segmentation task (`caffe` only)
multi_label | bool | yes | false | whether to setup a multi label image task (`caffe` only)
root_folder | string | yes | false | root folder for image data layer (i.e multi label image service for training with `caffe`)
Expand Down Expand Up @@ -561,6 +566,14 @@ Parameter | Type | Optional | Default | Description
width | int | yes | 227 | Resize images to width (`image` only)
height | int | yes | 227 | Resize images to height (`image` only)
bw | bool | yes | false | Treat images as black & white (Caffe only)
rgb | bool | yes | false | Use RGB images
histogram_equalization | bool | yes | false | Whether to equalize the image histogram
mean | float | yes | 128 | mean pixel value to be subtracted to input image
mean | array of int | yes | N/A | mean pixel value per channel to be subtracted to input image
std | float | yes | 128 | standard pixel value deviation to be applied to input image
scale | float | yes | 1.0 | whether to scale the size of an image
scale_min | float | yes | 600 | min scaling dim size
scale_max | float | yes | 1000 | max scaling dim size
test_split | real | yes | 0 | Test split part of the dataset
shuffle | bool | yes | false | Whether to shuffle the training set (prior to splitting)
seed | int | yes | -1 | Shuffling seed for reproducible results (-1 for random seeding)
Expand Down

0 comments on commit f513f17

Please sign in to comment.