Skip to content

Commit 51b7e35

Browse files
committed
737 improve readme documentation (#738)
1 parent 9c75dd3 commit 51b7e35

File tree

1 file changed

+68
-57
lines changed

1 file changed

+68
-57
lines changed

README.md

Lines changed: 68 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
# Edge Developer Kit Reference Scripts
22

3-
This is a simplified developer kits reference setup scripts for various kind of Intel platforms and GPUs.
3+
This repository provides simplified developer kit reference setup scripts for various Intel platforms and GPUs.
44

5-
> **Note:** Main branch of this repository contains the latest development version of the project. It may include experimental features, work in progress, or unstable code.
5+
> **Note:** The main branch contains the latest development version of the project. It may include experimental features, work in progress, or unstable code.
66
7-
## Recommended Edge Design Support
8-
9-
| Edge Design | Product Line | Product Name | Installer Support | Validated Hardware |
10-
|-------------|--------------|--------------|-------------------|--------------------|
11-
| **Scalable Graphics**| Arc B-series | B60 | ❌ Future Support | |
12-
| | Arc B-series | B580 | ✅ Supported | |
13-
| | Arc A-Series | A770 | ✅ Supported | |
14-
| **Efficiency Optimized AI** | Core Ultra Processor Series 2 5/7/9 | Arrow Lake (ARL) | ✅ Supported | [Innodisk AXMB-D150 Arrow Island](https://www.innodisk.com/en/blog/intel-core-ultra-series2-reference-kit)<br>[IEI TANK-XM813](https://www.ieiworld.com/tw/product/model.php?II=1099)<br>[AAEON UP Xtreme ARL](https://up-board.org/up-xtreme-arl/)<br>[ASRock Industrial NUC BOX-255H](https://www.asrockind.com/en-gb/NUC%20BOX-255H) |
15-
| | Core Ultra Processor 5/7/9 | Meteor Lake (MTL) | ✅ Supported | [Seavo* PIR-1014A AIoT Developer Kit](https://www.seavo.com/en/pir_devkit/)<br>[AAEON* UP Xtreme i14](https://up-board.org/up-xtreme-i14/)<br>[ASRock Industrial* NUC BOX-155H](https://www.asrockind.com/en-gb/NUC%20BOX-155H)<br>[Asus* NUC 14 Pro](https://www.asus.com/displays-desktops/nucs/nuc-mini-pcs/asus-nuc-14-pro/)
16-
| **Mainstream** | Core Processors Series 2 | Bartlett Lake (BTL) | Future Support |
17-
| | Core Processors Series | Raptor Lake Refresh (RPL) | ✅ Supported | [IEI* TANK-XM811AI-RPL AIoT Developer Kit](https://www.ieiworld.com/en/product-ns/model.php?II=8)<br>[ASRock Industrial* iEPF-9030S-EW4](https://www.asrockind.com/iEPF-9030S-EW4) |
18-
| **Entry** | Processor Series | Twin Lake (TWL) | ✅ Supported | AAEON RS-UPN-ADLN355-A10-0864 |
7+
## Table of Contents
198

20-
## Validated Hardware Matrix
9+
- [Recommended Edge Design Support](#recommended-edge-design-support)
10+
- [Architecture Overview](#architecture-overview)
11+
- [System Requirements](#system-requirements)
12+
- [Quick Start](#quick-start)
13+
- [Use Cases](#use-cases)
14+
- [Troubleshooting](#troubleshooting)
15+
- [Support](#support)
16+
- [Disclaimer](#disclaimer)
2117

22-
**Below are the Validated Edge Design Combinations:**
18+
## Recommended Edge Design Support
2319

24-
| Edge Design | CPU Platform | GPU Configuration | Verification Date |
25-
|-------------|--------------|-------------------|-------------------|
26-
| **Efficiency Optimized AI** | **Arrow Lake (ARL)** | Arc B60 (dGPU) | ❌ Future Support |
27-
| | | Arc B580 (dGPU) | ✅ July 2025 |
28-
| | | Arc A770 (dGPU) | ✅ July 2025 |
29-
| **Mainstream** | Bartlett Lake (BTL) | Arc B60 | ❌ Future Support |
20+
| Product Collection | Code Name | Support | Validated Hardware |
21+
|--------------|--------------|-------------------|--------------------|
22+
| Intel® Arc™ Pro B-Series Graphics | Products formerly Battlemage | 📋 Planned | |
23+
| Intel® Arc™ B-Series Graphics | Products formerly Battlemage | ✅ Supported | |
24+
| Intel® Arc™ A-Series Graphics | Products formerly Alchemist | ✅ Supported | |
25+
| Intel® Core™ Ultra Processors (Series 2) | Products formerly Arrow Lake | ✅ Supported | [Innodisk Intel® Core™ Ultra Series 2 Reference Kit](https://www.innodisk.com/en/blog/intel-core-ultra-series2-reference-kit)<br>[IEI TANK-XM813](https://www.ieiworld.com/tw/product/model.php?II=1099)<br>[AAEON UP Xtreme ARL](https://up-board.org/up-xtreme-arl/)<br>[ASRock Industrial NUC BOX-255H](https://www.asrockind.com/en-gb/NUC%20BOX-255H) |
26+
| Intel® Core™ Ultra processors (Series 1) | Products formerly Meteor Lake | ✅ Supported | [Seavo* PIR-1014A AIoT Developer Kit](https://www.seavo.com/en/pir_devkit/)<br>[AAEON* UP Xtreme i14](https://up-board.org/up-xtreme-i14/)<br>[ASRock Industrial* NUC BOX-155H](https://www.asrockind.com/en-gb/NUC%20BOX-155H)<br>[Asus* NUC 14 Pro](https://www.asus.com/displays-desktops/nucs/nuc-mini-pcs/asus-nuc-14-pro/) |
27+
| Intel® Core™ processors (Series 2) | Products formerly Bartlett Lake | 📋 Planned | |
28+
| Intel® Core™ processors (Series 1) | Products formerly Raptor Lake | ✅ Supported | |
29+
| Intel® Core™ Processor N-series | Products formerly Twin Lake | ✅ Supported | AAEON RS-UPN-ADLN355-A10-0864 |
3030

3131
## Architecture Overview
3232

@@ -35,20 +35,20 @@ edge-developer-kit-reference-scripts/
3535
├── main_installer.sh # Main entry point
3636
├── platform_detection.sh # Platform and hardware detection
3737
├── npu_installer.sh # NPU drivers (Core Ultra)
38+
├── gpu_installer.sh # GPU drivers and tools
3839
├── openvino_installer.sh # OpenVINO and camera use cases
39-
├── camera_installer.sh # Camera drivers and tools
4040
├── print_summary_table.sh # Summarize post installation
4141
└── usecases/ # Reference implementation
4242
```
4343

4444
## System Requirements
4545

46-
- **OS**: Ubuntu 24.04 LTS only
47-
- **Kernel**: Script will auto install HWE kernel
48-
- **Privileges**: Must run with sudo/root
49-
- **Internet**: Required for package downloads
50-
- **Edge Design Platform**: All
51-
- **GPU**: iGPU or/and dGPU of the setup
46+
- **Operating System:** Ubuntu 24.04 LTS (Desktop)
47+
- **Kernel:** HWE kernel (auto-installed by script)
48+
- **User Privileges:** Requires sudo/root access
49+
- **Internet Connection:** Needed for package installation
50+
- **Graphics:** Integrated (iGPU) and/or discrete (dGPU) GPU
51+
5252

5353
## Quick Start
5454

@@ -57,32 +57,38 @@ edge-developer-kit-reference-scripts/
5757

5858
2. **Run Setup Script**
5959

60-
This step will configure the basic setup of the platform. Ensure all of the requirements have been met before proceeding to the next step.
60+
This step will configure the basic setup of the platform. Ensure all requirements have been met before proceeding.
6161

6262
```bash
6363
git clone https://github.com/intel/edge-developer-kit-reference-scripts.git
6464
cd edge-developer-kit-reference-scripts
6565
sudo ./main_installer.sh
6666
```
67-
After finished installation, it may ask you to reboot your system. Reboot the system.
67+
68+
After installation finishes, you may be asked to reboot your system. Reboot when prompted.
6869
Installation is completed when you see this message:
70+
6971
> ✓ Platform configured
70-
72+
>
7173
> System reboot is required.
7274
7375
3. **Re-run the Installer**
76+
77+
After rebooting, run the installer again to complete the setup:
78+
7479
```bash
7580
sudo ./main_installer.sh
7681
```
7782
## Use Cases
83+
7884
1. [Intel® Distribution of OpenVINO™ Toolkit](usecases/ai/openvino/README.md)
7985
2. [Open WebUI with Ollama](usecases/ai/openwebui-ollama/README.md)
8086
3. [LLM RAG Toolkit](usecases/ai/rag-toolkit/README.md)
8187
4. [AI Video Analytics](usecases/ai/ai-video-analytics/README.md)
8288
5. [Digital Avatar](usecases/ai/digital-avatar/README.md)
8389
6. [Time Coordinated Computing (TCC)](usecases/real-time/tcc_tutorial/README.md)
8490
7. [Smart Parking](usecases/ai/smart-parking/README.md)
85-
8. [Video Summarization & Visual RAG](usecases/ai/video_summarization)
91+
8. [Video Summarization & Visual RAG](usecases/ai/video_summarization/README.md)
8692

8793
## Troubleshooting
8894

@@ -100,40 +106,45 @@ Please install HWE kernel: sudo apt install linux-generic-hwe-24.04
100106
✗ This script must be run with sudo or as root user
101107
```
102108

103-
### Log Files
104-
Installation logs are displayed in real-time. For troubleshooting, check:
105-
- System package manager logs: `/var/log/apt/`
106-
- Docker logs: `docker logs [container_name]`
109+
### Platform-Specific Issues
107110

108-
- NPU logs: `/var/log/intel-npu.log`
109-
- Installation logs: Terminal output
110-
111-
## Troubleshooting
112-
113-
### Platform Not Detected
111+
**Platform Not Detected:**
114112
- Check `/sys/class/dmi/id/product_name`
115113
- Add to appropriate platform list
116114

117-
### NPU Not Available
118-
- Verify Core Ultra platform
119-
- Check if NPU device exists: `ls /dev/intel-npu*`
120-
- May require system reboot
115+
**NPU Not Detected:**
116+
- Confirm you are using a Core Ultra platform
117+
- Check for NPU device: `ls /dev/intel-npu*`
118+
- If missing, reboot the system and rerun the installer
119+
120+
**GPU Issues:**
121+
- Run the GPU installer separately: `./gpu_installer.sh`
122+
- Verify GPU detection: `lspci | grep -i vga`
123+
- If issues persist, check for error messages in the terminal and review relevant log files
124+
- Reboot the system after driver installation if prompted
121125

122-
### GPU Issues
123-
- Run standalone GPU installer: `../gpu/setup.sh`
124-
- Check GPU detection: `lspci | grep -i vga`
126+
### Log Files & Troubleshooting Steps
125127

126-
## Support
128+
During installation, logs are displayed in real time. For deeper troubleshooting, consult these sources:
127129

128-
For issues and questions:
129-
- Check logs and error messages
130-
- Verify platform compatibility
131-
- Test individual components
132-
- Report bugs with platform details in here https://github.com/intel/edge-developer-kit-reference-scripts/issues
130+
- **APT Package Logs:** `/var/log/apt/`
131+
- **Docker Logs:** `docker logs [container_name]`
132+
- **NPU Driver Logs:** `/var/log/intel-npu.log`
133+
- **Installer Output:** Review terminal messages for errors or warnings
134+
135+
**Troubleshooting Checklist:**
136+
- Review relevant log files for error details
137+
- Confirm your hardware matches the supported platforms
138+
- Test individual installer scripts (e.g., `gpu_installer.sh`, `npu_installer.sh`)
139+
- Search for known issues in [GitHub Issues](https://github.com/intel/edge-developer-kit-reference-scripts/issues)
140+
- When reporting a bug, include platform model, OS version, and log excerpts
141+
142+
For further assistance, open an issue on GitHub with detailed information.
133143

134144
## Disclaimer
145+
135146
This repository contains pre-production code and is intended for testing and evaluation purposes only. The code and features provided here are in development and may be incomplete, unstable, or subject to change without notice. Use this repository at your own risk.
136147

137148
The reference scripts provided in this repository have been validated and tested on the hardware listed in the documentation. While we strive to ensure compatibility and performance, these scripts may not function as expected on other hardware configurations. Users may encounter issues or unexpected behavior when running the scripts on untested hardware. If you encounter any issues or have suggestions for improvements, we welcome you to open an issue.
138149

139-
GStreamer* is an open source framework licensed under LGPL. See https://gstreamer.freedesktop.org/documentation/frequently-asked-questions/licensing.html. You are solely responsible for determining if your use of GStreamer requires any additional licenses. Intel is not responsible for obtaining any such licenses, nor liable for any licensing fees due, in connection with your use of GStreamer.
150+
**GStreamer License Notice:** GStreamer* is an open source framework licensed under LGPL. See https://gstreamer.freedesktop.org/documentation/frequently-asked-questions/licensing.html. You are solely responsible for determining if your use of GStreamer requires any additional licenses. Intel is not responsible for obtaining any such licenses, nor liable for any licensing fees due, in connection with your use of GStreamer.

0 commit comments

Comments
 (0)