diff --git a/README.md b/README.md index 3bc8bdc..9031f3e 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,15 @@ locimend is a tool that corrects DNA sequencing errors using Deep Learning. +The goal is to provide a correct DNA sequence, when a sequence containing errors is provided. + +It provides both a command-line program and a REST API. + ## Technologies - Tensorflow - Biopython +- FastAPI ## Installation @@ -48,8 +53,59 @@ contains all the needed dependencies. ## Usage -The following command creates the dataset, trains the Deep Learning model and shows the accuracy: +### Training the model + +The following command creates the trains the Deep Learning model and shows the accuracy and AUC: ```bash -poetry run python src/model.py +poetry run python locimend/main.py train