Skip to content

Commit b749e9a

Browse files
committed
paper: Update notes
1 parent 1c67e14 commit b749e9a

2 files changed

Lines changed: 9 additions & 108 deletions

File tree

paper/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11

22
# emlearn-micropython JOSS paper
33

4-
## Example
4+
## Building PDF from paper
5+
6+
How to build the paper locally. Requires Docker.
7+
8+
```
9+
docker run --rm --volume $PWD/paper:/data --user $(id -u):$(id -g) --env JOURNAL=joss openjournals/inara
10+
```
11+
12+
## Runnable example
513

614
There is a plot in the paper,
715
that demonstrates using emlearn_fft and emlearn_trees from emlearn-micropython

paper/notes.md

Lines changed: 0 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -1,116 +1,9 @@
11

2-
# Howto
3-
4-
## Building PDF from paper
5-
6-
docker run --rm --volume $PWD/paper:/data --user $(id -u):$(id -g) --env JOURNAL=joss openjournals/inara
7-
82
# TODO
93

104
Non-critical
115

126
- Add linreg to the API reference
13-
- Fixup hardware support page. armv6m now should work?
147
- Add a documentation page about the wider MicroPython Data Science ecosystem?
158
- Donate another 100 USD to JOSS
169

17-
# Process
18-
19-
+ Write the paper
20-
+ Submit
21-
+ Respond to review comments
22-
23-
https://joss.readthedocs.io/en/latest/submitting.html
24-
25-
## Usage example
26-
27-
Ideally show 2 modules?
28-
Can be in a composite example.
29-
30-
For plot would need to output data. npyfile?
31-
Point out that the same code runs on microcontroller (such as ESP32, RP2350, STM32 etc)
32-
33-
# Paper
34-
35-
WIP in joss-paper branch of emlearn-micropython
36-
37-
## Examples
38-
https://joss.readthedocs.io/en/latest/example_paper.html
39-
40-
## Outline
41-
Should be 250-1000 words.
42-
Scope. 2-3 pages, plus references
43-
44-
- Summary. 1-3 paragraphs. Max 1/2 page
45-
- Statement of need. Up to 1/2 page
46-
- Package contents. Table of the modules?
47-
- Usage example. Short but illustrative. One attractive plot
48-
- References
49-
50-
## What they ask for
51-
52-
53-
A list of the authors of the software and their affiliations, using the correct format (see the example below).
54-
55-
A summary describing the high-level functionality and purpose of the software for a diverse, non-specialist audience.
56-
57-
A Statement of need section that clearly illustrates the research purpose of the software and places it in the context of related work.
58-
59-
A list of key references, including to other software addressing related needs. Note that the references should include full names of venues, e.g., journals and conferences, not abbreviations only understood in the context of a specific discipline.
60-
61-
Mention (if applicable) a representative set of past or ongoing research projects using the software and recent scholarly publications enabled by it.
62-
63-
Acknowledgement of any financial support.
64-
s
65-
66-
## Focus
67-
+ Make it clear that it is relevant *for research* (eg in TinyML applications)
68-
+ Make it likely that it will be cited.
69-
70-
# Related softwares
71-
72-
Things to cite
73-
74-
emlearn, TinyMaix
75-
scikit-learn, keras, tensorflow / tf lite micro. numpy? scipy?
76-
77-
Alternatives
78-
ulab, OpenMV.
79-
Generating Python code. Using m2cgen, etc
80-
81-
For the implemented methods, the original papers
82-
83-
# Suggesting substantial scholarly effort
84-
85-
makes addressing research challenges significantly better (e.g., faster, easier, simpler).
86-
87-
emlearn-micropython makes research in Machine Learning for embedded systems easier.
88-
This can both be applied research, and application oriented. Data collection and prototyping
89-
Along with research in methods. By providing an example approach for developing ML methods for deployment on microcontrollers with MicroPython
90-
91-
92-
# Suggesting citability
93-
Already have one citation,
94-
https://www.sciencedirect.com/science/article/pii/S2352711024001493
95-
96-
These papers identify a need for MicroPython to improve performance on numeric workloads
97-
https://www.mdpi.com/2079-9292/12/1/143
98-
https://ieeexplore.ieee.org/abstract/document/9292199/
99-
https://link.springer.com/chapter/10.1007/978-3-030-43364-2_4
100-
101-
Real-Time Human Activity Recognition on Embedded Equipment: A Comparative Study
102-
The C implementation on ESP32 still has a shorter processing time (0.0022 s) compared to MicroPython on ESP32 (0.15 s).
103-
104-
105-
OpenMV
106-
https://arxiv.org/abs/1711.10464
107-
108-
Example research targeting TinyML+MicroPython
109-
Could benefit from emlearn-micropython
110-
https://www.mdpi.com/1424-8220/23/4/2344 (used ulab)
111-
https://ieeexplore.ieee.org/abstract/document/8656727
112-
https://elifesciences.org/articles/67846
113-
https://www.sciencedirect.com/science/article/pii/S2772375523000138
114-
115-
116-

0 commit comments

Comments
 (0)