Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
santi1234567 committed May 2, 2024
1 parent 52a3545 commit 9c2c8a0
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,16 @@ pip install -r requirements.txt
pip install -r requirements-dev.txt
```

### k-NN Classifier
### The Classifier

Blockprint's classifier is a k-nearest neighbours classifier in `knn_classifier.py`.
Blockprint's classifier utilizes one of two machine learning algorithms:

See `./knn_classifier.py --help` for command line options including cross
- K-nearest neighbours
- Multi-layer Perceptron

These can be chosen with the `--classifier-type` flag in `classifier.py`.

See `./classifier.py --help` for more command line options including cross
validation (CV) and manual classification.

### Training the Classifier
Expand Down Expand Up @@ -81,10 +86,10 @@ testdata_proc
└── 0x7fedb0da9699c93ce66966555c6719e1159ae7b3220c7053a08c8f50e2f3f56f.json
```

You can then use this directory as the datadir argument to `./knn_classifier.py`:
You can then use this directory as the datadir argument to `./classifier.py`:

```
./knn_classifier.py testdata_proc --classify testdata
./classifier.py testdata_proc --classify testdata
```

If you then want to use the classifier to build an sqlite database:
Expand Down

0 comments on commit 9c2c8a0

Please sign in to comment.