gh-pages: update documentation

oneapi-src · Sep 25, 2023 · 1526b29 · 1526b29
commit 1526b29
Show file tree

Hide file tree

Showing 62,227 changed files with 18,213,541 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/bf16_programming.jpg b/_images/bf16_programming.jpg
diff --git a/_images/img_bf16_diagram.png b/_images/img_bf16_diagram.png
diff --git a/_images/img_depthwise_fusion.jpg b/_images/img_depthwise_fusion.jpg
diff --git a/_images/img_graph_programming_model.png b/_images/img_graph_programming_model.png
diff --git a/_images/img_inference_scope.jpg b/_images/img_inference_scope.jpg
diff --git a/_images/img_multiscalar.png b/_images/img_multiscalar.png
diff --git a/_images/img_programming_model.png b/_images/img_programming_model.png
diff --git a/_images/img_singlescalar.png b/_images/img_singlescalar.png
diff --git a/_images/int8_programming.jpg b/_images/int8_programming.jpg
diff --git a/_images/mem_fmt_blk.png b/_images/mem_fmt_blk.png
diff --git a/_images/mem_fmt_img1.png b/_images/mem_fmt_img1.png
diff --git a/_images/mem_fmt_img2.png b/_images/mem_fmt_img2.png
diff --git a/_images/mem_fmt_padded_blk.png b/_images/mem_fmt_padded_blk.png
diff --git a/_images/strides.png b/_images/strides.png
diff --git a/_images/unrolled_stack_rnn.jpg b/_images/unrolled_stack_rnn.jpg
diff --git a/_sources/advanced_topics.rst.txt b/_sources/advanced_topics.rst.txt
@@ -0,0 +1,13 @@
+Advanced Topics
+#####################
+
+.. toctree::
+   :maxdepth: 1
+
+   dev_guide_transition_to_dnnl
+   dev_guide_understanding_memory_formats
+   dev_guide_int8_computations
+   dev_guide_primitive_cache
+   dev_guide_persistent_cache
+   dev_guide_threadpool
+   dev_guide_experimental
diff --git a/_sources/build_and_link.rst.txt b/_sources/build_and_link.rst.txt
@@ -0,0 +1,9 @@
+Building and Linking
+######################
+
+.. toctree::
+   :maxdepth: 1
+
+   dev_guide_build
+   dev_guide_build_options
+   dev_guide_link
diff --git a/_sources/class_dnnl_graph_allocator.rst.txt b/_sources/class_dnnl_graph_allocator.rst.txt
@@ -0,0 +1,82 @@
+.. index:: pair: class; dnnl::graph::allocator
+.. _doxid-classdnnl_1_1graph_1_1allocator:
+
+class dnnl::graph::allocator
+============================
+
+.. toctree::
+	:hidden:
+
+Overview
+~~~~~~~~
+
+Allocator. :ref:`More...<details-classdnnl_1_1graph_1_1allocator>`
+
+
+.. ref-code-block:: cpp
+	:class: doxyrest-overview-code-block
+
+	#include <dnnl_graph.hpp>
+
+	class allocator: public allocator_handle
+	{
+	public:
+		// construction
+
+		:ref:`allocator<doxid-classdnnl_1_1graph_1_1allocator_1a3eee4ea26be21d46e52dfa8c52764c74>`(
+			:ref:`dnnl_graph_host_allocate_f<doxid-group__dnnl__graph__api__allocator_1gae34382069edddd880a407f22c5dfd8e1>` host_malloc,
+			:ref:`dnnl_graph_host_deallocate_f<doxid-group__dnnl__graph__api__allocator_1gaaa02889e076ef93c15da152bba7d29b0>` host_free
+			);
+
+		:ref:`allocator<doxid-classdnnl_1_1graph_1_1allocator_1a0df3aa313d3d7699ab8a3ee687800dd8>`();
+	};
+.. _details-classdnnl_1_1graph_1_1allocator:
+
+Detailed Documentation
+~~~~~~~~~~~~~~~~~~~~~~
+
+Allocator.
+
+Construction
+------------
+
+.. index:: pair: function; allocator
+.. _doxid-classdnnl_1_1graph_1_1allocator_1a3eee4ea26be21d46e52dfa8c52764c74:
+
+.. ref-code-block:: cpp
+	:class: doxyrest-title-code-block
+
+	allocator(
+		:ref:`dnnl_graph_host_allocate_f<doxid-group__dnnl__graph__api__allocator_1gae34382069edddd880a407f22c5dfd8e1>` host_malloc,
+		:ref:`dnnl_graph_host_deallocate_f<doxid-group__dnnl__graph__api__allocator_1gaaa02889e076ef93c15da152bba7d29b0>` host_free
+		)
+
+Constructs an allocator according to given function pointers.
+
+
+
+.. rubric:: Parameters:
+
+.. list-table::
+	:widths: 20 80
+
+	*
+		- host_malloc
+
+		- A pointer to malloc function for CPU
+
+	*
+		- host_free
+
+		- A pointer to free function for CPU
+
+.. index:: pair: function; allocator
+.. _doxid-classdnnl_1_1graph_1_1allocator_1a0df3aa313d3d7699ab8a3ee687800dd8:
+
+.. ref-code-block:: cpp
+	:class: doxyrest-title-code-block
+
+	allocator()
+
+Default constructor.
+
diff --git a/_sources/class_dnnl_graph_compiled_partition.rst.txt b/_sources/class_dnnl_graph_compiled_partition.rst.txt
@@ -0,0 +1,156 @@
+.. index:: pair: class; dnnl::graph::compiled_partition
+.. _doxid-classdnnl_1_1graph_1_1compiled__partition:
+
+class dnnl::graph::compiled_partition
+=====================================
+
+.. toctree::
+	:hidden:
+
+Overview
+~~~~~~~~
+
+A compiled partition object. :ref:`More...<details-classdnnl_1_1graph_1_1compiled__partition>`
+
+
+.. ref-code-block:: cpp
+	:class: doxyrest-overview-code-block
+
+	#include <dnnl_graph.hpp>
+
+	class compiled_partition: public compiled_partition_handle
+	{
+	public:
+		// construction
+
+		:ref:`compiled_partition<doxid-classdnnl_1_1graph_1_1compiled__partition_1a3cf34b8ed11d40de19bac51d2d94ae30>`();
+		:ref:`compiled_partition<doxid-classdnnl_1_1graph_1_1compiled__partition_1a398d2eb4d4d6253a1413af74c215b671>`(:ref:`dnnl_graph_compiled_partition_t<doxid-group__dnnl__graph__api__compiled__partition_1ga7578c6d5c3efdbaddd7b8e19429f546a>` compiled_partition);
+
+		// methods
+
+		:ref:`logical_tensor<doxid-classdnnl_1_1graph_1_1logical__tensor>` :ref:`query_logical_tensor<doxid-classdnnl_1_1graph_1_1compiled__partition_1a85962826e94cc3cefb3c19c0fadc4e09>`(size_t tid) const;
+		std::vector<std::pair<size_t, size_t>> :ref:`get_inplace_ports<doxid-classdnnl_1_1graph_1_1compiled__partition_1ab80ec9f6a37ddbf7b2636fb35acf74f2>`() const;
+
+		void :ref:`execute<doxid-classdnnl_1_1graph_1_1compiled__partition_1a558ed47b3cbc5cc2167001da3faa0339>`(
+			:ref:`stream<doxid-structdnnl_1_1stream>`& astream,
+			const std::vector<:ref:`tensor<doxid-classdnnl_1_1graph_1_1tensor>`>& inputs,
+			const std::vector<:ref:`tensor<doxid-classdnnl_1_1graph_1_1tensor>`>& outputs
+			) const;
+	};
+.. _details-classdnnl_1_1graph_1_1compiled__partition:
+
+Detailed Documentation
+~~~~~~~~~~~~~~~~~~~~~~
+
+A compiled partition object.
+
+Construction
+------------
+
+.. index:: pair: function; compiled_partition
+.. _doxid-classdnnl_1_1graph_1_1compiled__partition_1a3cf34b8ed11d40de19bac51d2d94ae30:
+
+.. ref-code-block:: cpp
+	:class: doxyrest-title-code-block
+
+	compiled_partition()
+
+Default constructor. Constructs an empty object.
+
+.. index:: pair: function; compiled_partition
+.. _doxid-classdnnl_1_1graph_1_1compiled__partition_1a398d2eb4d4d6253a1413af74c215b671:
+
+.. ref-code-block:: cpp
+	:class: doxyrest-title-code-block
+
+	compiled_partition(:ref:`dnnl_graph_compiled_partition_t<doxid-group__dnnl__graph__api__compiled__partition_1ga7578c6d5c3efdbaddd7b8e19429f546a>` compiled_partition)
+
+Constructs a compiled partition object.
+
+Methods
+-------
+
+.. index:: pair: function; query_logical_tensor
+.. _doxid-classdnnl_1_1graph_1_1compiled__partition_1a85962826e94cc3cefb3c19c0fadc4e09:
+
+.. ref-code-block:: cpp
+	:class: doxyrest-title-code-block
+
+	:ref:`logical_tensor<doxid-classdnnl_1_1graph_1_1logical__tensor>` query_logical_tensor(size_t tid) const
+
+Queries an input or output logical tensor according to tensor ID.
+
+If the tensor ID doesn't belong to any input or output of the compiled partition, an exception will be raised by the API.
+
+
+
+.. rubric:: Parameters:
+
+.. list-table::
+	:widths: 20 80
+
+	*
+		- tid
+
+		- The unique id of required tensor.
+
+
+
+.. rubric:: Returns:
+
+The logical tensor.
+
+.. index:: pair: function; get_inplace_ports
+.. _doxid-classdnnl_1_1graph_1_1compiled__partition_1ab80ec9f6a37ddbf7b2636fb35acf74f2:
+
+.. ref-code-block:: cpp
+	:class: doxyrest-title-code-block
+
+	std::vector<std::pair<size_t, size_t>> get_inplace_ports() const
+
+Returns the hint of in-place pairs from a compiled partition.
+
+It indicates that an input and an output of the partition can share the same memory buffer for computation. In-place computation helps to reduce the memory footprint and improves cache locality. But since the library may not have a global view of user's application, it's possible that the input tensor is used at other places in user's computation graph. In this case, the user should take the in-place pair as a hint and pass a different memory buffer for output tensor to avoid overwriting the input memory buffer which will probably cause unexpected incorrect results.
+
+
+
+.. rubric:: Returns:
+
+A list of pairs of input and output IDs.
+
+.. index:: pair: function; execute
+.. _doxid-classdnnl_1_1graph_1_1compiled__partition_1a558ed47b3cbc5cc2167001da3faa0339:
+
+.. ref-code-block:: cpp
+	:class: doxyrest-title-code-block
+
+	void execute(
+		:ref:`stream<doxid-structdnnl_1_1stream>`& astream,
+		const std::vector<:ref:`tensor<doxid-classdnnl_1_1graph_1_1tensor>`>& inputs,
+		const std::vector<:ref:`tensor<doxid-classdnnl_1_1graph_1_1tensor>`>& outputs
+		) const
+
+Execute a compiled partition.
+
+
+
+.. rubric:: Parameters:
+
+.. list-table::
+	:widths: 20 80
+
+	*
+		- astream
+
+		- Stream object to run over.
+
+	*
+		- inputs
+
+		- A list of input tensors.
+
+	*
+		- outputs
+
+		- A list of output tensors.
+