From d40e947494cf6fbcb83eabee1b072760954fe9ac Mon Sep 17 00:00:00 2001 From: Aydin <108932477+Aydinhamedi@users.noreply.github.com> Date: Thu, 25 Apr 2024 23:09:49 +0330 Subject: [PATCH 1/2] new file: CITATION.cff modified: README.md modified: README.md --- CITATION.cff | 10 ++++++++++ README.md | 33 +++++++++++++++++++++------------ 2 files changed, 31 insertions(+), 12 deletions(-) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..374b3c3 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,10 @@ +cff-version: 1.2.0 +title: PyTorch-Project-Template +message: "A Simple Template For A PyTorch Classification Project \U0001F604" +type: software +authors: + - email: aydin.hamediasl@gmail.com + given-names: Aydin + family-names: Hamedi +repository-code: 'https://github.com/Aydinhamedi/PyTorch-Project-Template' +license: MIT diff --git a/README.md b/README.md index d95b779..64ee6a9 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ > The code that had achieved the highest acc is `backup/V6/Model_T&T.ipynb`.\ > And the codes with the light and super light models are `backup/V7/Model_T&T.ipynb`, `backup/V8/Model_T&T.ipynb`. -## Usage +## πŸš€ Usage > [!TIP] > If you just want the model go to the Github Releases. @@ -50,18 +50,18 @@ Interface\GUI ### Example Image of the GUI (V0.8.9.6) ‡ ![Example](doc/Other/GUI_V0.8.9.6.png) -## Release +## πŸ“¦ Release > ### Newest release πŸ“ƒ > #### [Go to newest release](https://github.com/Aydinhamedi/Pneumonia-Detection-Ai/releases/latest) -## Training System Specifications +## πŸ“œ Training System Specifications - **Graphics Card (GPU)**: RTX 3090 - **Memory (RAM)**: 64GB - **Operating System (OS)**: Windows 11 Pro - **Processor (CPU)**: Intel Core i7-12700KF -## Model +## πŸ“œ Model The model is a Convolutional Neural Network (CNN) trained on a dataset of 23681 X-ray images. The dataset is a combination of the following: @@ -78,7 +78,7 @@ This combined dataset provides a comprehensive set of images for training the mo | V7 light | efficientnet-b4 | 29.7M | 97.12% | βœ… | ⚠️ | | V8 Super light | efficientnet-b0 | 4.8M | 96.47% | βœ… | ❌ | -## Training Methods +## πŸ§ͺ Training Methods ### The AI model supports two distinct training approaches: - rev1: A straightforward method using Keras fit function for basic training. @@ -95,20 +95,20 @@ This combined dataset provides a comprehensive set of images for training the mo - Robustness Enhancement: Introduces random noise to training images to strengthen model robustness against unseen data. - While rev1 is suitable for quick and simple model training, rev2 is tailored for those seeking a more sophisticated and potentially more effective training regimen. -## Repository Structure +## πŸ“ Repository Structure Please note that due to the large size of some files and folders, they are not available directly in the repository. However, they can be found in the [Releases](https://github.com/Aydinhamedi/Pneumonia-Detection-Ai/releases) page of the repository. This includes the model weights and the database, which are crucial for the functioning of the AI model. -## Contribution +## 🀝 Contribution Any contributions to improve the project are welcome. You can submit a pull request or open an issue on GitHub. Please make sure to test your changes thoroughly before submitting. We appreciate your help in making this project better. -## WARNING +## ⚠️ WARNING > [!CAUTION] The model provided in this project should not be used for medical diagnosis without further validation. While the model has shown high accuracy in detecting pneumonia from X-ray images, it is not a substitute for professional medical advice. Please consult with a healthcare professional for medical advice. -## Other +## πŸ“‚ Other > [!NOTE] > Please note that this code uses my: > - Python-CLI-template @@ -118,7 +118,7 @@ The model provided in this project should not be used for medical diagnosis with > - Python-color-print > - for more info go to https://github.com/Aydinhamedi/Python-color-print. -## Results +## πŸ“ƒ Results > [!WARNING] > Results were achieved using Rev2 training method and Rev1.2 model and @@ -126,13 +126,13 @@ The model provided in this project should not be used for medical diagnosis with ### Acc: ![img_](doc/V6/D1.png) -### Grad cam: +### πŸ“· Grad cam: | Model | Grad-cam Ex | |----------|----------| | V6 | ![img_](doc/V6+/D1.png)![img_](doc/V6+/D2.png)![img_](doc/V6+/D3.png)| | V7 light | 🚧None🚧| | V8 super light | 🚧None🚧| -### Other: +### 🚧 Other: ![img_](doc/V6/D4.png) +## πŸ“š Citing +```bib +@software{Hamedi_PyTorch-Project-Template, +author = {Aydin Hamedi}, +license = {MIT}, +title = {PyTorch-Project-Template}, +url = {https://github.com/Aydinhamedi/PyTorch-Project-Template} +} +``` ## License From a1004ae2da20189a5bd9f6e730a1ec3dd2da5651 Mon Sep 17 00:00:00 2001 From: Aydin <108932477+Aydinhamedi@users.noreply.github.com> Date: Thu, 25 Apr 2024 23:09:56 +0330 Subject: [PATCH 2/2] modified: README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 64ee6a9..bae059a 100644 --- a/README.md +++ b/README.md @@ -147,11 +147,11 @@ The model provided in this project should not be used for medical diagnosis with ## πŸ“š Citing ```bib -@software{Hamedi_PyTorch-Project-Template, +@software{Hamedi_Pneumonia-Detection-Ai, author = {Aydin Hamedi}, license = {MIT}, -title = {PyTorch-Project-Template}, -url = {https://github.com/Aydinhamedi/PyTorch-Project-Template} +title = {Pneumonia-Detection-Ai}, +url = {https://github.com/Aydinhamedi/Pneumonia-Detection-Ai} } ```