Update README.md

README.md

@@ -1,11 +1,19 @@
 ---
-base_model: TheBloke/leo-hessianai-7B-GPTQ
+base_model: LeoLM/leo-hessianai-7b
 license: cc-by-4.0
+datasets:
+- caretech-owl/wikiquote-de-quotes
+language:
+- de
+library_name: adapter-transformers
+pipeline_tag: text-generation
 ---
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
+This model is trained to generate german quotes for a given author. 
+The full model can be tested at [spaces/caretech-owl/quote-generator-de](https://huggingface.co/spaces/caretech-owl/quote-generator-de),
+here we provide the LORA adapter files for loading on top of the base model [LeoLM/leo-hessianai-7b](https://huggingface.co/LeoLM/leo-hessianai-7b).
 
 
 
@@ -13,190 +21,68 @@ license: cc-by-4.0
 
 ### Model Description
 
-<!-- Provide a longer summary of what this model is. -->
-
-
-
-- **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]
+This fine-tuned model has been trained on the [caretech-owl/wikiquote-de-quotes](https://huggingface.co/datasets/caretech-owl/wikiquote-de-quotes) dataset. 
+The model was trained on a prompt like this
+```python
+
+prompt_format = "<|im_start|>system\
+Dies ist eine Unterhaltung zwischen einem\
+intelligenten, hilfsbereitem KI-Assistenten und einem Nutzer.
+Der Assistent gibt Antworten in Form von Zitaten.<|im_end|>\n\
+<|im_start|>user\
+Zitiere {author}<|im_end|>\n<\
+|im_start|>assistant\n{quote}<|im_end|>\n"
+```
+Where author is itended to be provided by the user, the quote is of format ```quote + " - " + author```.
+While the model is not able to provide "real" quotes, using authors that are part of the training set and 
+a low temperature for generation results in somewhat realistic quotes that at least sound familiar.
+
+
+- **Developed by:** [CareTech OWL](https://www.caretech-owl.de/)
+- **Model type:** LLAMA2 LORA adapter
+- **Language(s) (NLP):** German
+- **License:** [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/)
+- **Finetuned from model:** [LeoLM/leo-hessianai-7b](https://huggingface.co/LeoLM/leo-hessianai-7b)
 
 ## 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
-
-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
-
-- **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
-
-
-
-## 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]
+```python
+from transformers import (
+    AutoModelForCausalLM,
+    AutoTokenizer,
+    pipeline
+)
+base_model = AutoModelForCausalLM.from_pretrained('LeoLM/leo-hessianai-7b')
+tokenizer = AutoTokenizer.from_pretrained(base_model_name, 
+                                          trust_remote_code=False)
+tokenizer.pad_token = tokenizer.eos_token
 
-## Glossary [optional]
+base_model.load_adapter('caretech-owl/leo-hessianai-7B-ggpq-german-quotes-lora', adapter_name='leo-hessianai-7B-ggpq-german-quotes-lora')
+base_model.enable_adapters()
 
-<!-- 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]
+text_gen = pipeline(task="text-generation", model=base_model,
+                    max_length=200, tokenizer=tokenizer)
 
-[More Information Needed]
+system_prompt = """Dies ist eine Unterhaltung zwischen \
+einem intelligenten, hilfsbereitem \
+KI-Assistenten und einem Nutzer.
+Der Assistent gibt Antworten in Form von Zitaten."""
+prompt_format = "<|im_start|>system\n{system_prompt}\
+<|im_end|>\n<|im_start|>user\nZitiere {prompt}\
+<|im_end|>\n<|im_start|>assistant\n"
 
-## Model Card Authors [optional]
+def get_quote(author:str, max_length:int=200):
+    query = prompt_format.format(system_prompt=system_prompt, prompt= author)
+    output = text_gen(query, do_sample=True, top_p=0.95, max_length=max_length, 
+                      return_full_text=False, pad_token_id=tokenizer.pad_token_id)
+    print(output[0]['generated_text'])
 
-[More Information Needed]
 
-## Model Card Contact
+get_quote("Heinrich Heine")
+```
 
-[More Information Needed]
 
 
 ## Training procedure
@@ -226,4 +112,4 @@ The following `bitsandbytes` quantization config was used during training:
 ### Framework versions
 
 
-- PEFT 0.6.2
+- PEFT 0.6.2