added a code snippet to explain how to use

README.md

@@ -25,185 +25,82 @@ This repo contains 4-bit quantized (using bitsandbytes) model of Technology Inno
 - bitsandbytes github repo: [bitsandbytes github repo](https://github.com/TimDettmers/bitsandbytes)
 
 
-
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-
-- **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]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[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 -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- 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]
-
-### 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
+# How to Get Started with the Model
 
 Use the code below to get started with the model.
 
-[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. -->
-
-[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. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
 
-#### Training Hyperparameters
+## How to run from Python code
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+#### First install the package
+```shell
+pip install -q -U bitsandbytes accelerate torch huggingface_hub
+pip install -q -U git+https://github.com/huggingface/transformers.git # Install latest version of transformers
+pip install -q -U git+https://github.com/huggingface/peft.git
+pip install flash-attn --no-build-isolation
+```
 
-#### Speeds, Sizes, Times [optional]
+# Import 
 
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
+```python
+import torch
+import os
+from torch import bfloat16
+from transformers import AutoTokenizer, AutoModelForCausalLM, pipeline, BitsAndBytesConfig, LlamaForCausalLM
+```
 
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
+# Use a pipeline as a high-level helper
 
-### Testing Data, Factors & Metrics
+```python
+model_id_falcon = "alokabhishek/falcon-7b-instruct-bnb-4bit"
 
-#### Testing Data
+tokenizer_falcon = AutoTokenizer.from_pretrained(model_id_falcon, use_fast=True)
 
-<!-- This should link to a Dataset Card if possible. -->
+model_falcon = AutoModelForCausalLM.from_pretrained(
+    model_id_falcon,
+    device_map="auto"
+)
 
-[More Information Needed]
-
-#### Factors
 
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
+pipe_falcon = pipeline(model=model_falcon, tokenizer=tokenizer_falcon, task='text-generation')
 
-[More Information Needed]
+prompt_falcon = "Tell me a funny joke about Large Language Models meeting a Blackhole in an intergalactic Bar."
 
-#### Metrics
+output_falcon = pipe_falcon(prompt_falcon, max_new_tokens=512)
 
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+print(output_falcon[0]["generated_text"])
 
-[More Information Needed]
-
-### Results
-
-[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]
+## Uses
 
-### Model Architecture and Objective
+<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
-[More Information Needed]
+### Direct Use
 
-### Compute Infrastructure
+<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
 [More Information Needed]
 
-#### Hardware
-
-[More Information Needed]
+### Downstream Use [optional]
 
-#### Software
+<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
 [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]
+### Out-of-Scope Use
 
-**APA:**
+<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
 [More Information Needed]
 
-## Glossary [optional]
+## Bias, Risks, and Limitations
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
 [More Information Needed]
 
-## More Information [optional]
-
-[More Information Needed]
 
 ## Model Card Authors [optional]