Skip to content

Commit 6fd7f86

Browse files
authored
Update coral docs / links (#20674)
* Revise GPU and AI accelerator recommendations Updated hardware recommendations for AI acceleration. * Revise PCIe Coral driver installation instructions Updated instructions for PCIe Coral driver installation. * Revise Coral driver installation instructions Updated driver installation instructions for PCIe and M.2 versions of Google Coral. * Change PCIe Coral driver link in getting_started.md Updated the link for PCIe Coral driver instructions. * Change PCIe Coral driver link in installation guide Updated the link for PCIe Coral driver instructions. * Update Coral TPU recommendation in hardware documentation Added a warning about the Coral TPU's recommendation status for new Frigate installations and suggested alternatives.
1 parent 5d038b5 commit 6fd7f86

File tree

5 files changed

+11
-6
lines changed

5 files changed

+11
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
A complete and local NVR designed for [Home Assistant](https://www.home-assistant.io) with AI object detection. Uses OpenCV and Tensorflow to perform realtime object detection locally for IP cameras.
1414

15-
Use of a GPU or AI accelerator such as a [Google Coral](https://coral.ai/products/) or [Hailo](https://hailo.ai/) is highly recommended. AI accelerators will outperform even the best CPUs with very little overhead.
15+
Use of a GPU, Integrated GPU, or AI accelerator such as a [Hailo](https://hailo.ai/) is highly recommended. Dedicated hardware will outperform even the best CPUs with very little overhead.
1616

1717
- Tight integration with Home Assistant via a [custom component](https://github.com/blakeblackshear/frigate-hass-integration)
1818
- Designed to minimize resource use and maximize performance by only looking for objects when and where it is necessary

docs/docs/frigate/hardware.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,16 @@ In real-world deployments, even with multiple cameras running concurrently, Frig
104104

105105
### Google Coral TPU
106106

107+
:::warning
108+
109+
The Coral is no longer recommended for new Frigate installations, except in deployments with particularly low power requirements or hardware incapable of utilizing alternative AI accelerators for object detection. Instead, we suggest using one of the numerous other supported object detectors. Frigate will continue to provide support for the Coral TPU for as long as practicably possible given its still one of the most power-efficient devices for executing object detection models.
110+
111+
:::
112+
107113
Frigate supports both the USB and M.2 versions of the Google Coral.
108114

109115
- The USB version is compatible with the widest variety of hardware and does not require a driver on the host machine. However, it does lack the automatic throttling features of the other versions.
110-
- The PCIe and M.2 versions require installation of a driver on the host. Follow the instructions for your version from https://coral.ai
116+
- The PCIe and M.2 versions require installation of a driver on the host. https://github.com/jnicolson/gasket-builder should be used.
111117

112118
A single Coral can handle many cameras using the default model and will be sufficient for the majority of users. You can calculate the maximum performance of your Coral based on the inference speed reported by Frigate. With an inference speed of 10, your Coral will top out at `1000/10=100`, or 100 frames per second. If your detection fps is regularly getting close to that, you should first consider tuning motion masks. If those are already properly configured, a second Coral may be needed.
113119

docs/docs/frigate/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ services:
200200
shm_size: "512mb" # update for your cameras based on calculation above
201201
devices:
202202
- /dev/bus/usb:/dev/bus/usb # Passes the USB Coral, needs to be modified for other versions
203-
- /dev/apex_0:/dev/apex_0 # Passes a PCIe Coral, follow driver instructions here https://coral.ai/docs/m2/get-started/#2a-on-linux
203+
- /dev/apex_0:/dev/apex_0 # Passes a PCIe Coral, follow driver instructions here https://github.com/jnicolson/gasket-builder
204204
- /dev/video11:/dev/video11 # For Raspberry Pi 4B
205205
- /dev/dri/renderD128:/dev/dri/renderD128 # For intel hwaccel, needs to be updated for your hardware
206206
volumes:

docs/docs/guides/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ services:
202202
...
203203
devices:
204204
- /dev/bus/usb:/dev/bus/usb # passes the USB Coral, needs to be modified for other versions
205-
- /dev/apex_0:/dev/apex_0 # passes a PCIe Coral, follow driver instructions here https://coral.ai/docs/m2/get-started/#2a-on-linux
205+
- /dev/apex_0:/dev/apex_0 # passes a PCIe Coral, follow driver instructions here https://github.com/jnicolson/gasket-builder
206206
...
207207
```
208208

docs/docs/troubleshooting/edgetpu.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,7 @@ The USB Coral can become stuck and need to be restarted, this can happen for a n
6868

6969
The most common reason for the PCIe Coral not being detected is that the driver has not been installed. This process varies based on what OS and kernel that is being run.
7070

71-
- In most cases [the Coral docs](https://coral.ai/docs/m2/get-started/#2-install-the-pcie-driver-and-edge-tpu-runtime) show how to install the driver for the PCIe based Coral.
72-
- For some newer Linux distros (for example, Ubuntu 22.04+), https://github.com/jnicolson/gasket-builder can be used to build and install the latest version of the driver.
71+
- In most cases https://github.com/jnicolson/gasket-builder can be used to build and install the latest version of the driver.
7372

7473
## Attempting to load TPU as pci & Fatal Python error: Illegal instruction
7574

0 commit comments

Comments
 (0)