Publishing 2019 R1 content
[platform/upstream/dldt.git] / inference-engine / thirdparty / clDNN / kernel_selector / core / actual_kernels / convolution / convolution_kernel_tutorial.h
1 /*
2 // Copyright (c) 2016 Intel Corporation
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 //      http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 */
16
17 #pragma once
18
19 #include "convolution_kernel_base.h"
20
21 // Step 0: 
22 //
23 // 1. choose a tutorial mode
24 // 2. modify convolution_tutorial.cl as well
25
26 #define ADVANCED_TUTORIAL       // simple runnable example with explanations
27 #ifndef ADVANCED_TUTORIAL
28 #define BASIC_TUTORIAL          // Skeleton to add a new kernel
29 #endif
30  
31 namespace kernel_selector {
32     
33     class ConvolutionKernel_Tutorial : public ConvolutionKernelBase
34     {
35     public:
36         using Parent = ConvolutionKernelBase;
37         ConvolutionKernel_Tutorial() : Parent("convolution_tutorial") {}
38         virtual ~ConvolutionKernel_Tutorial() {}
39
40         virtual KernelsData GetKernelsData(const Params& params, const optional_params& options) const override;
41
42     protected:
43         virtual ParamsKey GetSupportedKey() const override;
44         virtual std::vector<WeightsLayout> GetSupportedWeightLayouts(const convolution_params&) const override
45         {
46             return{
47                 WeightsLayout::oiyx,
48                 WeightsLayout::yxio,
49                 WeightsLayout::iyxo,
50                 WeightsLayout::oyxi,
51             };
52         }
53
54 #ifdef ADVANCED_TUTORIAL
55         bool         Validate(const Params& p, const optional_params& o)                 const override;
56         JitConstants GetJitConstants(const convolution_params& params, const DispatchData& kd)  const override;
57         DispatchData SetDefault(const convolution_params& arg, int autoTuneIndex = -1)   const override;
58 #endif
59     };
60 }