doc: fixed majority of toctree warnings

This commit is contained in:
Pirogov, Vadim
2025-07-15 17:49:48 -07:00
committed by Vadim Pirogov
parent a52df83f09
commit 5bc5ba521c
4 changed files with 52 additions and 40 deletions

View File

@ -105,8 +105,6 @@ and the _a_ and _b_ dimensions represent the number of columns and rows, then
_ab_ would denote the row-major (C) format and _ba_ would denote the
column-major (Fortran) format.
@todo Picture here
Upper-case letters are used to indicate that the data is laid out in blocks for
a particular dimension. In such cases, the format name contains both upper- and
lower-case letters for that dimension with a lower-case letter preceded by the
@ -115,8 +113,6 @@ but with columns split into contiguous blocks of 16 elements each. Moreover, the
implicit assumption is that if the number of columns is not divisible by 16, the
last block in the in-memory representation will contain padding.
@todo Picture here
Since there are many widely used names for specific deep learning domains like
convolutional neural networks (CNNs), oneDNN also supports memory
format tags in which dimensions have specifically assigned meaning like 'image

View File

@ -1,10 +0,0 @@
Build and Link oneDNN
#####################
.. toctree::
:maxdepth: 1
dev_guide_system_requirements
dev_guide_build
dev_guide_build_options
dev_guide_link

View File

