.. index:: pair: page; Softmax Primitive Example .. _doxid-softmax_example_cpp: Softmax Primitive Example ========================= This C++ API example demonstrates how to create and execute a :ref:`Softmax ` primitive in forward training propagation mode. Key optimizations included in this example: * In-place primitive execution; * Softmax along axis 1 (C) for 2D tensors. .. ref-code-block:: cpp /******************************************************************************* * Copyright 2020-2022 Intel Corporation * * 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. *******************************************************************************/ #include #include #include #include #include #include "example_utils.hpp" #include "oneapi/dnnl/dnnl.hpp" using namespace :ref:`dnnl `; using :ref:`tag ` = :ref:`memory::format_tag `; using :ref:`dt ` = :ref:`memory::data_type `; void softmax_example(:ref:`dnnl::engine::kind ` engine_kind) { // Create execution dnnl::engine. :ref:`dnnl::engine ` :ref:`engine `(engine_kind, 0); // Create dnnl::stream. :ref:`dnnl::stream ` engine_stream(:ref:`engine `); // Tensor dimensions. const :ref:`memory::dim ` N = 3, // batch size IC = 1000; // channels // Source (src) and destination (dst) tensors dimensions. :ref:`memory::dims ` src_dims = {N, IC}; // Allocate buffer. std::vector src_data(product(src_dims)); std::generate(src_data.begin(), src_data.end(), []() { static int i = 0; return std::cos(i++ / 10.f); }); // Create src memory descriptor and memory object. auto :ref:`src_md ` = :ref:`memory::desc `(src_dims, :ref:`dt::f32 `, tag::nc); auto :ref:`dst_md ` = :ref:`memory::desc `(src_dims, :ref:`dt::f32 `, tag::nc); auto src_mem = :ref:`memory `(src_md, :ref:`engine `); // Write data to memory object's handle. write_to_dnnl_memory(src_data.data(), src_mem); // Softmax axis. const int axis = 1; // Create primitive descriptor. auto softmax_pd = :ref:`softmax_forward::primitive_desc `(:ref:`engine `, :ref:`prop_kind::forward_training `, :ref:`algorithm::softmax_accurate `, src_md, dst_md, axis); // Create the primitive. auto softmax_prim = :ref:`softmax_forward `(softmax_pd); // Primitive arguments. Set up in-place execution by assigning src as DST. std::unordered_map softmax_args; softmax_args.insert({:ref:`DNNL_ARG_SRC `, src_mem}); softmax_args.insert({:ref:`DNNL_ARG_DST `, src_mem}); // Primitive execution. softmax_prim.execute(engine_stream, softmax_args); // Wait for the computation to finalize. engine_stream.wait(); // Read data from memory object's handle. read_from_dnnl_memory(src_data.data(), src_mem); } int main(int argc, char **argv) { return handle_example_errors( softmax_example, parse_engine_kind(argc, argv)); }