From b571069c83e876be2ef82fd167e940a98e7443dd Mon Sep 17 00:00:00 2001 From: sjaipuriyar Date: Fri, 23 Aug 2024 13:55:33 -0700 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index e69de29..fbf5fd1 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,24 @@ +# Model testing using Phi-3 model and IBM's Granite model + +This is a flask application that has connected both the Phi-3 model and Granite 3b model to help with things such as code generation and other tasks the user might see fit. The flask routing is set up so that you can either use the Phi-3 model or Granite model depending on task. + +## Example curl request and output that doesn't specify model -> defaults to phi-3 +`curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d"query=Write me a script to post files to Box.com from a Windows 10 machine." http://169.231.231.109:5000/query/` +This post will output setup instructions for posting files on box.com from a windows machine from the phi-3 model. + +## Example curl request and output that does specify model -> granite 3b +`curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d"query=Write me a script to post files to Box.com from a Windows 10 machine." http://169.231.231.109:5000/query/granite` +As you can see we specify the model at the end there as granite and that will then ger recognized in the testing.py folder and accordingly change the tokenizer and model. + +## If you try to request something that isn't in the query of models available you will get an error output +`curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d"query=Write me an example of Go programming code." http://169.231.231.109:5000/query/phi-5 +Only models phi and granite are supported.% ` + +## These models can be very helpful with code generation, test using these requests +Phi-3 generation with Go code: +`curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d"query=Write me an example of Go programming code." http://169.231.231.109:5000/query/phi` +Granite 3b generation with Go code: +`curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d"query=Write me an example of Go programming code." http://169.231.231.109:5000/query/granite` + + +Overall the Phi-3 model can be better used as a way to generate text and the Granite model might be better at developing code and generating software solutions \ No newline at end of file