Compare commits
1 Commits
2b280e2bdf
...
e732fdada1
Author | SHA1 | Date |
---|---|---|
coolneng | e732fdada1 |
12
README.md
12
README.md
|
@ -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:
|
The following command will infer the correct sequence, and print it:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
poetry run python src/main.py infer "<dna sequence>"
|
poetry run python src/main.py infer "<DNA sequence>"
|
||||||
```
|
```
|
||||||
|
|
||||||
#### REST API
|
#### 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 |
|
| Request | Endpoint | Payload |
|
||||||
|:----:|:-----:|:-----:|
|
|:----:|:-----:|:-----:|
|
||||||
| GET | /<sequence> | Sequence as a path parameter |
|
| GET | / | Sequence as a path parameter (in the URL) |
|
||||||
| POST | /| JSON: {"sequence": "<sequence>"} |
|
| POST | /| JSON |
|
||||||
|
|
||||||
|
For a POST request the JSON must have the following structure:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"sequence": "<DNA sequence>"}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue