Upload README.md

README.md

@@ -1,8 +1,180 @@
-# Persian Poetry Generator Model
+---
+language:
+- fa
+tags:
+- text-generation
+- persian
+- poetry
+- peft
+- quantization
+- llama
+base_model: meta-llama/Llama-3.1-8B-Instruct
+finetuned_from: meta-llama/Llama-3.1-8B-Instruct
+library_name: transformers
+pipeline_tag: text-generation
+trust_remote_code: true
+special_tokens:
+  additional_special_tokens:
+    - "[شروع_شعر]"
+    - "[پایان_شعر]"
+    - "[مصرع]"
+quantization:
+  load_in_4bit: true
+  bnb_4bit_quant_type: nf4
+  bnb_4bit_compute_dtype: float16
+  bnb_4bit_use_double_quant: true
+---
+# Model Card for llama_poetry_fa
 
-Base Model: meta-llama/Llama-3.1-8B-Instruct
-Special Tokens: ["شروع_شعر", "پایان_شعر", "مصرع"]
-Training Date: 2024-12-05
+**Model Name:** llama_poetry_fa  
+**Model URL:** https://huggingface.co/8lianno/llama_poetry_fa
 
-This model is fine-tuned for generating Persian poetry with proper rhythm and rhyme.
-            
+This model is trained on a Llama 3.1-based checkpoint, focusing on generating Persian poetry. It returns responses in Persian poetic form, incorporating suitable rhyme and rhythm based on the given prompt.
+
+{{ model_summary | default("", true) }}
+
+## Model Details
+
+### Model Description
+
+{{ model_description | default("", true) }}
+
+- **Developed by:** {{ developers | default("[More Information Needed]", true)}}
+- **Funded by [optional]:** {{ funded_by | default("[More Information Needed]", true)}}
+- **Shared by [optional]:** {{ shared_by | default("[More Information Needed]", true)}}
+- **Model type:** {{ model_type | default("Causal Language Model (Llama-based)", true)}}
+- **Language(s) (NLP):** {{ language | default("fa", true)}}
+- **License:** {{ license | default("[More Information Needed]", true)}}
+- **Finetuned from model [optional]:** {{ base_model | default("meta-llama/Llama-3.1-8B-Instruct", true)}}
+
+### Model Sources [optional]
+
+- **Repository:** {{ repo | default("https://huggingface.co/8lianno/llama_poetry_fa", true)}}
+- **Paper [optional]:** {{ paper | default("[More Information Needed]", true)}}
+- **Demo [optional]:** {{ demo | default("[More Information Needed]", true)}}
+
+## Uses
+
+### Direct Use
+
+{{ direct_use | default("Intended for generating Persian poems in response to user queries.", true)}}
+
+### Downstream Use [optional]
+
+{{ downstream_use | default("[More Information Needed]", true)}}
+
+### Out-of-Scope Use
+
+{{ out_of_scope_use | default("Not suitable for factual QA tasks, non-Persian text generation, or high-stakes decision making.", true)}}
+
+## Bias, Risks, and Limitations
+
+{{ bias_risks_limitations | default("The model may produce culturally specific or biased content and may not reflect all poetic traditions accurately.", true)}}
+
+### Recommendations
+
+{{ bias_recommendations | default("Users should review generated poems critically for cultural biases or inappropriate content before use.", true)}}
+
+## How to Get Started with the Model
+
+{{ get_started_code | default("See the included poetry_generator.py for an example of loading and generating poems.", true)}}
+
+## Training Details
+
+### Training Data
+
+{{ training_data | default("The model was trained on a collection of Persian poetry and literature. More details needed.", true)}}
+
+### Training Procedure
+
+#### Preprocessing [optional]
+
+{{ preprocessing | default("[More Information Needed]", true)}}
+
+#### Training Hyperparameters
+
+- **Training regime:** {{ training_regime | default("Fine-tuned with LoRA and 4-bit quantization.", true)}}
+
+#### Speeds, Sizes, Times [optional]
+
+{{ speeds_sizes_times | default("[More Information Needed]", true)}}
+
+## Evaluation
+
+### Testing Data, Factors & Metrics
+
+#### Testing Data
+
+{{ testing_data | default("Internal Persian poetry test samples.", true)}}
+
+#### Factors
+
+{{ testing_factors | default("[More Information Needed]", true)}}
+
+#### Metrics
+
+{{ testing_metrics | default("[More Information Needed]", true)}}
+
+### Results
+
+{{ results | default("[More Information Needed]", true)}}
+
+#### Summary
+
+{{ results_summary | default("", true) }}
+
+## Model Examination [optional]
+
+{{ model_examination | default("[More Information Needed]", true)}}
+
+## Environmental Impact
+
+- **Hardware Type:** {{ hardware_type | default("[More Information Needed]", true)}}
+- **Hours used:** {{ hours_used | default("[More Information Needed]", true)}}
+- **Cloud Provider:** {{ cloud_provider | default("[More Information Needed]", true)}}
+- **Compute Region:** {{ cloud_region | default("[More Information Needed]", true)}}
+- **Carbon Emitted:** {{ co2_emitted | default("[More Information Needed]", true)}}
+
+## Technical Specifications [optional]
+
+### Model Architecture and Objective
+
+{{ model_specs | default("Llama-based causal language model fine-tuned for Persian poetry.", true)}}
+
+### Compute Infrastructure
+
+{{ compute_infrastructure | default("[More Information Needed]", true)}}
+
+#### Hardware
+
+{{ hardware_requirements | default("[More Information Needed]", true)}}
+
+#### Software
+
+{{ software | default("[More Information Needed]", true)}}
+
+## Citation [optional]
+
+**BibTeX:**
+
+{{ citation_bibtex | default("[More Information Needed]", true)}}
+
+**APA:**
+
+{{ citation_apa | default("[More Information Needed]", true)}}
+
+## Glossary [optional]
+
+{{ glossary | default("[More Information Needed]", true)}}
+
+## More Information [optional]
+
+{{ more_information | default("[More Information Needed]", true)}}
+
+## Model Card Authors [optional]
+
+{{ model_card_authors | default("[More Information Needed]", true)}}
+
+## Model Card Contact
+
+{{ model_card_contact | default("[More Information Needed]", true)}}