diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/MAINTAINERS.md | 28 | ||||
-rw-r--r-- | documentation/openvino.md | 92 | ||||
-rw-r--r-- | documentation/reporting_bugs.md | 2 | ||||
-rw-r--r-- | documentation/submitting_patches.md | 2 | ||||
-rw-r--r-- | documentation/tested_hardware.md | 17 |
5 files changed, 101 insertions, 40 deletions
diff --git a/documentation/MAINTAINERS.md b/documentation/MAINTAINERS.md deleted file mode 100644 index ea435849..00000000 --- a/documentation/MAINTAINERS.md +++ /dev/null | |||
@@ -1,28 +0,0 @@ | |||
1 | The purpose of this file is to provide contact information for | ||
2 | specific BSPs and other code contained within meta-intel. You should | ||
3 | address questions and patches for a particular BSP or other code to | ||
4 | the appropriate maintainer listed in this file, cc'ing the meta-intel | ||
5 | mailing list. This ensures that your question or patch will be | ||
6 | addressed by the appropriate person, and that it will be seen by other | ||
7 | users who may be facing similar problems or questions. | ||
8 | |||
9 | Please see the [Guidelines for submitting patches](submitting_patches.md) | ||
10 | and [Reporting bugs](reporting_bugs.md) guidelines relating to the | ||
11 | details of submitting patches, reporting problems, or asking questions | ||
12 | about any of the BSPs or other recipes contained within meta-intel. | ||
13 | |||
14 | Descriptions of section entries: | ||
15 | |||
16 | M: Mail patches to: FullName <address@domain> | ||
17 | F: Files and directories with wildcard patterns. | ||
18 | A trailing slash includes all files and subdirectory files. | ||
19 | F: common/ all files in and below common | ||
20 | F: common/* all files in common, but not below | ||
21 | One pattern per line. Multiple F: lines acceptable. | ||
22 | |||
23 | Please keep this list in alphabetical order. | ||
24 | |||
25 | Maintainers List (try to look for most precise areas first) | ||
26 | |||
27 | M: Anuj Mittal <anuj.mittal@intel.com> | ||
28 | F: * | ||
diff --git a/documentation/openvino.md b/documentation/openvino.md new file mode 100644 index 00000000..9794b928 --- /dev/null +++ b/documentation/openvino.md | |||
@@ -0,0 +1,92 @@ | |||
1 | Build a Yocto Image with OpenVINO™ toolkit | ||
2 | ========================================== | ||
3 | |||
4 | Follow the [Yocto Project official documentation](https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html#compatible-linux-distribution) to set up and configure your host machine to be compatible with BitBake. | ||
5 | |||
6 | ## Step 1: Set Up Environment | ||
7 | |||
8 | 1. Clone the repositories. | ||
9 | |||
10 | ``` | ||
11 | git clone https://git.yoctoproject.org/git/poky | ||
12 | git clone https://github.com/openembedded/meta-openembedded | ||
13 | git clone https://git.yoctoproject.org/git/meta-intel | ||
14 | git clone https://github.com/intel/meta-openvino | ||
15 | ``` | ||
16 | |||
17 | |||
18 | 2. Set up the OpenEmbedded build environment. | ||
19 | |||
20 | ``` | ||
21 | source poky/oe-init-build-env | ||
22 | |||
23 | ``` | ||
24 | |||
25 | |||
26 | |||
27 | 3. Add BitBake layers. | ||
28 | |||
29 | |||
30 | ``` | ||
31 | bitbake-layers add-layer ../meta-openembedded/meta-oe | ||
32 | bitbake-layers add-layer ../meta-openembedded/meta-python | ||
33 | bitbake-layers add-layer ../meta-intel | ||
34 | bitbake-layers add-layer ../meta-openvino | ||
35 | |||
36 | ``` | ||
37 | |||
38 | |||
39 | 4. Set up BitBake configurations. | ||
40 | Include extra configuration in the `conf/local.conf` file in your build directory as required. | ||
41 | |||
42 | |||
43 | ``` | ||
44 | MACHINE = "intel-skylake-64" | ||
45 | |||
46 | # Enable building OpenVINO Python API. | ||
47 | # This requires meta-python layer to be included in bblayers.conf. | ||
48 | PACKAGECONFIG:append:pn-openvino-inference-engine = " python3" | ||
49 | |||
50 | # This adds OpenVINO related libraries in the target image. | ||
51 | CORE_IMAGE_EXTRA_INSTALL:append = " openvino-inference-engine" | ||
52 | |||
53 | # This adds OpenVINO samples in the target image. | ||
54 | CORE_IMAGE_EXTRA_INSTALL:append = " openvino-inference-engine-samples" | ||
55 | |||
56 | # Include OpenVINO Python API package in the target image. | ||
57 | CORE_IMAGE_EXTRA_INSTALL:append = " openvino-inference-engine-python3" | ||
58 | |||
59 | ``` | ||
60 | |||
61 | ## Step 2: Build a Yocto Image with OpenVINO Packages | ||
62 | |||
63 | Run BitBake to build your image with OpenVINO packages. For example, to build the minimal image, run the following command: | ||
64 | |||
65 | |||
66 | ``` | ||
67 | bitbake core-image-minimal | ||
68 | |||
69 | ``` | ||
70 | |||
71 | ## Step 3: Verify the Yocto Image | ||
72 | |||
73 | Verify that OpenVINO packages were built successfully. Run the following command: | ||
74 | |||
75 | ``` | ||
76 | oe-pkgdata-util list-pkgs | grep openvino | ||
77 | |||
78 | ``` | ||
79 | |||
80 | |||
81 | If the image build is successful, it will return the list of packages as below: | ||
82 | |||
83 | ``` | ||
84 | openvino-inference-engine | ||
85 | openvino-inference-engine-dbg | ||
86 | openvino-inference-engine-dev | ||
87 | openvino-inference-engine-python3 | ||
88 | openvino-inference-engine-samples | ||
89 | openvino-inference-engine-src | ||
90 | openvino-inference-engine-doc | ||
91 | |||
92 | ``` | ||
diff --git a/documentation/reporting_bugs.md b/documentation/reporting_bugs.md index 59621c1e..5fbc3d27 100644 --- a/documentation/reporting_bugs.md +++ b/documentation/reporting_bugs.md | |||
@@ -1,7 +1,7 @@ | |||
1 | ## Reporting bugs | 1 | ## Reporting bugs |
2 | 2 | ||
3 | If you have problems with or questions about a particular BSP, please | 3 | If you have problems with or questions about a particular BSP, please |
4 | contact the maintainer listed in the [Maintainers](MAINTAINERS.md) file directly (cc:ing | 4 | contact the maintainer listed in the [Maintainer](../README.md#maintainers) section directly (cc:ing |
5 | the Yocto mailing list puts it in the archive and helps other people | 5 | the Yocto mailing list puts it in the archive and helps other people |
6 | who might have the same questions in the future), but please try to do | 6 | who might have the same questions in the future), but please try to do |
7 | the following first: | 7 | the following first: |
diff --git a/documentation/submitting_patches.md b/documentation/submitting_patches.md index 41a039bd..f36c4b08 100644 --- a/documentation/submitting_patches.md +++ b/documentation/submitting_patches.md | |||
@@ -22,5 +22,5 @@ a patch or patch sets within 24 hours of the time it was posted. For | |||
22 | larger and/or more involved patches and patch sets, the review process | 22 | larger and/or more involved patches and patch sets, the review process |
23 | may take longer. | 23 | may take longer. |
24 | 24 | ||
25 | Please see the [MAINTAINERS](MAINTAINERS.md) for the list of maintainers. It's also | 25 | Please see the [maintainers](../README.md#maintainers) section for the list of maintainers. It's also |
26 | a good idea to cc: the maintainer, if applicable. | 26 | a good idea to cc: the maintainer, if applicable. |
diff --git a/documentation/tested_hardware.md b/documentation/tested_hardware.md index 48a25ab4..1fa81454 100644 --- a/documentation/tested_hardware.md +++ b/documentation/tested_hardware.md | |||
@@ -1,23 +1,20 @@ | |||
1 | ## Tested Hardware | 1 | ## Tested Hardware |
2 | 2 | ||
3 | The following undergo regular basic testing with their respective MACHINE types. | 3 | The following undergo regular testing with their respective MACHINE types: |
4 | 4 | ||
5 | - intel-corei7-64: | 5 | - intel-corei7-64: |
6 | * Alder Lake-P | 6 | * Alder Lake-P/S/PS |
7 | * Alder Lake-S | 7 | * Amston Lake |
8 | * Alder Lake-PS | ||
9 | * Elkhart Lake | 8 | * Elkhart Lake |
10 | * Metor Lake-P | 9 | * Metor Lake-P |
11 | * Raptor Lake-P | 10 | * Raptor Lake-P/S |
12 | * Tiger Lake | 11 | * Tiger Lake |
13 | 12 | ||
14 | - intel-skylake-64: | 13 | - intel-skylake-64: |
15 | * Alder Lake-P | 14 | * Alder Lake-P/S/PS |
16 | * Alder Lake-S | 15 | * Amston Lake |
17 | * Alder Lake-PS | ||
18 | * Elkhart Lake | ||
19 | * Metor Lake-P | 16 | * Metor Lake-P |
20 | * Raptor Lake-P | 17 | * Raptor Lake-P/S |
21 | * Tiger Lake | 18 | * Tiger Lake |
22 | 19 | ||
23 | - intel-core2-32: | 20 | - intel-core2-32: |