Skip to content

Commit b45f000

Browse files
committed
Updated documentation
1 parent fbf8f8d commit b45f000

File tree

5 files changed

+18
-45
lines changed

5 files changed

+18
-45
lines changed

docs/README.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/_data/menu.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
- title: Getting Started
33
subs:
44
- {page_id: getting-started}
5+
- {page_id: tryout}
6+
- {page_id: docker-gap8}
7+
- {page_id: jtag-programming}
58
- title: Test functions
69
subs:
710
- {page_id: test-camera}
@@ -16,7 +19,4 @@
1619
- title: NINA instructions
1720
subs:
1821
- {page_id: nina-flash-instructions}
19-
20-
21-
22-
22+
- {page_id: docker-nina}

docs/ai-examples/gapflow-model-extern.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The GAP*flow* is expressed as Makefiles in the 'common' folder. It uses the NNTo
1111

1212
This project includes a sample based on a simple MNIST graph defined in Keras. It goes from training right through to working code on GAP8 or the same code running on the PC for debugging purposes.
1313

14-
In train_model.mk the accuracy of a neural network can be increased by setting the epochs of the training.
14+
In train_model.mk the accuracy of a neural network can be increased by setting the epochs of the training.
1515

1616
* It first trains the network using keras
1717
* It then exports the network to H5 format

docs/getting-started/getting-started.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ page_id: getting-started
55

66
## About
77
### AI-deck
8-
The AI-deck enables low power on-board artificial intelligence capabilities for the Crazyflie using a GAP8 chip with RISC-V multi-core architecture, 512 Mbit HyperFlash and 64 Mbit HyperRAM. In addition, the deck has a Himax HM01B0 Bayer RGB camera with a NINA W102 Wi-Fi module to stream your images to a desktop. These features fit the prerequisites of a convolutional neural network, but the AI-deck is not limited to the application of CNN's.
8+
The AI-deck enables low power on-board artificial intelligence capabilities for the Crazyflie using a GAP8 chip with RISC-V multi-core architecture, 512 Mbit HyperFlash and 64 Mbit HyperRAM. In addition, the deck has a Himax HM01B0 Bayer RGB camera with a NINA W102 Wi-Fi module to stream your images to a desktop. These features fit the prerequisites of a convolutional neural network, but the AI-deck is not limited to the application of CNN's.
99

1010
### For users starting with embedded applications and the Crazyflie
1111
For this example a basic understanding of how to:
1212
* Program in Python and C
1313
* Use Linux systems
14-
* Use Makefiles
14+
* Use Makefiles
1515
* Some basic knowledge about embedded programming
1616

1717
### Required hardware
1818
* A JTAG debugger (we used a Olimex ARM-USB-TINY-H JTAG)
19-
* ARM JTAG 20 to 10 pin adapter
19+
* ARM JTAG 20 to 10 pin adapter
2020
* CrazyFlie 2.1
2121
* AI-Deck
2222

@@ -26,7 +26,7 @@ For this example a basic understanding of how to:
2626
2727
To setup the SDK natively on your machine, then first set up the GAP8 SDK using the instruction on this repository:
2828

29-
https://github.com/GreenWaves-Technologies/gap_sdk.
29+
https://github.com/GreenWaves-Technologies/gap_sdk.
3030

3131
When installing the gap sdk (3.8.1), make sure that you have installed everything:
3232

@@ -42,23 +42,23 @@ To start out, first write this in the terminal:
4242

4343

4444
## Workflow using GAPFlow
45-
To design a neural network and deploy it on the AI-deck, you should know the workflow of the GAP8 SDK for AI applications that is provided by GreenWaves Technologies. A neural network can be designed, trained, and evaluated using Tensorflow and Keras in Python. To let this code be able to run on the AI deck, an automated process is executed by the GAPFlow of the GAP8 SDK.
45+
To design a neural network and deploy it on the AI-deck, you should know the workflow of the GAP8 SDK for AI applications that is provided by GreenWaves Technologies. A neural network can be designed, trained, and evaluated using Tensorflow and Keras in Python. To let this code be able to run on the AI deck, an automated process is executed by the GAPFlow of the GAP8 SDK.
4646

4747
What you should provide in this workflow is:
4848
* dataset with labels
4949
* neural network model
5050
* GAP application code
5151
* optional: own autotiler operator
5252

53-
Check out the [gapflow](../ai-examples/gap-flow) explanation in the ai-example folder
53+
Check out the [GAPflow Model Extern](../ai-examples/gapflow-model-extern.md) explanation in the ai-example folder
5454

5555
### Tensorflow and Keras use
5656
Keras is a framework within Tensorflow. In addition to providing a neural network framework, it also provides examples of common and simple neural networks and provides datasets along with it. Though when you want to make an application you might want to use other datasets that are relevant for your application. For this, you have to supply your own dataset with labels, augmentation and transformations when required.
5757

5858
https://keras.io/datasets/
5959

6060
### NNTool use
61-
<!-- In this example the NNTool state file can be found in example/model/nntool_script special attention to the following command/rule
61+
<!-- In this example the NNTool state file can be found in example/model/nntool_script special attention to the following command/rule
6262
6363
```aquant -f 8 <image folder>/*.<image extension> -T```
6464
@@ -77,5 +77,3 @@ The Autotiler supports basic operators needed for a convolutional neural network
7777
https://greenwaves-technologies.com/manuals/BUILD/AUTOTILER/html/index.html
7878

7979
<!-- explain a bit more about how the autotiler works -->
80-
81-

docs/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Home
3+
page_id: home
4+
---
5+
6+
This repository contains examples for the AI-deck of the crazyflie and is maintained by bitcraze.c. These repositories rely on the gap_sdk of greenwave technologies.

0 commit comments

Comments
 (0)