Skip to content

Commit 7f69fa7

Browse files
committed
doc: fix use of warning tags
1 parent ca81417 commit 7f69fa7

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

doc/programming_model/attributes_scratchpad.md

+2
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ oneDNN supports two modes for handling scratchpads:
5454
memory is shared across primitives. This mode minimizes the
5555
amount of memory needed for scratchpads at the application level. The global
5656
scratchpad is freed when all the primitives referencing it are destroyed.
57+
5758
@warning
5859
In this mode, primitives can be created and executed in parallel but must
5960
be executed in the same thread they were created in. Executing primitives
@@ -65,6 +66,7 @@ oneDNN supports two modes for handling scratchpads:
6566
private scratchpad memory. The scratchpad memory is freed when its
6667
primitive is destroyed. This mode can lead to larger memory footprint when
6768
compared to ONEDNN_ENABLE_CONCURRENT_EXEC=OFF.
69+
6870
@warning
6971
In this mode, primitives can be created in one thread and executed in
7072
another. Also, different primitives can be run concurrently.

examples/getting_started.cpp

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright 2019-2020 Intel Corporation
2+
* Copyright 2019-2022 Intel Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -182,7 +182,8 @@ void getting_started_tutorial(engine::kind engine_kind) {
182182
/// To initialize the @ref dnnl::memory::desc, we need to pass:
183183
/// 1. The tensor's dimensions, **the semantic order** of which is
184184
/// defined by **the primitive** that will use this memory
185-
/// (descriptor). Which leads to the following:
185+
/// (descriptor).
186+
///
186187
/// @warning
187188
/// Memory descriptors and objects are not aware of any meaning of
188189
/// the data they describe or contain.
@@ -255,6 +256,7 @@ void getting_started_tutorial(engine::kind engine_kind) {
255256
/// as required by CNN primitives. To define the physical memory format,
256257
/// the strides are passed as the third parameter. Note that the order of
257258
/// the strides corresponds to the order of the tensor's dimensions.
259+
///
258260
/// @warning
259261
/// Using the wrong order might lead to incorrect results or even a
260262
/// crash.

0 commit comments

Comments
 (0)