From b364373ae98b3e41cce002fae765e097daa60a91 Mon Sep 17 00:00:00 2001 From: sjaipuriyar Date: Fri, 23 Aug 2024 15:24:22 -0700 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index d4caef6..0c8cac8 100644 --- a/README.md +++ b/README.md @@ -20,5 +20,15 @@ Phi-3 generation with Go code: 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` +#How to run this on your own + +- Start by setting up an env within the directory of your choice. +`python -m venv env` +`source env/bin//activate` +- You will need to (pip) install torch, transformers, accelerator, and flask in order to properly run the application +`pip freeze > requirements.txt` will help setup a requirements text file as shown in the repo +- If you haven't as yet, also make sure to fork Phi-3: https://huggingface.co/microsoft/Phi-3-mini-4k-instruct#sample-inference-code$0 and IBM Granite 3b: https://huggingface.co/ibm-granite/granite-3b-code-instruct#generation$0 from huggingface and change the `@app.route` in the testing.py file to match the locations where you host those models. + + 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