hl_cnn.h 17.8 KB
Newer Older
1
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserved.
Z
zhangjinchao01 已提交
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. */

#ifndef HL_CNN_H_
#define HL_CNN_H_

#include "hl_base.h"

/**
X
xzl 已提交
21
 * @brief   Maximum pool forward with Mask output.
Z
zhangjinchao01 已提交
22 23 24 25 26 27 28 29
 *
 * @param[in]   frameCnt    batch size of input image.
 * @param[in]   inputData   input data.
 * @param[in]   channels    number of channel.
 * @param[in]   height      image height.
 * @param[in]   width       image width.
 * @param[in]   pooledH     output image height.
 * @param[in]   pooledW     output image width.
30 31 32 33 34 35
 * @param[in]   sizeX       width of pooling window.
 * @param[in]   sizeY       height of pooling window.
 * @param[in]   strideH     pooling stride height.
 * @param[in]   strideW     pooling stride width.
 * @param[in]   paddingH    padding height.
 * @param[in]   paddingW    padding width.
Z
zhangjinchao01 已提交
36
 * @param[out]  tgtData     output data.
Q
qijun 已提交
37
 * @param[in]   tgtStride   stride between output data samples.
38
 * @param[out]  maskData    the location indices of select max data.
X
xzl 已提交
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
 */
extern void hl_maxpool_forward(const int frameCnt,
                               const real* inputData,
                               const int channels,
                               const int height,
                               const int width,
                               const int pooledH,
                               const int pooledW,
                               const int sizeX,
                               const int sizeY,
                               const int strideH,
                               const int strideW,
                               const int paddingH,
                               const int paddingW,
                               real* tgtData,
                               const int tgtStride,
55
                               real* maskData = NULL);
Z
zhangjinchao01 已提交
56 57 58 59 60 61 62 63 64 65 66 67 68

/**
 * @brief   Maximum pool backward.
 *
 * @param[in]   frameCnt    batch size of input image.
 * @param[in]   inputData   input data.
 * @param[out]  outData     output data.
 * @param[out]  outGrad     output grad data.
 * @param[in]   channels    number of channel.
 * @param[in]   height      image height.
 * @param[in]   width       image width.
 * @param[in]   pooledH     output image height.
 * @param[in]   pooledW     output image width.
69 70 71 72
 * @param[in]   sizeX       width of pooling window.
 * @param[in]   sizeY       height of pooling window.
 * @param[in]   strideH     pooling stride height.
 * @param[in]   strideW     pooling stride width.
Z
zhangjinchao01 已提交
73 74
 * @param[in]   scaleA      scale.
 * @param[in]   scaleB      scale.
75 76 77
 * @param[in]   paddingH    padding height.
 * @param[in]   paddingW    padding width.
 * @param[out]  targetGrad  output grad.
78
 * @param[in]   outStride   stride between output data samples.
Z
zhangjinchao01 已提交
79 80
 *
 */
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
extern void hl_maxpool_backward(const int frameCnt,
                                const real* inputData,
                                const real* outData,
                                const real* outGrad,
                                const int channels,
                                const int height,
                                const int width,
                                const int pooledH,
                                const int pooledW,
                                const int sizeX,
                                const int sizeY,
                                const int strideH,
                                const int strideW,
                                const int paddingH,
                                const int paddingW,
                                real scaleA,
                                real scaleB,
                                real* targetGrad,
                                const int outStride);
Z
zhangjinchao01 已提交
100 101 102 103 104 105 106 107 108 109 110

/**
 * @brief   Averge pool forward.
 *
 * @param[in]   frameCnt    batch size of input image.
 * @param[in]   inputData   input data.
 * @param[in]   channels    number of channel.
 * @param[in]   height      image height.
 * @param[in]   width       image width.
 * @param[in]   pooledH     output image height.
 * @param[in]   pooledW     output image width.
111 112 113 114 115 116
 * @param[in]   sizeX       width of pooling window.
 * @param[in]   sizeY       height of pooling window.
 * @param[in]   strideH     pooling stride height.
 * @param[in]   strideW     pooling stride width.
 * @param[in]   paddingH    padding height.
 * @param[in]   paddingW    padding width.
Z
zhangjinchao01 已提交
117
 * @param[out]  tgtData     output data.
Q
qijun 已提交
118
 * @param[in]   tgtStride   stride between output data samples.
119
 * @param[in]   excludeMode whether to consider paddings for size.
Z
zhangjinchao01 已提交
120 121
 *
 */
122 123 124 125 126 127 128 129 130 131 132 133 134 135
extern void hl_avgpool_forward(const int frameCnt,
                               const real* inputData,
                               const int channels,
                               const int height,
                               const int width,
                               const int pooledH,
                               const int pooledW,
                               const int sizeX,
                               const int sizeY,
                               const int strideH,
                               const int strideW,
                               const int paddingH,
                               const int paddingW,
                               real* tgtData,
136 137
                               const int tgtStride,
                               bool excludeMode);
Z
zhangjinchao01 已提交
138 139 140 141 142

