Skip to content

Commit

Permalink
Add usage guidelines to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
amaaniqbal authored Mar 9, 2020
1 parent c5ae47a commit d2f64c8
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@ A high level view of the system is as follows:
- Print the results


## Usage
Run the file `main.py` without any command line arguments to view the classifier performance on the available test set. In order to test on the custom input, run the following command:

```
python main.py "Custom input string goes here"
```

In the command, custom input string can also be specified without quotes.

## Example Workflow
```
name: SMS Spam Detection Action
Expand Down Expand Up @@ -48,3 +57,7 @@ jobs:
run: |
python main.py
```


## Contributing
Please feel free to create an issue if you find a bug or send a pull request if you wish to improve the existing code/add a new feature.

0 comments on commit d2f64c8

Please sign in to comment.