refactor README

This commit is contained in:
cdietrich 2022-03-08 14:28:21 +01:00
parent be0a4fe58f
commit 5cb3632b3c

View File

@ -11,7 +11,7 @@ A configuration is located in `/config.yaml`. All relevant variables can be conf
| _service_ | | |
| LOGGING_LEVEL_ROOT | DEBUG | Logging level for service logger |
| RESPONSE_TYPE | "stream" | Whether the analysis response is stored as file on storage or sent as stream: "file" or "stream" |
| RESPONSE_FILE_EXTENSION | ".NER_ENTITIES.json.gz" | Extension to the file that stores the analyized response on storage |
| RESPONSE_FILE_EXTENSION | ".NER_ENTITIES.json.gz" | Extension to the file that stores the analyzed response on storage |
| _probing_webserver_ | | |
| PROBING_WEBSERVER_HOST | "0.0.0.0" | Probe webserver address |
| PROBING_WEBSERVER_PORT | 8080 | Probe webserver port |
@ -131,12 +131,29 @@ You can run the infrastructure either as module via. `src/serve.py` or as Docker
docker-compose up
```
3. Run module / docker container
3. Run module
```bash
python src/serve.py
python src/serve.py
```
OR as container:
```bash
docker run --net=host pyinfra
```
Start your prediction container for example ner-prediction or image-prediction (follow their corresponding README for
building the container).
To put a file on the queue do:
python src/manage_minio.py add --file path/to/file dossierID
To start mock:
python src/mock_client.py
### Hints:
When stopping the docker-compose up, use docker-compose down to remove containers created by up.
If uploaded files are stuck, clean the minio storage by using ```python src/manage_minio.py purge``` or delete local
minio data folder in pyinfra with ```sudo rm -rf data```