From 8e600536d53b4bd4d8756ba53ffc95027a3c8f45 Mon Sep 17 00:00:00 2001 From: Emmanuelle Vargas-Gonzalez Date: Tue, 8 Feb 2022 15:40:50 -0500 Subject: [PATCH] Update developer documentation (#142) add missing instructions for developers, or users running directly on host --- README.md | 34 ++++++++++++++++++++++------------ 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 23f2b466b7..8c453ad578 100644 --- a/README.md +++ b/README.md @@ -146,28 +146,38 @@ The following steps are only required for local development and testing. The con python src/tram/manage.py migrate ``` -6. Create a superuser (web login) +6. Run the Machine learning training. - ```sh - python src/tram/manage.py createsuperuser - ``` + ```sh + python src/tram/manage.py attackdata load + python src/tram/manage.py pipeline load-training-data + python src/tram/manage.py pipeline train --model nb + python src/tram/manage.py pipeline train --model logreg + # python src/tram/manage.py pipeline train --model + ``` -7. Run the application server +7. Create a superuser (web login) ```sh - python src/tram/manage.py runserver + python src/tram/manage.py createsuperuser ``` -8. Open the application in your web browser. - 1. Navigate to and use the superuser to log in -9. In a separate terminal window, run the ML pipeline +8. Run the application server ```sh - cd tram/ - source venv/bin/activate - python src/tram/manage.py pipeline run + python src/tram/manage.py runserver ``` +9. Open the application in your web browser. + 1. Navigate to and use the superuser to log in +10. In a separate terminal window, run the ML pipeline + + ```sh + cd tram/ + source venv/bin/activate + python src/tram/manage.py pipeline run + ``` + ## Machine Learning Development All source code related to machine learning is located in TRAM