Upload README.md

README.md

@@ -0,0 +1,140 @@
+---
+library_name: peft
+base_model: sujitvasanth/TheBloke-openchat-3.5-0106-GPTQ
+---
+
+# Model Card for Model ID
+
+<!-- Finetuned version of openchat for extracting information from a database json object. -->
+
+
+## Model Details
+
+### Model Description
+
+<!-- Finetuned version of openchat for extracting information from a database json object. It is train -->
+
+
+
+- **Developed by:** Dr Sujit Vasanth
+- **Model type:** QLoRA PEFT
+- **Language(s) (NLP):** Json, English
+- **License:** [More Information Needed]
+- **Finetuned from model [optional]:** TheBloke/openchat-3.5-0106-GPTQ
+
+### Model Sources [optional]
+
+- **Repository:** https://github.com/sujitvasanth/GPTQ-finetune
+- **Demo [optional]:** https://github.com/sujitvasanth/GPTQ-finetune/blob/main/GPTQ-finetune.py
+
+
+## How to Get Started with the Model
+
+model = AutoModelForCausalLM.from_pretrained(model_id,
+    quantization_config= GPTQConfig(bits=4, disable_exllama=False),device_map="auto") # is_trainable=True
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+tokenizer.pad_token = tokenizer.eos_token
+model.load_adapter(adapter_id)
+
+
+## Training Details
+
+### Training Data
+
+<!-- https://huggingface.co/datasets/sujitvasanth/jsonsearch2 -->
+https://huggingface.co/datasets/sujitvasanth/jsonsearch2
+User: Assistant examples of Json search Query
+
+### Training Procedure 
+
+<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+QLora PEFT training on custom dataset
+
+#### Preprocessing [optional]
+
+[More Information Needed]
+
+
+#### 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. -->
+
+[More Information Needed]
+
+## Evaluation
+
+<!-- This section describes the evaluation protocols and provides the results. -->
+
+### Testing Data, Factors & Metrics
+
+#### Testing Data
+
+<!-- This should link to a Dataset Card if possible. -->
+
+[More Information Needed]
+
+#### Factors
+
+<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
+
+[More Information Needed]
+
+#### Metrics
+
+<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+
+[More Information Needed]
+
+### Results
+
+[More Information Needed]
+
+#### Summary
+
+
+#### 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]
+
+[More Information Needed]
+
+## Model Card Contact
+
+[More Information Needed]
+
+
+### Framework versions
+
+- PEFT 0.8.2