Update README.md

README.md

@@ -1,202 +1,90 @@
 ---
 base_model: unsloth/Qwen3-1.7B
 library_name: peft
+license: mit
+datasets:
+- omar07ibrahim/Alpaca_Stanford_Azerbaijan
+language:
+- az
+pipeline_tag: question-answering
+tags:
+- alpaca
 ---
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
-
 
 
 ## Model Details
 
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-
+This model is a fine-tuned version of [`unsloth/Qwen3-1.7B`](https://huggingface.co/unsloth/Qwen3-1.7B) on a translated version of the **Alpaca Stanford dataset** in **Azerbaijani language**. 
+The model is instruction-tuned to better follow prompts and generate relevant responses in Azerbaijani.
 
-- **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]
+### Model Description
 
-<!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Language(s) (NLP):** Azerbaijani
+- **License:** MIT
+- **Finetuned from model:** unsloth/Qwen3-1.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.
+- Instruction following in Azerbaijani
+- Education, research, and experimentation with low-resource language LLMs
+- Chatbots, task-oriented systems, language agents
 
 ## 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:**
+```python 
+from huggingface_hub import login
+from transformers import AutoTokenizer, AutoModelForCausalLM
+from peft import PeftModel
 
-[More Information Needed]
 
-**APA:**
+login(token="")
 
-[More Information Needed]
+tokenizer = AutoTokenizer.from_pretrained("unsloth/Qwen3-1.7B",)
+base_model = AutoModelForCausalLM.from_pretrained(
+    "unsloth/Qwen3-1.7B",
+    device_map={"": 0}, token=""
+)
 
-## Glossary [optional]
+model = PeftModel.from_pretrained(base_model,"Rustamshry/Qwen3-1.7B-Alpaca-Azerbaijani")
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
-[More Information Needed]
+question = "Bir sifət əlavə edərək aşağıdakı cümləni yenidən yazın. Tələbə mürəkkəb anlayışları anlaya bildi. "
 
-## More Information [optional]
+messages = [
+    {"role" : "user", "content" : question}
+]
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize = False,
+    add_generation_prompt = True, 
+    enable_thinking = False, 
+)
 
-[More Information Needed]
+from transformers import TextStreamer
+_ = model.generate(
+    **tokenizer(text, return_tensors = "pt").to("cuda"),
+    max_new_tokens = 2048,
+    temperature = 0.7, 
+    top_p = 0.8, 
+    top_k = 20,
+    streamer = TextStreamer(tokenizer, skip_prompt = True),
+)
+```
 
-## Model Card Authors [optional]
+## Training Data
 
-[More Information Needed]
+- **Dataset:** omar07ibrahim/Alpaca_Stanford_Azerbaijan
 
-## Model Card Contact
 
-[More Information Needed]
 ### Framework versions
 
 - PEFT 0.14.0