Skip to content

Commit 9d06988

Browse files
committed
Update installation instructions
Update installation (pisetup.md) and usage (usage.md) instructions for latest RPi OS 64-bit (Debian Trixie) and latest insect-detect v2.0.0 version. Update deploy workflow to latest github actions versions.
1 parent e2572b9 commit 9d06988

19 files changed

+128
-115
lines changed
Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,34 @@
1-
name: ci
1+
name: Deploy docs
22
on:
33
push:
44
branches:
55
- main
6+
7+
env:
8+
PYTHON_VERSION: 3.x
9+
610
permissions:
711
contents: write
12+
813
jobs:
914
deploy:
1015
runs-on: ubuntu-latest
1116
steps:
12-
- uses: actions/checkout@v4
17+
- uses: actions/checkout@v6
1318
- name: Configure Git Credentials
1419
run: |
1520
git config user.name github-actions[bot]
1621
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
17-
- uses: actions/setup-python@v5
22+
- uses: actions/setup-python@v6
1823
with:
19-
python-version: 3.x
20-
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
21-
- uses: actions/cache@v4
24+
python-version: ${{ env.PYTHON_VERSION }}
25+
- name: Set cache ID
26+
id: cache_id
27+
run: echo "value=$(date --utc '+%V')" >> $GITHUB_OUTPUT
28+
- uses: actions/cache@v5
2229
with:
23-
key: mkdocs-material-${{ env.cache_id }}
24-
path: .cache
30+
key: mkdocs-material-${{ steps.cache_id.outputs.value }}
31+
path: ~/.cache
2532
restore-keys: |
2633
mkdocs-material-
2734
- run: pip install mkdocs-material mkdocs-glightbox

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ the DIY camera trap.
1818
The Insect Detect DIY camera trap system is composed of low-cost off-the-shelf hardware components
1919
([Raspberry Pi Zero 2 W](https://www.raspberrypi.com/products/raspberry-pi-zero-2-w/),
2020
[Luxonis OAK-1](https://docs.luxonis.com/hardware/products/OAK-1),
21-
[Witty Pi 4 L3V7](https://www.uugear.com/product/witty-pi-4-l3v7/) or
22-
[PiJuice Zero pHAT](https://uk.pi-supply.com/products/pijuice-zero)), combined with
21+
[Witty Pi 4 L3V7](https://www.uugear.com/product/witty-pi-4-l3v7/)), combined with
2322
open source software and can be easily assembled and set up with the
2423
[provided instructions](https://maxsitt.github.io/insect-detect-docs/).
2524

@@ -45,7 +44,7 @@ some standard tools are necessary, which are listed in the Hardware
4544
## Software setup
4645

4746
In the [**Software**](https://maxsitt.github.io/insect-detect-docs/software/)
48-
section of the documentaton website, all steps to get the camera trap up and
47+
section of the documentation website, all steps to get the camera trap up and
4948
running are explained. You will start with installing the necessary software
5049
to your [local PC](https://maxsitt.github.io/insect-detect-docs/software/localsetup/),
5150
to communicate with the Raspberry Pi Zero 2 W. The next steps will guide you
@@ -60,6 +59,11 @@ scripts and how to run them can be found in
6059

6160
## Model training
6261

62+
> [!WARNING]
63+
> Detection model training is currently being refactored and will be updated soon.
64+
> YOLO detection models trained with the previous approach are not supported anymore
65+
> after insect-detect v2.0.0.
66+
6367
The **Model Training** section will show you tools to
6468
[annotate](https://maxsitt.github.io/insect-detect-docs/modeltraining/annotation/)
6569
your own images and use these to train your custom YOLOv5, YOLOv6, YOLOv7 or YOLOv8
-513 KB
Binary file not shown.

docs/modeltraining/train_detection.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Object detection model training
22

3+
!!! warning "Deprecation notice"
4+
5+
Detection model training is currently being refactored and will be updated soon.
6+
YOLO detection models trained with the previous approach are not supported anymore
7+
after insect-detect v2.0.0.
8+
39
[YOLO](https://pjreddie.com/darknet/yolo/){target=_blank} (You Only Look Once)
410
([Redmon et al., 2016](https://doi.org/10.48550/arXiv.1506.02640){target=_blank})
511
is the first object detection model which combines object detection (bounding
238 KB
Loading
Binary file not shown.
-98.4 KB
Binary file not shown.
-25.5 KB
Binary file not shown.
198 KB
Loading
192 KB
Loading

0 commit comments

Comments
 (0)