From 123cd75f7e5cd4d0f5739371e38c6edefba28e92 Mon Sep 17 00:00:00 2001 From: Shakib Yazdani Date: Wed, 11 Sep 2024 16:25:22 +0200 Subject: [PATCH] Update README.md with CI --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 03fa65b..e125155 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Image Time Classifier App with FastAPI and Streamlit -This is an image classification app designed to determine the time of day using the CLIP model, specifically the `ViT-B/32` variant from torchvision. Users can easily upload an image, and the app will classify it into one of the following time categories: 'morning,' 'noon,' 'afternoon,' 'night,' or 'sunrise or sunset.' The app utilizes FastAPI for handling backend functionalities and Streamlit for a straightforward user interface. Docker and Docker Compose are employed for easy deployment and management of the application. - +This is an image classification app designed to determine the time of day using the CLIP model, specifically the `ViT-B/32` variant from torchvision. Users can easily upload an image, and the app will classify it into one of the following time categories: *morning*, *noon*, *afternoon*, *night*, or *sunrise or sunset*. The app utilizes **FastAPI** for handling backend functionalities and **Streamlit** for a straightforward user interface. **Docker** and **Docker Compose** are employed for easy deployment and management of the application. ## Requirements @@ -34,12 +33,16 @@ This is an image classification app designed to determine the time of day using ``` docker compose up --build -d ``` -## Run unittests +## Run unit tests ``` -docker compose exec backend-container pytest +docker compose exec backend pytest ``` +## Continuous Integration +GitHub Actions is configured to automatically run unit tests on the backend service whenever changes are pushed to the repository. The GitHub Actions workflow is defined in the **.github/workflows/ directory**. + + ## Demo ![samples](https://github.com/shakibyzn/image-time-classifier-app/blob/main/demo.png)