Skip to content

Commit

Permalink
Update README.md with CI
Browse files Browse the repository at this point in the history
  • Loading branch information
shakibyzn authored Sep 11, 2024
1 parent 629bab5 commit 123cd75
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 123cd75

Please sign in to comment.