Skip to content

Commit 442d931

Browse files
author
AdamMiltonBarker
committed
Resolves #4 Integrate CII Best Practices
1 parent 422cb3f commit 442d931

File tree

1 file changed

+90
-2
lines changed

1 file changed

+90
-2
lines changed

README.md

Lines changed: 90 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,90 @@
1-
# ALL-Arduino-Nano-33-BLE-Sense-Classifier
2-
An Acute Lymphoblastic Leukemia classifier experiment using the Arduino Nano 33 BLE Sense Classifier.
1+
# Peter Moss Acute Myeloid & Lymphoblastic Leukemia AI Research Project
2+
## Acute Lymphoblastic Leukemia Arduino Nano 33 BLE Sense Classifier
3+
4+
![Acute Lymphoblastic Leukemia Arduino Nano 33 BLE Sense Classifier](assets/images/project-banner.jpg)
5+
6+
[![CURRENT RELEASE](https://img.shields.io/badge/CURRENT%20RELEASE-0.1.0-blue.svg)](https://github.com/AMLResearchProject/ALL-Arduino-Nano-33-BLE-Sense-Classifier/tree/0.1.0) [![UPCOMING RELEASE](https://img.shields.io/badge/CURRENT%20DEV%20BRANCH-1.0.0-blue.svg)](https://github.com/AMLResearchProject/ALL-Arduino-Nano-33-BLE-Sense-Classifier/tree/1.0.0) [![Contributions Welcome!](https://img.shields.io/badge/Contributions-Welcome-lightgrey.svg)](CONTRIBUTING.md) [![Issues](https://img.shields.io/badge/Issues-Welcome-lightgrey.svg)](issues) [![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/) [![Documentation Status](https://readthedocs.org/projects/all-arduino-nano-33-ble-sense-classifier/badge/?version=latest)](https://all-arduino-nano-33-ble-sense-classifier.readthedocs.io/en/latest/?badge=latest) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5065/badge)](https://bestpractices.coreinfrastructure.org/projects/5065)
7+
8+
[![LICENSE](https://img.shields.io/badge/LICENSE-MIT-blue.svg)](LICENSE)
9+
10+
 
11+
12+
# Table Of Contents
13+
14+
- [Introduction](#introduction)
15+
- [DISCLAIMER](#disclaimer)
16+
- [Motivation](#motivation)
17+
- [Acute Lymphoblastic Leukemia](#acute-lymphoblastic-leukemia)
18+
- [ALL IDB](#all-idb)
19+
- [Segmentation](#segmentation)
20+
- [Getting Started](#getting-started)
21+
- [Contributing](#contributing)
22+
- [Contributors](#contributors)
23+
- [Versioning](#versioning)
24+
- [License](#license)
25+
- [Bugs/Issues](#bugs-issues)
26+
27+
 
28+
29+
# Introduction
30+
31+
The **Acute Lypmhoblastic Leukemia Arduino Nano 33 BLE Sense Classifier** is an experiment to explore how low powered microcontrollers, specifically the Arduino Nano 33 BLE Sense, can be used to detect Acute Lymphoblastic Leukemia. The Arduino Nano 33 BLE Sense is the latest Arduino Board which supports Tensorflow Lite, allowing machine learning on Arduino.
32+
33+
 
34+
35+
# DISCLAIMER
36+
37+
_This project should be used for research purposes only. The purpose of the project is to show the potential of Artificial Intelligence for medical support systems such as diagnostic systems._
38+
39+
_Although the model is accurate and shows good results both on paper and in real world testing, it is trained on a small amount of data and needs to be trained on larger datasets to really evaluate it's accuracy._
40+
41+
_Developers that have contributed to this repository have experience in using Artificial Intelligence for detecting certain types of cancer. They are not doctors, medical or cancer experts._
42+
43+
 
44+
45+
# Motivation
46+
47+
The motivation for this project was to explore how low powered devices such as Arduino can be used to detect Acute Lymphoblastic Leukemia. The project will be submitted to the Tensorflow For Microcontroller Challenge and the Eyes on Edge: tinyML Vision Challenge.
48+
49+
 
50+
51+
# Acute Lymphoblastic Leukemia
52+
[Acute lymphoblastic leukemia (ALL)](https://www.leukemiaairesearch.com/research/leukemia), also known as Acute Lymphocytic Leukemia, is a cancer that affects the lymphoid blood cell lineage. It is the most common leukemia in children, and it accounts for 10-20% of acute leukemias in adults. The prognosis for both adult and especially childhood ALL has improved substantially since the 1970s. The 5- year survival is approximately 95% in children. In adults, the 5-year survival varies between 25% and 75%, with more favorable results in younger than in older patients.
53+
54+
For more information about Acute Lymphoblastic Leukemia please visit our [Leukemia Information Page](https://www.leukemiaairesearch.com/research/leukemia)
55+
56+
 
57+
58+
# ALL-IDB
59+
You need to be granted access to use the Acute Lymphoblastic Leukemia Image Database for Image Processing dataset. You can find the application form and information about getting access to the dataset on [this page](https://homes.di.unimi.it/scotti/all/#download) as well as information on how to contribute back to the project [here](https://homes.di.unimi.it/scotti/all/results.php). If you are not able to obtain a copy of the dataset please feel free to try this tutorial on your own dataset, we would be very happy to find additional AML & ALL datasets.
60+
61+
 
62+
63+
# Getting Started
64+
65+
To get started follow the [getting started guide](docs/getting-started.md) to find out how to fork the repository.
66+
67+
 
68+
69+
# Contributing
70+
Asociación de Investigacion en Inteligencia Artificial Para la Leucemia Peter Moss encourages and welcomes code contributions, bug fixes and enhancements from the Github community.
71+
72+
Please read the [CONTRIBUTING](CONTRIBUTING.md "CONTRIBUTING") document for a full guide to forking our repositories and submitting your pull requests. You will also find our code of conduct in the [Code of Conduct](CODE-OF-CONDUCT.md) document.
73+
74+
## Contributors
75+
- [Adam Milton-Barker](https://www.leukemiaairesearch.com/association/volunteers/adam-milton-barker "Adam Milton-Barker") - [Asociación de Investigacion en Inteligencia Artificial Para la Leucemia Peter Moss](https://www.leukemiaresearchassociation.ai "Asociación de Investigacion en Inteligencia Artificial Para la Leucemia Peter Moss") President/Founder & Lead Developer, Sabadell, Spain
76+
77+
 
78+
79+
# Versioning
80+
We use [SemVer](https://semver.org/) for versioning.
81+
82+
 
83+
84+
# License
85+
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE "LICENSE") file for details.
86+
87+
 
88+
89+
# Bugs/Issues
90+
We use the [repo issues](issues "repo issues") to track bugs and general requests related to using this project. See [CONTRIBUTING](CONTRIBUTING.md "CONTRIBUTING") for more info on how to submit bugs, feature requests and proposals.

0 commit comments

Comments
 (0)