Skip to content

Commit

Permalink
Update developer documentation (#142)
Browse files Browse the repository at this point in the history
add missing instructions for developers, or users running directly on host
  • Loading branch information
emmanvg authored Feb 8, 2022
1 parent e4037d0 commit 8e60053
Showing 1 changed file with 22 additions and 12 deletions.
34 changes: 22 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <replace-with-registered-model-name>
```
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 <http://localhost:8000> 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 <http://localhost:8000> 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
Expand Down

0 comments on commit 8e60053

Please sign in to comment.