diff --git a/models/README.md b/models/README.md new file mode 100644 index 0000000..51e7601 --- /dev/null +++ b/models/README.md @@ -0,0 +1,62 @@ +# models/ + +This directory holds code for AI model used for disease detection in crops. + +--- + +## Requirements + +- `${FRONTEND_URI}` is used in [server.js](./models/server.js). This should be passed when creating the Docker container as an environment variable. +- `${FRONTEND_URI}` is essentially the URI where the frontend is hosted. + +## Docker Run + +It is recommended that you use the [docker-compose.yaml](./docker-compose.yaml) file which creates all the required containers, however if you wish to run only the "models" part of this project in Docker run the following docker command. + +```shell +docker run -tid \ + --name cropcompass-model \ + --restart always \ + -p "8081:8081" \ + -e "FRONTEND_URI=" \ + kshitijka/cropcompass-model: +``` + +> [!NOTE] +> Replace `` with the actual frontend URI such as http://localhost:3000 & `` with an actual version number such as `1.1.0`. + +## Manual Run + +To run only the "models" part of this project, you will have to create a python virtual environement, followed by installing all the dependencies and then running the [server.js](./models/server.js) file using node. + +1. Install required packages (for Debian based systems): + +```shell +sudo apt install python3 python3-pip python3.11-venv +``` + +2. Create a virtual environment: + +```shell +python3 -m venv . +``` + +> [!NOTE] +> Assuming you're in the `models/` directory. + +3. Install required packages using `pip`: + +```shell +pip install -r requirements.txt +``` + +4. Run [server.js](./models/server.js): + +```shell +node server.js +``` + +> [!NOTE] +> Assuming you already have `node` installed on your system. + +---