Documentation Plan
Users Documentation
The primary users of our project will be anyone in the healthcare and education industries such as doctors, nurses, researchers, students e.t.c. The plan for all these users however, will remain the same. A brief video will be provided which will specify basic usage of the app from uploading a file to getting the results that are displayed. This video will goo over running the notebook files to get the results. Any other requirements such as file types and sizes which may be uploaded will also be specified.
Administrator Documentation
Administrators will be provided with a readme document along with the code which will describe the setup process with all the needed dependencies and packages to install, any data needed to be downloaded and general instructions on how to run the program. Information about deployment and the model will also be provided such as what sort of data it was trained on. No logins will be needed for the app currently to allow for future integration such as with mobile apps.
Handoff Plan
A private github repository link will be sent to the client. A link to the notebook file where all necessary dependencies and all the code to produce a result with the model will be provided to the client as well. Instructions to run the code locally will also be provided below which can be done with a flask server, though the client does not require the flask app given that they just require the model. The notebook file is the main requirement with the model and instruction on how to use this are inclueded in our video. The notebook files will allow for future development and integration with other platforms such as mobile apps since the code will be easily integratabtle. Based on the current model there are no costs associated with use of the product however the model can be retrained with a better GPU and more data.
Instructions to run locally on Flask:
- Clone repository locally(Github Desktop or ‘git clone’ command can be used)
- Install dependencies according to the readme document
- Run the Flask application by running the command python app.py in the terminal of your code editor after going to the directory with the app file
- Access the Flask application. Once the Flask application is running, you can access it by opening a web browser and navigating to http://127.0.0.1:5000 or http://localhost:5000. Flask applications typically run on port 5000 by default. You should be able to interact with the Flask application in your web browser.