Update ReadMe (#85)
Closes: #83 First draft of a new ALVINN specific readme file. Reviewed-on: Georgi_Lab/ALVINN_f7#85
This commit is contained in:
120
README.md
120
README.md
@@ -1,101 +1,31 @@
|
||||
# ALVINN
|
||||
|
||||
## Framework7 CLI Options
|
||||
Anatomy Lab Visual Identification Neural Net (A.L.V.I.N.N) is a f7 based app for using a computer vision neural net model to identify anatomical structures in photographic imagery.
|
||||
|
||||
Framework7 app created with following options:
|
||||
## Install
|
||||
* **Android:** Download the latest Android apk in [packages](https://gitea.azgeorgis.net/Georgi_Lab/ALVINN_f7/packages) and open the downloaded file to install.
|
||||
* **iOS:** To do
|
||||
* **Web app:** To do
|
||||
* **Run from source:** Clone this repository and in the root directory run `npm install` followed by `npm start`. For more information see [f7 info](f7_info.md).
|
||||
|
||||
```
|
||||
{
|
||||
"cwd": "/home/mserver/ALVINN/ALVINN_f7",
|
||||
"type": [
|
||||
"web",
|
||||
"pwa",
|
||||
"cordova"
|
||||
],
|
||||
"name": "ALVINN",
|
||||
"pkg": "edu.midwestern.alvinn",
|
||||
"framework": "vue",
|
||||
"template": "single-view",
|
||||
"cssPreProcessor": false,
|
||||
"bundler": "vite",
|
||||
"cordova": {
|
||||
"folder": "cordova",
|
||||
"platforms": [
|
||||
"ios",
|
||||
"android"
|
||||
],
|
||||
"plugins": [
|
||||
"cordova-plugin-statusbar",
|
||||
"cordova-plugin-keyboard",
|
||||
"cordova-plugin-splashscreen"
|
||||
]
|
||||
},
|
||||
"theming": {
|
||||
"customColor": true,
|
||||
"color": "#002f65",
|
||||
"darkMode": false,
|
||||
"iconFonts": true
|
||||
},
|
||||
"customBuild": false
|
||||
}
|
||||
```
|
||||
## Quick Start
|
||||
1. From the main screen of the app, select the menu icon in the upper left corner and go to `Settings`.
|
||||
1. Make sure that `Use external server` option is selected and fill in address and port parameters to connect to a back end serving the ALVINN models (Doods2 is the default backend).
|
||||
1. Save the settings and return to the main screen.
|
||||
1. Select the region of the body you want to identify structures from.
|
||||
1. In the region page, click on the camera icon to take a new picture or load a picture from storage. When the picture load, any identifiable structures will be listed as tags below the image.
|
||||
1. Click on each tag to see the structure highlighted in the image.
|
||||
|
||||
## Install Dependencies
|
||||
## Advanced Features
|
||||
### Detection Parameters
|
||||
After an image has been loaded and structure detection has been performed, the detection parameters can be adjusted using the third detection menu button (eye).
|
||||
This button will make three tools available:
|
||||
1. Confidence slider: You can use the slider to change the confidence threshold for identifying structures.
|
||||
The default threshold is 50% confidence.
|
||||
1. Refresh detections: If there has been a permanent change to the structures detections, such as deleting a tag, the detection list can be reset to its original state.
|
||||
1. Structure list: you can view a list of all the structures available for detection in that region and select/deselect individual structures for detection.
|
||||
|
||||
First of all we need to install dependencies, run in terminal
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
## NPM Scripts
|
||||
|
||||
* 🔥 `start` - run development server
|
||||
* 🔧 `dev` - run development server
|
||||
* 🔧 `build` - build web app for production
|
||||
* 📱 `build-cordova` - build cordova app
|
||||
* 📱 `build-cordova-ios` - build cordova iOS app
|
||||
* 📱 `cordova-ios` - run dev build cordova iOS app
|
||||
* 📱 `build-cordova-android` - build cordova Android app
|
||||
* 📱 `cordova-android` - run dev build cordova Android app
|
||||
|
||||
## Vite
|
||||
|
||||
There is a [Vite](https://vitejs.dev) bundler setup. It compiles and bundles all "front-end" resources. You should work only with files located in `/src` folder. Vite config located in `vite.config.js`.
|
||||
|
||||
## PWA
|
||||
|
||||
This is a PWA. Don't forget to check what is inside of your `service-worker.js`. It is also recommended that you disable service worker (or enable "Update on reload") in browser dev tools during development.
|
||||
|
||||
## Cordova
|
||||
|
||||
Cordova project located in `cordova` folder. You shouldn't modify content of `cordova/www` folder. Its content will be correctly generated when you call `npm run cordova-build-prod`.
|
||||
## Assets
|
||||
|
||||
Assets (icons, splash screens) source images located in `assets-src` folder. To generate your own icons and splash screen images, you will need to replace all assets in this directory with your own images (pay attention to image size and format), and run the following command in the project directory:
|
||||
|
||||
```
|
||||
framework7 assets
|
||||
```
|
||||
|
||||
Or launch UI where you will be able to change icons and splash screens:
|
||||
|
||||
```
|
||||
framework7 assets --ui
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Documentation & Resources
|
||||
|
||||
* [Framework7 Core Documentation](https://framework7.io/docs/)
|
||||
* [Framework7 Vue Documentation](https://framework7.io/vue/)
|
||||
|
||||
|
||||
* [Framework7 Icons Reference](https://framework7.io/icons/)
|
||||
* [Community Forum](https://forum.framework7.io)
|
||||
|
||||
## Support Framework7
|
||||
|
||||
Love Framework7? Support project by donating or pledging on:
|
||||
- Patreon: https://patreon.com/framework7
|
||||
- OpenCollective: https://opencollective.com/framework7
|
||||
### Submitting Images
|
||||
If all of the detection tags that are currently visible have been viewed, then the final button (cloud upload) on the detection menu will be enabled.
|
||||
This button will cause the image and the verified structures to be uploaded to the ALVINN project servers where that data will be available for further training of the neural net.
|
||||
If after the image has been uploaded, the available detection tags change, then the option to re-upload the image will be available if all the new tags have been viewed and verified.
|
||||
101
f7_info.md
Normal file
101
f7_info.md
Normal file
@@ -0,0 +1,101 @@
|
||||
# ALVINN
|
||||
|
||||
## Framework7 CLI Options
|
||||
|
||||
Framework7 app created with following options:
|
||||
|
||||
```
|
||||
{
|
||||
"cwd": "/home/mserver/ALVINN/ALVINN_f7",
|
||||
"type": [
|
||||
"web",
|
||||
"pwa",
|
||||
"cordova"
|
||||
],
|
||||
"name": "ALVINN",
|
||||
"pkg": "edu.midwestern.alvinn",
|
||||
"framework": "vue",
|
||||
"template": "single-view",
|
||||
"cssPreProcessor": false,
|
||||
"bundler": "vite",
|
||||
"cordova": {
|
||||
"folder": "cordova",
|
||||
"platforms": [
|
||||
"ios",
|
||||
"android"
|
||||
],
|
||||
"plugins": [
|
||||
"cordova-plugin-statusbar",
|
||||
"cordova-plugin-keyboard",
|
||||
"cordova-plugin-splashscreen"
|
||||
]
|
||||
},
|
||||
"theming": {
|
||||
"customColor": true,
|
||||
"color": "#002f65",
|
||||
"darkMode": false,
|
||||
"iconFonts": true
|
||||
},
|
||||
"customBuild": false
|
||||
}
|
||||
```
|
||||
|
||||
## Install Dependencies
|
||||
|
||||
First of all we need to install dependencies, run in terminal
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
## NPM Scripts
|
||||
|
||||
* 🔥 `start` - run development server
|
||||
* 🔧 `dev` - run development server
|
||||
* 🔧 `build` - build web app for production
|
||||
* 📱 `build-cordova` - build cordova app
|
||||
* 📱 `build-cordova-ios` - build cordova iOS app
|
||||
* 📱 `cordova-ios` - run dev build cordova iOS app
|
||||
* 📱 `build-cordova-android` - build cordova Android app
|
||||
* 📱 `cordova-android` - run dev build cordova Android app
|
||||
|
||||
## Vite
|
||||
|
||||
There is a [Vite](https://vitejs.dev) bundler setup. It compiles and bundles all "front-end" resources. You should work only with files located in `/src` folder. Vite config located in `vite.config.js`.
|
||||
|
||||
## PWA
|
||||
|
||||
This is a PWA. Don't forget to check what is inside of your `service-worker.js`. It is also recommended that you disable service worker (or enable "Update on reload") in browser dev tools during development.
|
||||
|
||||
## Cordova
|
||||
|
||||
Cordova project located in `cordova` folder. You shouldn't modify content of `cordova/www` folder. Its content will be correctly generated when you call `npm run cordova-build-prod`.
|
||||
## Assets
|
||||
|
||||
Assets (icons, splash screens) source images located in `assets-src` folder. To generate your own icons and splash screen images, you will need to replace all assets in this directory with your own images (pay attention to image size and format), and run the following command in the project directory:
|
||||
|
||||
```
|
||||
framework7 assets
|
||||
```
|
||||
|
||||
Or launch UI where you will be able to change icons and splash screens:
|
||||
|
||||
```
|
||||
framework7 assets --ui
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Documentation & Resources
|
||||
|
||||
* [Framework7 Core Documentation](https://framework7.io/docs/)
|
||||
* [Framework7 Vue Documentation](https://framework7.io/vue/)
|
||||
|
||||
|
||||
* [Framework7 Icons Reference](https://framework7.io/icons/)
|
||||
* [Community Forum](https://forum.framework7.io)
|
||||
|
||||
## Support Framework7
|
||||
|
||||
Love Framework7? Support project by donating or pledging on:
|
||||
- Patreon: https://patreon.com/framework7
|
||||
- OpenCollective: https://opencollective.com/framework7
|
||||
Reference in New Issue
Block a user