Skip to content

Commit

Permalink
Add a description of the fastapi app version in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
W7CH authored Jul 31, 2024
1 parent 045683d commit 69dafda
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Streamlit web application for microorganism image classification
# Streamlit web application for microorganism image classification (with FastAPI support)

## Introduction

Expand All @@ -24,8 +24,8 @@ Before running this application, make sure you have Docker installed on your sys

To clone the repository and navigate into the project directory, run:

git clone https://github.com/PlanktoScope/streamlit-classification-app.git
cd streamlit-classification-app
git clone https://github.com/PlanktoScope/streamlit-classification-app-with-fastapi-support.git
cd streamlit-classification-app-with-fastapi-support

#### Creating a folder for pretrained models

Expand Down Expand Up @@ -62,6 +62,22 @@ From there, you can use the web interface to:
- Upload images for classification.
- View model predictions and the distribution of detected objects.

## FastAPI server for the classification of mussel and oyster larval stages

This version of the Streamlit web app contains the code for a FastAPI server hosting the model selected for the classification of mussel and oyster larvae. This model was trained on hatchery larvae images.

Starting the FastAPI Server:

1. Navigate to the fastapi folder within the fastapi model serving version:
```
cd fastapi_model_serving/fastapi
```

2. Run the FastAPI server:
```
uvicorn server:api_server --host 0.0.0.0 --port 8000
```

### Deployment/Testing with Forklift

You can use Forklift to easily deploy the Docker container provided by this repository.
Expand Down

0 comments on commit 69dafda

Please sign in to comment.