/**
 * @brief   Maximum pool backward.
 *
 * @param[in]   frameCnt    batch size of input image.
143
 * @param[in]   outGrad     output grad data.
Z
zhangjinchao01 已提交
144 145 146 147 148
 * @param[in]   channels    number of channel.
 * @param[in]   height      image height.
 * @param[in]   width       image width.
 * @param[in]   pooledH     output image height.
 * @param[in]   pooledW     output image width.
149 150 151 152 153 154
 * @param[in]   sizeX       width of pooling window.
 * @param[in]   sizeY       height of pooling window.
 * @param[in]   strideH     pooling stride height.
 * @param[in]   strideW     pooling stride width.
 * @param[in]   paddingH    padding height.
 * @param[in]   paddingW    padding width.
Z
zhangjinchao01 已提交
155 156
 * @param[in]   scaleA      scale.
 * @param[in]   scaleB      scale.
157
 * @param[out]  backGrad    output grad.
158
 * @param[in]   outStride   stride between output data samples.
159
 * @param[in]   excludeMode whether to consider paddings for size.
Z
zhangjinchao01 已提交
160 161
 *
 */
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
extern void hl_avgpool_backward(const int frameCnt,
                                const real* outGrad,
                                const int channels,
                                const int height,
                                const int width,
                                const int pooledH,
                                const int pooledW,
                                const int sizeX,
                                const int sizeY,
                                const int strideH,
                                const int strideW,
                                int paddingH,
                                int paddingW,
                                real scaleA,
                                real scaleB,
                                real* backGrad,
178 179
                                const int outStride,
                                bool excludeMode);
Z
zhangjinchao01 已提交
180

C
chengduoZH 已提交
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
extern void hl_maxpool3D_forward(const int frameCnt,
                                 const real* inputData,
                                 const int channels,
                                 const int depth,
                                 const int height,
                                 const int width,
                                 const int pooledD,
                                 const int pooledH,
                                 const int pooledW,
                                 const int sizeZ,
                                 const int sizeY,
                                 const int sizeX,
                                 const int strideD,
                                 const int strideH,
                                 const int strideW,
                                 const int paddingD,
                                 const int paddingH,
                                 const int paddingW,
                                 real* tgtData,
C
chengduoZH 已提交
200
                                 real* maxPoolIdxData,
C
chengduoZH 已提交
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
                                 const int tgtStride);

extern void hl_maxpool3D_backward(const int frameCnt,
                                  const real* outGrad,
                                  const int channels,
                                  const int depth,
                                  const int height,
                                  const int width,
                                  const int pooledD,
                                  const int pooledH,
                                  const int pooledW,
                                  const int sizeZ,
                                  const int sizeY,
                                  const int sizeX,
                                  const int strideD,
                                  const int strideH,
                                  const int strideW,
                                  const int paddingD,
                                  const int paddingH,
                                  const int paddingW,
                                  real scaleA,
                                  real scaleB,
                                  real* targetGrad,
C
chengduoZH 已提交
224
                                  real* maxPoolIdxData,
C
chengduoZH 已提交
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
                                  const int outStride);

extern void hl_avgpool3D_forward(const int frameCnt,
                                 const real* inputData,
                                 const int channels,
                                 const int depth,
                                 const int height,
                                 const int width,
                                 const int pooledD,
                                 const int pooledH,
                                 const int pooledW,
                                 const int sizeZ,
                                 const int sizeY,
                                 const int sizeX,
                                 const int strideD,
                                 const int strideH,
                                 const int strideW,
                                 const int paddingD,
                                 const int paddingH,
                                 const int paddingW,
                                 real* tgtData,
                                 const int tgtStride);

extern void hl_avgpool3D_backward(const int frameCnt,
                                  const real* outGrad,
                                  const int channels,
                                  const int depth,
                                  const int height,
                                  const int width,
                                  const int pooledD,
                                  const int pooledH,
                                  const int pooledW,
                                  const int sizeZ,
                                  const int sizeY,
                                  const int sizeX,
                                  const int strideD,
                                  const int strideH,
                                  const int strideW,
                                  int paddingD,
                                  int paddingH,
                                  int paddingW,
                                  real scaleA,
                                  real scaleB,
                                  real* backGrad,
                                  const int outStride);

L
liaogang 已提交
271 272 273 274 275 276 277 278 279 280 281 282 283 284
/**
 * @brief   Bilinear interpolation forward.
 *
 * @param[in]   inData      input value.
 * @param[in]   inImgH      input image height.
 * @param[in]   inImgW      input image width.
 * @param[in]   inputH      input batchSize.
 * @param[in]   inputW      input image data dim.
 * @param[out]  outData     output value.
 * @param[in]   outImgH     output image height.
 * @param[in]   outImgW     output image width.
 * @param[in]   outputH     output batchSize.
 * @param[in]   outputW     output image data dim.
 * @param[in]   numChannels number of channels.
L
liaogang 已提交
285 286
 * @param[in]   ratioH      inImgH / outImgH.
 * @param[in]   ratioW      inImgW / outImgW.
L
liaogang 已提交
287 288 289 290 291 292 293 294 295 296 297 298
 *
 */
