smaranjitghose/img_ai_app_boilerplate

An image classification app boilerplate to serve your deep learning models asap!

🛠 Primary Tech Stack

Programming Languages

Data Analysis

Machine Learning

Backend Development

DevOPs

Cloud Hosting

MLOPs

Databases

Frontend Development

⚡Areas of Interest

🌟 Synthesizing scripts to make development work flow easier

🌟 Crafting minimalistic Web and Desktop Applications to simplify daily mundane tasks

🌟 Composing and Contributing to open source applications for a community centered and transparent tech ecosystem

🌟 Investigating amusing insights by data analysis across various formats of data such as images,text,geospatial,medical records,pds,etc

🌟 Building tech communities and advocating for products for the future!

🌟 Forging Efficient APIs to enable clients translate their idea into a MVP

🌟 Mentoring young and inquisitive minds to explore their path in tech

🌟 Machine Learning and it's applications across multiple industries such as:

• Healthcare
• Climate Change and Environmental Sciences
• Fitness
• Sports
• Advertising
• And many more!

🌟 Playing with Computer Vision

🌟 Natural Language Process

🌟 Handling MLOPs for machine learning projects meant for collaboration

🌟 Working on Cloud Deployment of ML Applications to enable them scale and be at the fingertips of customers

img_ai_app_boilerplate's Issues

Should I add contributing.md to it

I can't see any contributing.md so Should I make that

There is no issue template of this project "

Let me know if you want to add

Adding support for Gluon Models 🤖🛒

