Added code snipped to show how to use

README.md

@@ -22,97 +22,95 @@ This repo GGUF quantized version of Meta's meta-llama/Llama-2-7b-chat-hf model u
 
 
 
+# How to Get Started with the Model
 
+Use the code below to get started with the model.
 
-### Model Description
 
-<!-- Provide a longer summary of what this model is. -->
+## How to run from Python code
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+#### First install the package
+```shell
+# Base ctransformers with CUDA GPU acceleration
+! pip install ctransformers[cuda]>=0.2.24
+# Or with no GPU acceleration
+# ! pip install ctransformers>=0.2.24
+! pip install -U sentence-transformers
+! pip install transformers huggingface_hub torch
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+```
 
-### Model Sources [optional]
+# Import 
 
-<!-- Provide the basic links for the model. -->
+```python
+from ctransformers import AutoModelForCausalLM
+from transformers import pipeline, AutoModel, AutoTokenizer
+from sentence_transformers import SentenceTransformer
+import os
+```
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+# Use a pipeline as a high-level helper
 
-## Uses
+```python
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+# Load LLM and Tokenizer
 
-### Direct Use
+# Load LLM and Tokenizer
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+model_llama = AutoModelForCausalLM.from_pretrained(
+    "alokabhishek/Llama-2-7b-chat-hf-GGUF",
+    model_file="llama-2-7b-chat-hf.Q4_K_M.gguf", # replace Q4_K_M.gguf with Q5_K_M.gguf as needed
+    model_type="llama", 
+	gpu_layers=50, # Use `gpu_layers` to specify how many layers will be offloaded to the GPU.
+	hf=True
+)
+tokenizer_llama = AutoTokenizer.from_pretrained(
+    "alokabhishek/Llama-2-7b-chat-hf-GGUF", 
+	use_fast=True
+)
 
-[More Information Needed]
 
-### Downstream Use [optional]
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+# Create a pipeline
+pipe_llama = pipeline(model=model_llama, tokenizer=tokenizer_llama, task='text-generation')
 
-[More Information Needed]
+prompt_llama = "Tell me a funny joke about Large Language Models meeting a Blackhole in an intergalactic Bar."
 
-### Out-of-Scope Use
+output_llama = pipe_llama(prompt_llama, max_new_tokens=512)
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+print(output_llama[0]["generated_text"])
 
-### Recommendations
+```
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+## Uses
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
-## How to Get Started with the Model
+### Direct Use
 
-Use the code below to get started with the model.
+<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
 [More Information Needed]
 
-## Training Details
-
-### Training Data
+### Downstream Use [optional]
 
-<!-- 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. -->
+<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
 [More Information Needed]
 
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+### Out-of-Scope Use
 
-#### Preprocessing [optional]
+<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
 [More Information Needed]
 
+## Bias, Risks, and Limitations
 
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
 [More Information Needed]
 
+
 ## Evaluation
 
 <!-- This section describes the evaluation protocols and provides the results. -->
@@ -141,67 +139,6 @@ Use the code below to get started with the model.
 
 [More Information Needed]
 
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
 
 ## Model Card Authors [optional]