Update README.md

README.md

@@ -34,60 +34,89 @@ The result is Interplay-AppCoder LLM, a brand new high performing code generatio
 
 
 
-- **Demo [optional]:** [https://appcoder.interplay.iterate.ai/]
+- **Demo :** [https://appcoder.interplay.iterate.ai/]
 
 
 
 ## Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
+The model is optimized for code generation and cannot be used as chat model.
 
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
 ## How to Get Started with the Model
 
 Use the code below to get started with the model.
+#import model from hugging face repository
+import torch
+from transformers import (
+ AutoModelForCausalLM,
+ AutoTokenizer,
+ BitsAndBytesConfig,
+ HfArgumentParser,
+ pipeline,
+ logging
+)
+model_repo_id ="iterateai/Interplay-AppCoder"
+
+#### Load the model in FP16
+iterate_model = AutoModelForCausalLM.from_pretrained(
+ model_repo_id,
+ low_cpu_mem_usage=True,
+ return_dict=True,
+ torch_dtype=torch.float16,
+ device_map={"": 0},
+ trust_remote_code=True
+)
+#Note: You can quantize the model using bnb confi parameter to load the model in T4 GPU
+
+### Load tokenizer to save it
+tokenizer = AutoTokenizer.from_pretrained(model_repo_id, trust_remote_code=True)
+tokenizer.pad_token = tokenizer.eos_token
+tokenizer.padding_side = "right"
+
+### Inferencing
+
+logging.set_verbosity(logging.CRITICAL)
+#### Sample prompt
+prompt = "Can you provide a python script that uses the YOLOv8 model from the Ultralytics library to detect people in an image, draw green bounding boxes around them, and then save the image?"
+
+pipe = pipeline(task="text-generation", model=iterate_model, tokenizer=tokenizer, max_length=1024)
+result = pipe(f"Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request. ### Instruction: {prompt} ### Response:",temperature=0.1,do_sample=True)
+print(result[0]['generated_text'])
+
+## Sample demo notebook
+[https://colab.research.google.com/drive/1USuNLFxLex-C5tLHYET_nQfpM4ALCbc5?usp=sharing#scrollTo=lNCZTBj1nBsJ]
 
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
+## Evaluation
 
-[More Information Needed]
+<!-- This section describes the evaluation protocols and provides the results. -->
 
-### Training Procedure 
+#### Testing Data
 
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+<!-- This should link to a Dataset Card if possible. -->
 
+Dataset used for evaluation [https://drive.google.com/file/d/1R6DDyBhcR6TSUYFTgUosJxrvibkR1BHC/view]
 
 
-## Evaluation
+#### Metrics
 
-<!-- This section describes the evaluation protocols and provides the results. -->
+<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+Our CodeGeneration LLM was created and fine-tuned with a new and unique knowledge base. As such, we utilized the newly published ICE score benchmark methodology for evaluating the code generated by the Interplay-AppCoder LLM.
 
-### Testing Data, Factors & Metrics
+The ICE methodology provides metrics for Usefulness and Functional Correctness as a baseline for scoring code generation.
 
-#### Testing Data
+* Usefulness: addresses whether the code output from the model is clear, presented in logical order, and maintains human readability and whether it covers all functionalities of the problem statement after comparing it with the reference code.
+* Functional Correctness: An LLM that has complex reasoning capabilities is utilized to conduct unit tests while considering the given question and the reference code.
 
-<!-- This should link to a Dataset Card if possible. -->
 
-[More Information Needed]
+We utilized GPT4 to measure the above metrics and provide a score from 0-4. This is the test dataset[https://drive.google.com/file/d/1R6DDyBhcR6TSUYFTgUosJxrvibkR1BHC/view] and Jupyter notebook [https://colab.research.google.com/drive/1USuNLFxLex-C5tLHYET_nQfpM4ALCbc5?usp=sharing#scrollTo=lNCZTBj1nBsJ] we used to perform the benchmark.
 
+You can read more about the ICE methodology in this paper.
 
-#### Metrics
+[https://openreview.net/pdf?id=RoGZaCsGUW]
 
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]