Update README.md

README.md

@@ -1,24 +1,36 @@
 ---
+title: Commodore 64 Expert Model
 tags:
+- commodore-64
 - autotrain
-- text-generation
-widget:
-- text: "I love AutoTrain because "
+- gemma-2b
+- gpt-3.5-augmented
+datasets:
+- custom
+library_name: transformers
+model: theoracle/autotrain-lsmbq-gemma64
 license: other
 ---
 
-# Model Trained Using AutoTrain
+## Overview
 
-This model was trained using AutoTrain. For more information, please visit [AutoTrain](https://hf.co/docs/autotrain).
+The `theoracle/autotrain-lsmbq-gemma64` model stands as a specialized knowledge base on the iconic Commodore 64 (C64), trained on official manuals and augmented with data synthesized by GPT-3.5. This model, leveraging the powerful Gemma 2B architecture, is designed to answer detailed questions regarding the C64, ranging from basic usage and programming to hardware troubleshooting and game tips. Although it demonstrates impressive accuracy and depth, ongoing improvements aim to refine its performance further.
 
-# Usage
+## Key Features
 
-```python
+- **Commodore 64 Specialization**: Directly trained on C64 manuals, offering authentic and comprehensive insights.
+- **GPT-3.5 Augmentation**: Utilizes GPT-3.5-generated data for training, enhancing the model's understanding and coverage of less-documented topics.
+- **Gemma 2B Architecture**: Built on the robust Gemma 2B framework, ensuring high-quality, context-aware responses.
+- **AutoTrain Optimized**: Developed with Hugging Face's AutoTrain, guaranteeing efficient training and optimal model performance.
 
-from transformers import AutoModelForCausalLM, AutoTokenizer
+## Usage
+
+To tap into the vast knowledge of the Commodore 64 through this model, follow the example Python code below:
 
-model_path = "PATH_TO_THIS_REPO"
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
 
+model_path = "theoracle/autotrain-lsmbq-gemma64"
 tokenizer = AutoTokenizer.from_pretrained(model_path)
 model = AutoModelForCausalLM.from_pretrained(
     model_path,
@@ -26,15 +38,38 @@ model = AutoModelForCausalLM.from_pretrained(
     torch_dtype='auto'
 ).eval()
 
-# Prompt content: "hi"
-messages = [
-    {"role": "user", "content": "hi"}
-]
+# Example question about the Commodore 64
+prompt = '''
+###human:How do I load a game from tape on the Commodore 64 \n###bot:?
+'''
+
+# Tokenize and generate the response
+encoding = tokenizer(prompt, return_tensors='pt', padding=True, truncation=True, max_length=500, add_special_tokens=True)
+input_ids = encoding['input_ids']
+attention_mask = encoding['attention_mask']
 
-input_ids = tokenizer.apply_chat_template(conversation=messages, tokenize=True, add_generation_prompt=True, return_tensors='pt')
-output_ids = model.generate(input_ids.to('cuda'))
-response = tokenizer.decode(output_ids[0][input_ids.shape[1]:], skip_special_tokens=True)
+output_ids = model.generate(
+    input_ids.to('cuda'),
+    attention_mask=attention_mask.to('cuda'),
+    max_new_tokens=300,
+    pad_token_id=tokenizer.eos_token_id
+)
 
-# Model response: "Hello! How can I assist you today?"
+response = tokenizer.decode(output_ids[0], skip_special_tokens=True)
 print(response)
-```
+```
+
+## Application Scenarios
+
+This model is a valuable resource for:
+- Enthusiasts looking to explore the capabilities of the Commodore 64.
+- Developers interested in creating software or games for the C64 platform.
+- Historians and researchers studying the impact and technical details of early personal computing devices.
+
+## Training and Technology
+
+Developed using Hugging Face's AutoTrain for streamlined and effective training, and built upon the advanced Gemma 2B architecture, this model benefits from both the depth of the original C64 documentation and the breadth of modern AI-generated content. The integration of GPT-3.5-augmented data ensures a well-rounded and comprehensive understanding of the Commodore 64.
+
+## License
+
+This model is distributed under an "other" license. Users are advised to review the license terms for their intended use, ensuring compliance with any restrictions or requirements.