Simple Web Application for Computer Vision Model Deployment

Wagtail, Django based web application for real-time and image based deployment of Computer Vision

Read More · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Compatible With
   • Can be Deployed on
   • Works With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Make your app
5. Resources
6. Contributing
7. License
8. Contact

About The Project

The simple web app is a web application built using the wagtail app development framework, which is based on the Django web framework. It showcases how to deploy artificial intelligence (AI) models for computer vision on real-time video streams from various sources, as well as image-based uploads, with potential support for video-based uploads in the future.

The app is designed to provide a user-friendly interface with HTML, CSS, and JavaScript in the frontend and Python in the backend, making it easy for developers to deploy AI models for computer vision on video and image data. The app provides support for containerization and scalability, making it easy to deploy on different hosting platforms and environments.

However, it should be noted that the simple web app is a stencil app, meaning that it serves as a starting point for developers to build their own custom applications. Users will need to modify the app to fit their specific use case. The app comes with a brief documentation and some link to online tutorials for developers to learn more about deploying AI models for computer vision in their own applications.

Overall, the simple web app is a valuable resource for developers interested in exploring the intersection of web development and artificial intelligence, providing a powerful starting point for building custom AI-powered applications.

(back to top)

Built With

Compatible with

Can be Deployed on

Works with

(back to top)

Getting Started

1. Clone the repo

   git clone https://github.com/GitarthVaishnav/Basic_Web_App.git

Prerequisites

You require the following to get started:

• A local computer or a compatible edge device
• Python 3.9
• NVIDIA GPU (optional)

Installation

1. Go to The repository

   cd <your_path_to_folder>/Basic_Web_App

2. Create a virtual environment named venv

   python -m venv venv

3. Activate the virtual environment venv:

   Linux/MacOS:

   source venv/bin/activate

   Windows:

   venv\Scripts\activate

4. Once Virtual Environment is active, your terminal will look like the following:

   Linux/MacOS:

   (venv) apple... $ `or` %

   Windows:

   (venv) C:\.... >

5. Upgrade pip:

   pip install --upgrade pip

6. Install the requirements now (make sure venv is activated):

       pip install -r requirements.txt

   This shall install all the required libraries. If version issues occur - remove version numbers.

(back to top)

Usage

Follow the steps to start the simple web application after the libraries are installed:

1. Go to the directory mysite

   cd mysite

2. Run the following command (required after every major code update, and first installation)

   python manage.py makemigrations

3. Run the following command (required after every major code update, and first installation)

   python manage.py migrate 

4. Run the following command (this starts the application)

   python manage.py runserver

(back to top)

Make your app

There are two options to make your own app:

1. Start from scratch, i.e., not building up on this app, but starting fresh and then doing everything on your own. Check out: Option1 Documentation
2. Build on this app, i.e., modify this app by installing this app and then changing everything as per your requirements. Check out: Option2 Documentation

Note for Students (specially for students of the subject: 42028 Deep Learning and CNNs of UTS):

I strongly recommend that you choose Option-2 for your project. While the provided app is a basic, vanilla-level baseline, it is important to note that using this app with only minor modifications may result in heavy penalties. To avoid these penalties, I strongly recommend making significant modifications and additions to the app, including but not limited to functionalities, style, pages, UI/UX, AI, look and feel, optimisation and edge-case testing.

I would also like to remind you that the provided app is the intellectual property of Gitarth Vaishnav. Any use of this app should be accompanied by proper attribution (including but not limited to visibility in the code, report, and the actual interface/system), in accordance with academic integrity policies.

Please note that copying the app as is, with only minor or little modifications, may result in accusations of plagiarism and penalties.

Thank you for your understanding and adherence to the academic integrity policies of the university.

(back to top)

Resources

• Learn Wagtail: Link
• Django for Data Science: Link
• Wagtail Documentation: Link
• Django Documentation: Link

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Custom License. See LICENSE for more information.

(back to top)

Contact

Gitarth Vaishnav - @GitarthVaishnav

Email: [email protected] | [email protected]

Github Link: @GitarthVaishnav

Project Link: https://github.com/GitarthVaishnav/Basic_Web_App/

(back to top)