Update README.md

README.md

@@ -1,3 +1,29 @@
 ---
 license: openrail
 ---
+
+## About the AI
+This AI was initialy designed for a different project i was going to do, but the scope of the project was too large.
+However this single AI that was developed for the project, and performed exceptionaly at categorizing.
+After a bit of a data set tweak, it has been repurposed to work as a base for an assistant.
+with just under 50k parameters, this model should run on any hardware.
+
+## List of included files
+train.py: the training function of the model, can be used to train a new model on different data.
+
+categorizer.h5: the model trained on the data.csv file for 3 epoches with a batch size of 1. generorated by train.py
+
+tokenizer.pkl: contain the tokenizer for 5he pre-trained model. genorated by train.py
+
+interact.py: pulls categorizer.h5, and tokenizer.pkl together in a simple text-based assistan (voice in and out put comeing soon)
+
+## How to actualy use this model
+1. download categorizer.h5, tokenizer.pkl, and interact.py
+2. run interact.py
+3. ask it to do something, current capabilitys are opening websites, doing google search, and doing math
+
+## Roadmap of features
+- voice functionality for interact.py
+- finding and reading results from google
+- website finder for the open site function
+- more category's/functions (taking requests)