Update README.md

README.md

@@ -11,10 +11,10 @@ This model, identified as olsi8/gemma-3-4b-it-shqip-v1, is a 🤗 Transformers m
 **Developed by:**
 The model was developed by the Hugging Face user olsi8.
 
-**Funded by (optional):**
+**Funded by:**
 Information regarding funding for this specific fine-tuning effort is not explicitly provided.
 
-**Shared by (optional):**
+**Shared by:**
 The model is shared by the Hugging Face user olsi8.
 
 **Model type:**
@@ -26,20 +26,20 @@ The primary language supported by this model is Albanian (Shqip). Given its base
 **License:**
 The license for this specific fine-tuned model is not explicitly stated on its Hugging Face page. It is likely to inherit the license of the base model, `gemma-3-4b-it`, which is typically governed by the Gemma Terms of Use. Users should verify the licensing terms before use.
 
-**Finetuned from model (optional):**
+**Finetuned from model:**
 This model was fine-tuned from `google/gemma-3-4b-it`.
 
 
 
-### Model Sources [optional]
+### Model Sources 
 
 **Repository:**
 The model is hosted on the Hugging Face Model Hub. The repository can be found at [https://huggingface.co/olsi8/gemma-3-4b-it-shqip-v1](https://huggingface.co/olsi8/gemma-3-4b-it-shqip-v1).
 
-**Paper [optional]:**
+**Paper:**
 There is no specific paper associated with this fine-tuned model. However, for information on the base Gemma models, users can refer to the relevant Google publications.
 
-**Demo [optional]:**
+**Demo:**
 No specific demo is provided for this model on its Hugging Face page.
 
 ### Uses
@@ -47,7 +47,7 @@ No specific demo is provided for this model on its Hugging Face page.
 **Direct Use:**
 This model is intended for direct use in generating text in the Albanian language. It can be employed for tasks such as content creation, translation assistance (from other languages to Albanian, with caution), and as a foundational tool for further fine-tuning on more specific Albanian NLP tasks. Due to its proof-of-concept nature, extensive testing is recommended before deployment in production environments.
 
-**Downstream Use [optional]:**
+**Downstream Use:**
 The model can serve as a base for further fine-tuning on specialized Albanian language datasets for tasks like sentiment analysis, question answering, or domain-specific text generation.
 
 **Out-of-Scope Use:**
@@ -99,13 +99,13 @@ The model `olsi8/gemma-3-4b-it-shqip-v1` was fine-tuned on a combination of Alba
 
 **Training Procedure**
 
-*Preprocessing [optional]*
+*Preprocessing*
 Details regarding the specific preprocessing steps applied to the training data are not extensively documented on the model card. Standard preprocessing for language models typically includes tokenization, formatting of input-output pairs, and potentially data cleaning or filtering. Given the use of the `albanian-lang-gemma-format` dataset, it is likely that the data was structured to be compatible with the Gemma model's training requirements.
 
 *Training Hyperparameters*
 Specific training hyperparameters such as learning rate, batch size, number of epochs, and optimization algorithms used for fine-tuning `olsi8/gemma-3-4b-it-shqip-v1` are not detailed on its Hugging Face page. The training regime would have involved fine-tuning the pre-trained `gemma-3-4b-it` model on the aforementioned Albanian language data.
 
-*Speeds, Sizes, Times [optional]*
+*Speeds, Sizes, Times*
 Information about the training speed, computational resources utilized, and total training time for this specific fine-tuning effort is not provided.
 
 
@@ -129,7 +129,7 @@ The reported accuracy of 0.77 on the specified dataset indicates a degree of suc
 **Summary**
 `olsi8/gemma-3-4b-it-shqip-v1` demonstrates foundational capabilities in Albanian language processing, achieving a notable accuracy on its fine-tuning dataset. Nevertheless, its status as a proof-of-concept and deprecated model suggests that it serves more as an experimental iteration than a production-ready solution.
 
-### Model Examination [optional]
+### Model Examination
 Further examination of the model's outputs, error analysis, and performance on specific linguistic phenomena in Albanian would be beneficial for a deeper understanding of its strengths and weaknesses. Such detailed examination is not provided in the current model card.
 
 ### Environmental Impact
@@ -142,7 +142,7 @@ Information regarding the environmental impact of fine-tuning this specific mode
 *   **Compute Region:** [More Information Needed]
 *   **Carbon Emitted:** [More Information Needed - Can be estimated using tools like the Machine Learning Impact calculator if hardware and usage details were available]
 
-### Technical Specifications [optional]
+### Technical Specifications
 
 **Model Architecture and Objective**
 The model utilizes the Gemma architecture, specifically the `gemma-3-4b-it` version, which has approximately 3.4 billion parameters. The objective of this fine-tuned version is causal language modeling, tailored for generating coherent and contextually relevant text in the Albanian language.
@@ -155,7 +155,7 @@ Specific hardware used for the fine-tuning process is not detailed. Training mod
 *Software*
 The model was developed using the Hugging Face Transformers library. Other common software includes PyTorch or TensorFlow, CUDA for GPU acceleration, and various Python libraries for data processing.
 
-### Citation [optional]
+### Citation
 
 **BibTeX:**
 As this is a fine-tuned model by a community user, a specific BibTeX entry for this exact model version may not exist. For the base Gemma models, refer to Google's official publications. A general citation for the model repository could be:
@@ -174,14 +174,14 @@ As this is a fine-tuned model by a community user, a specific BibTeX entry for t
 **APA:**
 olsi8. (2024). *gemma-3-4b-it-shqip-v1: A fine-tuned Gemma model for Albanian*. Hugging Face. Retrieved from https://huggingface.co/olsi8/gemma-3-4b-it-shqip-v1
 
-### Glossary [optional]
+### Glossary
 [More Information Needed - A glossary could define terms like "fine-tuning", "causal language modeling", "Gemma architecture", etc., if deemed necessary for the audience.]
 
-### More Information [optional]
+### More Information
 
 This model, `olsi8/gemma-3-4b-it-shqip-v1`, should be considered a proof-of-concept for fine-tuning Gemma models for the Albanian language. It has been marked as **deprecated**. Users are advised that newer, potentially more robust models or alternative approaches may be available and should be preferred for ongoing development or production use. The model was trained on a combination of books and the `olsi8/albanian-lang-gemma-format` dataset.
 
-### Model Card Authors [optional]
+### Model Card Authors
 This model card was generated by an AI assistant based on publicly available information and user-provided details. The original model was developed and shared by the Hugging Face user 'olsi8'.
 
 ### Model Card Contact