• Rename the function our_image_classifier to img_class_tf in the image_classifier.py file
• Write another function img_class_torch and define to load an image, convert it to the necessary numpy array (or any form you deem necessary, load a gluon model ( giving the PR, test it with any custom trained model and attach the video clip of the working demo), run inference and return the result.
• Note how the labels are defined.
• Feel free to add try-except statements for better debugging

Technical Documentation Website

Requirements:

• Home Page:
  • Information about Project
  • Open Source :
    - Programs we are a part of: info about SLOP, SWOC,DWOC
    - Contribution Guide
    - Code of Conduct
    - License
  • Team
    - Project Maintainer
    - Project Contributor
• Getting Started:
  - Using this repo as a template on GitHub
  - Getting the source code locally
  - Model Integration
  - Updating Model Files
  - Updating the Image Classifier Script
  - Front End Changes
  - Home Page [ Of the app] -
  - Team Page
  - About Page
  - Firebase and more Pages!
  - Setup Firebase for the project
  - Store Configuration Files to reference Firebase Project
  - Setup Real time database for the project
  - Update the Contact Page
  - Setup Cloud Storage for the project -
  - Update the function to send images -
  - Remove Firebase(If not required)
• Deployment
  - Staging, Commiting and Pushing Changes to GitHub
  - Cloud Services:
  - Heroku
  - Google Cloud Services
  - Amazon Web Services -
  - Microsoft Azure
  - Digital Ocean
  - Linode
  - Python Everywhere

Directions:

• Package to be used: mkdocs
• Template to be followed: Material
• Branch to be pushed: gh-pages [the deploy], master[the docs/ directory inside which the documentation would be present] - Please gitignore everything under site/

References:

• Deploy, Relevant Source Code

NOTE:

• Please only take up the this issue once you are fully comfortable with using and hosting docs with mkdocs.
• This issue is not be done all at once but in various parts. Whenever you comment interested, just specify which part of the documentation you want to build
• If the information for the part is not available, please wait for it be available (like Guide for Digital Ocean), this issue has be worked upon in parallel with the others. Only take up tasks for which the information is updated
• The source code to a similar documentation is already given above, and feel free to use YouTube for learning

Write a guide for Streamlit Sharing💪

• Please name it `StreamLit_Sharing_Guide.MD'
• Place it inside the Guides/ directory of the master branch
• Have a look at the other guides and elaborately describe the process ( It would be appreciated if the process of registration is also highlighted but optional)
• Add Snapshots of the process as and where required
• Add Useful Tips section for certain optimizations, bug fixing advice and cite corresponding references

I will add banner of crosswoc to the readme file

I will add banner of crosswoc to the readme file.
Moreover, I will associate link of the crosswoc website to its banner such that, if someone clicks the banner on readme file, it will redirect them to the website of crosswoc.

Integrate Welcome Bot

Hello there,
I can add a welcome bot config file having a proper message that will show up when any user will open up an issue or pull-request for the first time as a part of DWOC. Please assign me this issue.
For reference, kindly check out: https://github.com/apps/welcome
THANK YOU

Improvement🎨 to GKE Guide

Improve the presentation of content on the Google Kubernetes Engine Guide to deploy the app.

• Add images(snapshots) of the process
• Add GIFs
• Make a banner to replace the heading of the markdown file
• Add a section called Tips and address possible ways to fix errors. Don't forget to cite the references. Example
• Update any instruction if required
• Please put the associated images inside Guides/assets/

ADD ISSUE_TEMPLATE

Hello there,
I would like to add an issue template for your repository. This template would have four issues namely bug, documentation, feature, proposal. Kindly assign me this issue as a part of DWOC.
THANK YOU

Remove GIFs from readme file

As we know that,
A readme file lets you know about the repo as well as attracting contributors to contribute in it.
But, readme file included in your repo is loosing grip in both of the roles, because of the GIFs mentioned in it,
They create an informal image of your repo, which is not good,
In order to maintain formality of your readme file,
Let me remove the gifs and insert some catching sentences instead.
This is regarding crosswoc,

Adding Support for PyTorch Models 🤖

• Rename the function our_image_classifier to img_class_tf in the image_classifier.py
• Write another function img_class_torch and define to load an image, convert it to the necessary numpy array (or any form you deem necessary, load a pytorch model (just make a blank model.pth file in the models folder for reference but before giving the PR, test it with any custom trained model and attach the video clip of the working demo), run inference and return the result.
• Note how the labels are defined.
• Feel free to add try catch statements for better debugging

Render Custom Pages

Use HTML,CSS (with/without a framework like Bootstrap) and JS for building more visually appealing pages for the app.

Write a guide for deploying the app to Python Everywhere🐍

• Please name it `Python_Everywhere_Guide.MD'
• Place it inside the Guides/ directory of the master branch
• Have a look at the other guides and elaborately describe the process ( It would be appreciated if the process of registration is also highlighted but optional)
• Add Snapshots of the process as and where required
• Add Useful Tips section for certain optimizations, bug fixing advice and cite corresponding references

Add Multiple Pages

• Contact Page
• About Page
• Feedback Page

Add Contributors Table in README.md File

Like this

Improvement🎨 for the Microsoft Azure Guide

Improve the presentation of content on the Microsoft Azure Guide to deploy the app.

• Add images(snapshots) of the process
• Add GIFs
• Make a banner to replace the heading of the markdown file
• Add a section called Tips and address possible ways to fix errors. Don't forget to cite the references. Example
• Update any instruction if required
• Please put the associated images inside Guides/assets/

TFJS template 101

• Work on the TFJS branch
• Remove all python related code (eg: app.py,image_classifier.py`)
• Remove all existing guides inside the Guides\ directory of the TFJS branch
• Remove all dockerfiles ( Including dockerignore)
• Write a simple code (Minimum HTML&CSS) to upload an image, load a model saved in TFJS format and give inference below (identify the label)
• When you give the PR, send a link to the working Deploy on GitHub pages
• Use custom trained models!!

Design a Custom Banner for the Project Heading in the README

@anushbhatia will be reviewing this majorly

Add Favicon

Do we need a Python Linter for PRs?

I was just wondering that should we have a PyLint or flake8 linters for this repo to rate the code style of incoming PRs?

PyLint score can make the life of reviews comparatively easier.

I will add name and photo of maintainer in the end of readme file of your repo

you can see a sample below

README BADGES

Hi @smaranjitghose

I would like to contribute to this repository by making nice badges , Let me know if you are interested in

Kindly do assign me

The above image is a example

Improvement of SEO [Beta]

Figure out if there is a beta feature to tweak the SEO.

Make use of streamlit's discussion portal and github issues

Guide for Deployment to AWS

Write a Guide for Deploying the App to Digital Ocean🌊

• Please name it Digital_Ocean.MD
• Place it inside the Guides/ directory of the master branch
• Have a look at the other guides and elaborately describe the process ( It would be appreciated if the process of registration is also highlighted but optional)
• Add Snapshots of the process as and where required
• Add Useful Tips section for certain optimizations, bug fixing advice and cite corresponding references

Integrate Welcome and Greeting Bot

Hi @smaranjitghose
I would like to contribute to this project by adding a welcome and greeting bot which will comment up when any user will open up with an issue or pull-request for the first time
Kindly do assign me this issue @smaranjitghose
( config file having a proper message)

For reference, kindly check out: https://github.com/apps/welcome

add a contributor's table in readme

Please add DWOCand LEVEL-2 tags to this issue.

Should I add different Open-source programs this project has been or is a part of in the README

Content Improvements to the Streamlit App

Only modify the app.py for editing the content and its presentation on multiple pages

Edit from Github Links are not working.

When we go to the Edit on GitHub on any documentation page, It will redirect us to the wrong page.

Write a guide for deploying the app to Linode 🐱‍💻

• Please name it Linode_Guide.MD
• Place it inside the Guides/ directory of the master branch
• Have a look at the other guides and elaborately describe the process ( It would be appreciated if the process of registration is also highlighted but optional)
• Add Snapshots of the process as and where required
• Add Useful Tips section for certain optimizations, bug fixing advice and cite corresponding references