Compare commits

..

1 Commits

Author SHA1 Message Date
coolneng e732fdada1
Update README 2021-07-07 00:07:41 +02:00
1 changed files with 9 additions and 3 deletions

View File

@ -85,7 +85,7 @@ A trained model is provided, which can be used to infer the correct sequences. T
The following command will infer the correct sequence, and print it:
```bash
poetry run python src/main.py infer "<dna sequence>"
poetry run python src/main.py infer "<DNA sequence>"
```
#### REST API
@ -100,6 +100,12 @@ The API can be accessed at http://localhost:8000, with either a GET or POST requ
| Request | Endpoint | Payload |
|:----:|:-----:|:-----:|
| GET | /<sequence> | Sequence as a path parameter |
| POST | /| JSON: {"sequence": "<sequence>"} |
| GET | / | Sequence as a path parameter (in the URL) |
| POST | /| JSON |
For a POST request the JSON must have the following structure:
```json
{"sequence": "<DNA sequence>"}
```