-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
iamwatchdogs
committed
Apr 21, 2024
1 parent
2a13a1f
commit 5c6ee26
Showing
1 changed file
with
120 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,120 @@ | ||
| # Glaucoma-Detection-using-Transfer-Learning | ||
| # Glaucoma-Detection-using-Transfer-Learning | ||
|
|
||
| <br> | ||
| <div align="center"> | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| <br> | ||
|
|
||
| [](https://github.com/iamwatchdogs?tab=repositories&q=&type=public&language=&sort=) | ||
| [](https://github.com/iamwatchdogs/Glaucoma-Detection-using-Transfer-Learning/pulls) | ||
| [](https://github.com/iamwatchdogs/Glaucoma-Detection-using-Transfer-Learning/issues) | ||
| [](https://github.com/iamwatchdogs/Glaucoma-Detection-using-Transfer-Learning.js/pulls?q=is%3Amerged) | ||
| [](https://GitHub.com/iamwatchdogs/Glaucoma-Detection-using-Transfer-Learning/releases/) | ||
| [](./LICENSE) | ||
|
|
||
| </div> | ||
| <br> | ||
|
|
||
| ## About Project: | ||
|
|
||
| The Glaucoma-Detection-using-Transfer-Learning _A.K.A_ GlaucoDetect is a full stack project with Machine Learning at its core. This project aims to help people get a report about the condition of their eyes and the possibility of having glaucoma eye disease. The ML model is trained using the concepts of transfer learning techniques _(where we use the pre-trained models to extract the features to help us train the model without worrying about overfitting comparatively smaller datasets)_. The core tech stack used to build this project is Python, JavaScript and its libraries and framework. The frontend is built using the React library and the backend is built using the Flask framework. | ||
|
|
||
| ## Setting up the project | ||
|
|
||
| There are two parts of the project, one which contains the algorithm used to train the model and the other uses the exported model as a part of the backend in the web application to interact with end users. But here some common parts which you can get started with... | ||
|
|
||
| - Make sure you have [git](https://git-scm.com/ "download git"), [python](https://www.python.org/ "download python"), any conda environment _(i.e., [miniconda](https://docs.anaconda.com/free/miniconda/index.html "download miniconda") or [anaconda](https://www.anaconda.com/anaconda-navigator "download anaconda navigator"))_ and [node.js](https://nodejs.org/en "download node.js") installed within your system. | ||
| - Now [fork the repository](https://github.com/iamwatchdogs/Glaucoma-Detection-using-Transfer-Learning/fork "fork the repo") and clone it to your local machine by using the following command. | ||
| ```bash | ||
| git clone https://github.com/<your-username>/Glaucoma-Detection-using-Transfer-Learning.git | ||
| ``` | ||
| - Open the cloned directory and set up the conda environments using the `enviroment.yml` _(more details down below)_ and download the required `node_modules` using node _(more details down below)_. | ||
|
|
||
| ### For ML training | ||
|
|
||
| All the ML model-related files including the **dataset** and **exported model** are present within the [`model`](model/) directory of the project. To set up Jupyter Notebook, you either have to use [Google Colab](https://colab.research.google.com/ "open Google Colab") or your local system. | ||
|
|
||
| - If you want to use it through Google Colab, you can just download the Jupyter Notebook present within the `model` directory named [glaucoma-detection-using-transfer-learning.ipynb](model/glaucoma-detection-using-transfer-learning.ipynb "goto glaucoma-detection-using-transfer-learning.ipynb") and open it through Google Colab your account. | ||
|
|
||
| > [!NOTE] | ||
| > Please note if you're using Google Colab, please don't use GPU or TPU runtime as train the model from scratch take a lots of time and compute power which might exhaust your daily limit thus leading to termination of your runtime and all the progress that your model made. | ||
| - If you wish to proceed with your local system, you can just open it up using the Jupyter Notebook that comes along with the complete installation of the **Anaconda** environment. | ||
| - If you're using the **Miniconda** instead of the complete **Anaconda** environment, you can make use of the exported [environment.yml](model/environment.yml) configuration to set up the same environment that I used to train the model. You can use the following command to set up the environment within your system: | ||
| ```bash | ||
| # setup the environment using conda within your system. | ||
| conda env create -f model/environment.yml | ||
|
|
||
| # activate your the environment to train the model. | ||
| conda activate glaucoma-detection | ||
| ``` | ||
|
|
||
| > [!TIP] | ||
| > - If you're using VSCode to open and train the model within the jupyter notebook, make sure to select the interpret using `ctrl` + `shift` + `p` (or) `cmd` + `shif` + `p`, then type "select python interpreter" and then select the python interpreter from `glaucoma-detection` miniconda environment. | ||
| > - Do the same while selecting the runtime environment for the jupyter notebook too. | ||
| ### For Web Application | ||
|
|
||
| The files related to the web application are located within the root of the project directory. For setting up this project you're going to need **node.js** and **python** _(miniconda is recommended)_. | ||
|
|
||
| - You can start initializing the react application using the following command: | ||
| ```node | ||
| npm install | ||
| ``` | ||
| - As for the backend, you can set up the miniconda environment using the `environment.yml` file present within the `server` directory. | ||
| ```bash | ||
| # setup the environment using conda within your system. | ||
| conda env create -f server/environment.yml | ||
|
|
||
| # activate your the environment to host the server. | ||
| conda activate glaucoma-detection-server | ||
| ``` | ||
| - If you're not using miniconda environment, then you still install dependencies using the `pip` package manager _(which is not recommended)_. It's recommended to have some kind of virtual environment like miniconda but you can still use other virtual environments like `pipenv` or `virtualenv`. Here are the required dependencies for setting up virtual dependencies. | ||
| ``` | ||
| numpy=1.23.5 | ||
| scikit-learn=1.3.0 | ||
| scikit-image=0.22.0 | ||
| tensorboard=2.12.1 | ||
| flask=2.2.5 | ||
| flask_cors=3.0.10 | ||
| ``` | ||
| - After setting up the required environment, you can run up the servers for both the React app and Flask applications you can use the following commands: | ||
| ```bash | ||
| # Run the server for react app | ||
| npm run dev | ||
|
|
||
| # In a new terminal, run the flask server | ||
| python server/server.py | ||
| ``` | ||
|
|
||
| # Contributing | ||
|
|
||
| I welcome anyone who finds my project interesting and willing to contribute to this project. Please make sure to set up the project with your system and try it out at least once, even before you start contributing to the project. If you face any kind of issue while setting up the project within your system, you can raise a ticket by creating a new discussion within the [discussion section](https://github.com/iamwatchdogs/Glaucoma-Detection-using-Transfer-Learning/discussions "goto discussion section") of the repo. | ||
|
|
||
| >[!IMPORTANT] | ||
| > - Please create a new issue in the [issue section](https://github.com/iamwatchdogs/Glaucoma-Detection-using-Transfer-Learning/issues "goto issue section") and get assigned even before you start contributing to the project. By this way you can let others know that you're out of a feature/bug which was already recorded, this helping us maintain the project better. | ||
| > - This is the reason, why any PR made without a issue tag will be rejected and closed unless or until there a new issue has been created and linked with the respective issue. | ||
| ## Output | ||
|
|
||
| <div align="center"> | ||
|
|
||
| <img width="1680" alt="image" src="https://github.com/iamwatchdogs/Glaucoma-Detection-using-Transfer-Learning/assets/49478000/3c00d285-7dd7-486b-8eb2-1fb35758e102"> | ||
|
|
||
| </div> |