image-search
A short description of the project
Development Requirements
- Python3.8.2
- Pip
- Poetry (Python Package Manager)
M.L Model Environment
MODEL_PATH=./ml/model/
MODEL_NAME=model.pkl
/predict
Update To update your machine learning model, add your load
and method
change here at predictor.py
Installation
python -m venv venv
source venv/bin/activate
make install
Runnning Localhost
make run
Deploy app
make deploy
Running Tests
make test
Runnning Easter Egg
make easter
Access Swagger Documentation
Access Redocs Documentation
Project structure
Files related to application are in the app
or tests
directories.
Application parts are:
app
├── api - web related stuff.
│ └── routes - web routes.
├── core - application configuration, startup events, logging.
├── models - pydantic models for this application.
├── services - logic that is not just crud related.
└── main.py - FastAPI application creation and configuration.
│
tests - pytest