Updated documentation

adamspd · Jan 17, 2024 · 3d981df · 3d981df
1 parent 67fd8a7
commit 3d981df
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -93,4 +93,3 @@ members.
 This Code of Conduct is distributed under a Creative Commons Attribution-ShareAlike license.
 
 Portions of a text derived from the Django Code of Conduct and the Geek Feminism Anti-Harassment Policy.
-
diff --git a/README.md b/README.md
@@ -38,6 +38,7 @@ Make sure you have the following dependencies installed:
 - nltk
 - pandas
 - numpy
+- joblib
 
 Additionally, you'll need to download the NLTK data and to do so, use the python interpreter to run the following
 commands:
@@ -66,7 +67,7 @@ To train the models, run the following command:
 python3 spam_detector_ai/trainer.py
 ```
 
-This will train all the models and save them to the `models` directory. For now, there is 3 models:
+This will train all the models and save them as `.joblib` files in the models directory. For now, there is 3 models:
 
 - `naive_bayes.pkl`
 - `random_forest.pkl`
Original file line number	Diff line number	Diff line change
Expand Up		@@ -93,4 +93,3 @@ members.
		This Code of Conduct is distributed under a Creative Commons Attribution-ShareAlike license.

		Portions of a text derived from the Django Code of Conduct and the Geek Feminism Anti-Harassment Policy.