Update README.md

README.md

@@ -13,93 +13,72 @@ tags:
 ---
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
-
 This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
 
 ## Model Details
 
 ### Model Description
 
-<!-- Provide a longer summary of what this model is. -->
-
-
+The Digital Navigator model is designed to assist users by generating natural language responses to input queries. It is a fine-tuned GPT-2 model, customized for specific use cases.
 
 - **Developed by:** Papagiannakis Panagiotis
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-
+- **Model type:** GPT-2 (Generative Pre-trained Transformer 2)
+- **Language(s) (NLP):** English
+- **License:** Creative Commons Zero v1.0 Universal
+- **Finetuned from model [optional]:** GPT-2
 
-## 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]
+The Digital Navigator model can be directly used for generating conversational responses in English. It is intended for use in chatbots, virtual assistants, and other applications requiring natural language understanding and generation.
 
-
-[More Information Needed]
+1. Conversational AI
+2. Customer Support
+3. Virtual Assistance
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+- Generating harmful, biased, or misleading content
+- Use in high-stakes decision-making without human oversight
+- Applications requiring high accuracy and context understanding
 
-[More Information Needed]
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+The model may generate biased or inappropriate content based on the training data. Users should be cautious of the following:
 
-[More Information Needed]
+- Inherent biases in the training data
+- Generation of factually incorrect information
+- Limited understanding of context and nuance
 
 ### 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
+Users (both direct and downstream) should be made aware of the risks, biases, and limitations of the model. It is recommended to monitor and evaluate the model's output in real-world applications to ensure it meets the desired criteria and ethical standards.
 
-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]
+The model was fine-tuned on a dataset that includes various conversational data. These data were collected from my university website https://cdm.uowm.gr/en/index/. 
 
 ### Training Procedure
 
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+The model was trained using standard procedures for fine-tuning GPT-2 models.
 
 
 #### 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 -->
-
+- **Training regime:** [More Information Needed] 
+- Learning Rate: 5e-5
+- Batch Size: 16
+- Epochs: 30
+- Block Size: 128
 
 
-[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]
 
@@ -111,56 +90,48 @@ Use the code below to get started with the model.
 
 #### Metrics
 
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
+The model was evaluated using metrics like BLEU score for language quality, accuracy for factual correctness,
 
 ### Results
 
-[More Information Needed]
-
 #### Summary
 
+Due to the high complexity and small variety of the data:
 
+- Training loss: 0.3999
+- Validation loss: 1.5456
+- Bleu: 0.39863
+- Precision: 0.011
+- Recall: 0.012
+- Accuracy: 0.012
+- F1: 0.011
 
-## Model Examination [optional]
 
-<!-- Relevant interpretability work for the model goes here -->
+## Model Examination 
 
-[More Information Needed]
 
 - **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]
-
-
-### Model Architecture and Objective
+- **Hours used:** 18 minutes and 47 seconds
+- **Cloud Provider:** Google Collab
 
-[More Information Needed]
 
-### Compute Infrastructure
 
-[More Information Needed]
-
-#### Hardware
+### Model Architecture and Objective
 
-[More Information Needed]
+The model architecture is a transformer gpt. Its is an LLM model with a purpose of providing assistanse to visitors of my university's website.
 
-#### 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. -->
+Coming soon...
 
 **BibTeX:**
 
-[More Information Needed]
+Coming soon...
+
 
 **APA:**
 
-[More Information Needed]
+Coming soon...