extern void hl_bilinear_forward(const real* inData,
                                const size_t inImgH,
                                const size_t inImgW,
                                const size_t inputH,
                                const size_t inputW,
                                real* outData,
                                const size_t outImgH,
                                const size_t outImgW,
                                const size_t outputH,
                                const size_t outputW,
L
liaogang 已提交
299 300 301
                                const size_t numChannels,
                                const real ratioH,
                                const real ratioW);
L
liaogang 已提交
302

303
/**
L
liaogang 已提交
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
 * @brief   Bilinear interpolation backward.
 *
 * @param[out]  inGrad      input gradient.
 * @param[in]   inImgH      input image height.
 * @param[in]   inImgW      input image width.
 * @param[in]   inputH      input batchSize.
 * @param[in]   inputW      input image data dim.
 * @param[in]   outGrad     output gradient.
 * @param[in]   outImgH     output image height.
 * @param[in]   outImgW     output image width.
 * @param[in]   outputH     output batchSize.
 * @param[in]   outputW     output image data dim.
 * @param[in]   numChannels number of channels.
 * @param[in]   ratioH      inImgH / outImgH.
 * @param[in]   ratioW      inImgW / outImgW.
 *
 */
L
liaogang 已提交
321 322 323 324 325 326 327 328 329 330
extern void hl_bilinear_backward(real* inGrad,
                                 const size_t inImgH,
                                 const size_t inImgW,
                                 const size_t inputH,
                                 const size_t inputW,
                                 const real* outGrad,
                                 const size_t outImgH,
                                 const size_t outImgW,
                                 const size_t outputH,
                                 const size_t outputW,
L
liaogang 已提交
331 332 333
                                 const size_t numChannels,
                                 const real ratioH,
                                 const real ratioW);
L
liaogang 已提交
334

335 336 337 338 339 340 341 342 343 344 345
/**
 * @brief   MaxOut forward.
 *
 * @param[in]   inData      input data.
 * @param[out]  outData     output data.
 * @param[out]  idData      output maxId.
 * @param[in]   batchSize   batchSize.
 * @param[in]   size        number of channels * image height * image width.
 * @param[in]   featLen     feature length = image height * image width.
 * @param[in]   groups      number of groups.
 */
346 347 348 349 350 351 352
extern void hl_maxout_forward(const real* inData,
                              real* outData,
                              int* idData,
                              size_t batchSize,
                              size_t size,
                              size_t featLen,
                              size_t groups);
353 354 355 356 357 358 359 360 361 362 363 364

/**
 * @brief   MaxOut backward.
 *
 * @param[out]  inGrad      input grad data.
 * @param[in]   outGrad     output grad data.
 * @param[in]   idData      output maxId.
 * @param[in]   batchSize   batchSize.
 * @param[in]   size        number of channels * image height * image width.
 * @param[in]   featLen     feature length = image height * image width.
 * @param[in]   groups      number of groups.
 */
365 366 367 368 369 370 371
extern void hl_maxout_backward(real* inGrad,
                               const real* outGrad,
                               const int* idData,
                               size_t batchSize,
                               size_t size,
                               size_t featLen,
                               size_t groups);
372

X
xzl 已提交
373 374 375 376 377 378 379 380 381 382 383 384
/**
 * @brief   Upsample forward.
 * @param[in]   inputData   input data.
 * @param[out]  maskData    the mask data from MaxPoolWithMaskLayer.
 * @param[out]  batchSize   the batch size of the input.
 * @param[in]   imgSizeH    image height.
 * @param[in]   imgSizeW    image width.
 * @param[in]   channels    the input channels.
 * @param[in]   outputH     the output height.
 * @param[in]   outputW     the output widht.
 * @param[out]  outputData  output data.
 */
X
xzl 已提交
385 386 387 388 389 390 391 392 393
extern void hl_upsample_forward(real* inputData,
                                real* maskData,
                                size_t batchSize,
                                size_t imgSizeH,
                                size_t imgSizeW,
                                size_t channels,
                                size_t outputH,
                                size_t outputW,
                                real* outputData);
X
xzl 已提交
394 395 396 397 398 399 400 401 402 403 404 405 406

/**
 * @brief   Upsample backward.
 * @param[in]   outputGradData  the output grad data.
 * @param[out]  maskData    the mask data from MaxPoolWithMaskLayer.
 * @param[out]  batchSize       the batch size of the input.
 * @param[in]   imgSizeH        image height.
 * @param[in]   imgSizeW        image width.
 * @param[in]   channels        the input channels.
 * @param[in]   outputH         the output height.
 * @param[in]   outputW         the output widht.
 * @param[out]  inputGradData   the input grad data.
 */
X
xzl 已提交
407 408 409 410 411 412 413 414 415
extern void hl_upsample_backward(real* outputGradData,
                                 real* maskData,
                                 size_t batchSize,
                                 size_t imgSizeH,
                                 size_t imgSizeW,
                                 size_t channels,
                                 size_t outputH,
                                 size_t outputW,
                                 real* inputGradData);
X
xzl 已提交
416

C
chengduoZH 已提交
417
#endif  // HL_CNN_H_