@ -7,23 +7,6 @@ Orphans
:maxdepth: 1
global
page_getting_started_cpp
page_memory_format_propagation_cpp
page_performance_profiling_cpp
page_cross_engine_reorder_cpp
page_cross_engine_reorder_c
page_sycl_interop_buffer_cpp
page_gpu_opencl_interop_cpp
page_bnorm_u8_via_binary_postops_cpp
page_cnn_inference_f32_cpp
page_cnn_inference_f32_c
page_cpu_rnn_inference_f32_cpp
page_cnn_inference_int8_cpp
page_cpu_rnn_inference_int8_cpp
page_cnn_training_f32_cpp
page_cpu_cnn_training_f32_c
page_rnn_training_f32_cpp
page_cnn_training_bf16_cpp
example_augru.cpp.rst
example_batch_normalization.cpp.rst
example_binary.cpp.rst
@ -35,26 +18,34 @@ Orphans
example_cnn_training_f32.cpp.rst
example_concat.cpp.rst
example_convolution.cpp.rst
example_cpu_brgemm.cpp.rst
example_cpu_cnn_training_f32.c.rst
example_cpu_matmul_csr.cpp.rst
example_cpu_getting_started.cpp.rst
example_cpu_inference_int8.cpp.rst
example_cpu_matmul_coo.cpp.rst
example_cpu_matmul_csr.cpp.rst
example_cpu_matmul_quantization.cpp.rst
example_cpu_matmul_weights_compression.cpp.rst
example_cpu_rnn_inference_f32.cpp.rst
example_cpu_rnn_inference_int8.cpp.rst
example_cpu_sgemm_and_matmul.cpp.rst
example_cpu_single_op_partition.cpp.rst
example_cross_engine_reorder.c.rst
example_cross_engine_reorder.cpp.rst
example_deconvolution.cpp.rst
example_eltwise.cpp.rst
example_getting_started.cpp.rst
example_gpu_opencl_getting_started.cpp.rst
example_gpu_opencl_interop.cpp.rst
example_group_normalization.cpp.rst
example_inference_int8_matmul.cpp.rst
example_inner_product.cpp.rst
example_layer_normalization.cpp.rst
example_group_normalization.cpp.rst
example_lbr_gru.cpp.rst
example_lrn.cpp.rst
example_lstm.cpp.rst
example_matmul.cpp.rst
example_matmul_perf.cpp.rst
example_memory_format_propagation.cpp.rst
example_performance_profiling.cpp.rst
example_pooling.cpp.rst
@ -66,7 +57,11 @@ Orphans
example_shuffle.cpp.rst
example_softmax.cpp.rst
example_sum.cpp.rst
example_sycl_getting_started.cpp.rst
example_sycl_interop_buffer.cpp.rst
example_sycl_interop_usm.cpp.rst
example_sycl_single_op_partition.cpp.rst
example_vanilla_rnn.cpp.rst
example_weights_decompression_matmul.cpp.rst
page_augru_example_cpp.rst
page_augru_example_cpp_short.rst
@ -74,24 +69,37 @@ Orphans
page_batch_normalization_example_cpp_short.rst
page_binary_example_cpp.rst
page_binary_example_cpp_short.rst
page_bnorm_u8_via_binary_postops_cpp
page_bnorm_u8_via_binary_postops_cpp_short.rst
page_cnn_inference_f32_c
page_cnn_inference_f32_cpp
page_cnn_inference_int8_cpp
page_cnn_training_bf16_cpp
page_cnn_training_f32_cpp
page_concat_example_cpp.rst
page_concat_example_cpp_short.rst
page_convolution_example_cpp.rst
page_convolution_example_cpp_short.rst
page_cpu_matmul_csr_cpp
page_cpu_cnn_training_f32_c
page_cpu_matmul_coo_cpp
page_cpu_matmul_weights_compression_cpp
page_cpu_matmul_csr_cpp
page_cpu_matmul_quantization_cpp.rst
page_cpu_matmul_quantization_cpp_short.rst
page_cpu_matmul_weights_compression_cpp
page_cpu_rnn_inference_f32_cpp
page_cpu_rnn_inference_int8_cpp
page_cpu_sgemm_and_matmul_cpp.rst
page_cpu_sgemm_and_matmul_cpp_short.rst
page_dev_guide_attributes_fpmath_mode.rst
page_cross_engine_reorder_c
page_cross_engine_reorder_cpp
page_deconvolution_example_cpp.rst
page_deconvolution_example_cpp_short.rst
page_dev_guide_attributes_accumulation_mode.rst
page_dev_guide_attributes_rounding_mode.rst
page_dev_guide_attributes_deterministic.rst
page_dev_guide_attributes_fpmath_mode.rst
page_dev_guide_attributes_post_ops.rst
page_dev_guide_attributes_quantization.rst
page_dev_guide_attributes_rounding_mode.rst
page_dev_guide_attributes_scratchpad.rst
page_dev_guide_conventions.rst
page_dev_guide_dpcpp_interoperability.rst
@ -104,21 +112,34 @@ Orphans
page_dev_guide_vtune.rst
page_eltwise_example_cpp.rst
page_eltwise_example_cpp_short.rst
page_getting_started_cpp
page_gpu_opencl_interop_cpp
page_graph_cpu_getting_started_cpp.rst
page_graph_cpu_inference_int8_cpp.rst
page_graph_cpu_single_op_partition_cpp.rst
page_graph_gpu_opencl_getting_started_cpp.rst
page_graph_sycl_getting_started_cpp.rst
page_graph_sycl_single_op_partition_cpp.rst
page_group_normalization_example_cpp.rst
page_group_normalization_example_cpp_short.rst
page_inference_int8_matmul_cpp.rst
page_inference_int8_matmul_cpp_short.rst
page_inner_product_example_cpp.rst
page_inner_product_example_cpp_short.rst
page_layer_normalization_example_cpp.rst
page_layer_normalization_example_cpp_short.rst
page_lbr_gru_example_cpp.rst
page_lbr_gru_example_cpp_short.rst
page_legal_information.rst
page_group_normalization_example_cpp.rst
page_group_normalization_example_cpp_short.rst
page_lrn_example_cpp.rst
page_lrn_example_cpp_short.rst
page_lstm_example_cpp.rst
page_lstm_example_cpp_short.rst
page_matmul_example_cpp.rst
page_matmul_example_cpp_short.rst
page_matmul_perf_cpp.rst
page_memory_format_propagation_cpp
page_performance_profiling_cpp
page_pooling_example_cpp.rst
page_pooling_example_cpp_short.rst
page_prelu_example_cpp.rst
@ -129,12 +150,16 @@ Orphans
page_reorder_example_cpp_short.rst
page_resampling_example_cpp.rst
page_resampling_example_cpp_short.rst
page_rnn_training_f32_cpp
page_shuffle_example_cpp.rst
page_shuffle_example_cpp_short.rst
page_softmax_example_cpp.rst
page_softmax_example_cpp_short.rst
page_sum_example_cpp.rst
page_sum_example_cpp_short.rst
page_todo.rst
page_sycl_interop_buffer_cpp
page_sycl_interop_usm_cpp.rst
page_vanilla_rnn_example_cpp.rst
page_vanilla_rnn_example_cpp_short.rst
page_weights_decompression_matmul_cpp.rst
page_weights_decompression_matmul_cpp_short.rst

View File

@ -236,6 +236,7 @@ def addTocTrees(app, env, docnames):
'dev_guide_attributes_accumulation_mode.rst',
'dev_guide_attributes_rounding_mode.rst',
'dev_guide_attributes_deterministic.rst',
'dev_guide_attributes_dropout.rst',
'dev_guide_attributes_quantization.rst',
'dev_guide_attributes_post_ops.rst',
'dev_guide_attributes_scratchpad.rst']}