Update README.md

README.md

@@ -12,68 +12,151 @@ model-index:
 - name: gemma-2b-dolly-qa
   results: []
 ---
+---
+
+
+
+
+
+
+
+# Model Card for Khalsa
+
+<!-- Provide a quick summary of what the model is/does. [Optional] -->
+Fine-tuned Gemma Model which was worked on using the intel developer cloud, and trained on using Intel Max 1550 GPU
+
+
+# Model Details
+
+## Model Description
+
+<!-- Provide a longer summary of what this model is/does. -->
+Fine-tuned Gemma Model which was worked on using the intel developer cloud
+
+- **Developed by:** Manik Sethi, Britney Nguyen, Mario Miranda
+- **Model type:** Language model
+- **Language(s) (NLP):** eng
+- **License:** apache-2.0
+- **Parent Model:** gemma-2b
+- **Resources for more information:** [Intel Develpor Cloud](https://console.cloud.intel.com/training)
+
+
+
+# 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. -->
+Model is intended to be used by individuals who are struggling to understand the information in important documentations. More specifically, the demographic includes immigrants and visa holders who struggle with english. When they receive documentaiton from jobs, government agencies, or healthcare, our model should be able to answer any questions they have.
+
+## Direct Use
+
+<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+<!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
+
+User uploads a pdf to the application, which is then parsed by our model. The user is then able to ask questions about content in the given documentation.
+
+## Out-of-Scope Use
+
+<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+<!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
+Misuse of the model would entail relying on it to provide legal advice, which it is not intended to give.
+
+
+
+# Bias, Risks, and Limitations
+
+Significant research has explored bias and fairness issues with language models (see, e.g., [Sheng et al. (2021)](https://aclanthology.org/2021.acl-long.330.pdf) and [Bender et al. (2021)](https://dl.acm.org/doi/pdf/10.1145/3442188.3445922)). Predictions generated by the model may include disturbing and harmful stereotypes across protected classes; identity characteristics; and sensitive, social, and occupational groups.
+
+Current limitations are the quantity of languages available for the model to serve in. 
+
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
+## Recommendations
 
-# gemma-2b-dolly-qa
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+To translate the advice into a target language, we suggest first taking the output from the LLM, and *then* translating it. Trying to get the model to do both simultaneously may result in flawed responses.
 
-This model is a fine-tuned version of [google/gemma-2b](https://huggingface.co/google/gemma-2b) on the generator dataset.
-It achieves the following results on the evaluation set:
-- Loss: 2.0226
 
-## Model description
+# Training Details
+
+## Training Data
+
+Model was trained using the [databricks-dolly-15k](https://huggingface.co/datasets/databricks/databricks-dolly-15k) datbase. This dataset contains a diverse range of question-answer pairs spanning multiple categories, facilitating comprehensive training. By focusing specifically on the question-answer pairs, the model adapts to provide accurate and relevant responses to various inquiries.
+<!-- This should link to a Data 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. -->
+
+## 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
+The dataset underwent preprocessing steps to extract question-answer pairs relevant to the "Question answering" category. This involved filtering the dataset to ensure that the model is fine-tuned on pertinent data, enhancing its ability to provide accurate responses.
+### Speeds, Sizes, Times
+
+<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
+
+Ran through 25 epocs.
+ 
+# Evaluation
+
+<!-- This section describes the evaluation protocols and provides the results. -->
+
+## Testing Data, Factors & Metrics
+
+### Testing Data
+We fed the following prompts into the model
+<!-- This should link to a Data Card if possible. -->
+  "What are the main differences between a vegetarian and a vegan diet?",
+  "What are some effective strategies for managing stress and anxiety?",
+  "Can you explain the concept of blockchain technology in simple terms?",
+  "What are the key factors that influence the price of crude oil in global markets?",
+ "When did Virgin Australia start operating?"
+
+
+## Results 
 
 More information needed
 
-## Intended uses & limitations
+# 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:** Intel XEON hardware
+- **Hours used:** More information needed
+- **Cloud Provider:** Intel Developer cloud
+- **Compute Region:** More information needed
+- **Carbon Emitted:** More information needed
+
+# Technical Specifications [optional]
+
+## Model Architecture and Objective
 
 More information needed
 
-## Training and evaluation data
+## Compute Infrastructure
+
+More information needed
+
+### Hardware
+
+Trained model on Intel Max 1550 GPU
+
+### Software
+
+Developed model using Intel Developer Cloud
+
+# Model Card Authors
+
+Manik Sethi, Britney Nguyen, Mario Miranda
+
+# Model Card Contact
+
+More information needed
+
+# How to Get Started with the Model
+
+Use the code below to get started with the model.
+
+<details>
+<summary> Click to expand </summary>
 
 More information needed
 
-## Training procedure
-
-### Training hyperparameters
-
-The following hyperparameters were used during training:
-- learning_rate: 1e-05
-- train_batch_size: 2
-- eval_batch_size: 8
-- seed: 42
-- gradient_accumulation_steps: 8
-- total_train_batch_size: 16
-- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
-- lr_scheduler_type: linear
-- lr_scheduler_warmup_ratio: 0.05
-- training_steps: 1480
-
-### Training results
-
-| Training Loss | Epoch   | Step | Validation Loss |
-|:-------------:|:-------:|:----:|:---------------:|
-| 2.9171        | 1.6393  | 100  | 2.5622          |
-| 2.4316        | 3.2787  | 200  | 2.2899          |
-| 2.2671        | 4.9180  | 300  | 2.1729          |
-| 2.16          | 6.5574  | 400  | 2.1081          |
-| 2.1232        | 8.1967  | 500  | 2.0763          |
-| 2.0816        | 9.8361  | 600  | 2.0586          |
-| 2.07          | 11.4754 | 700  | 2.0476          |
-| 2.0527        | 13.1148 | 800  | 2.0396          |
-| 2.0445        | 14.7541 | 900  | 2.0343          |
-| 2.0375        | 16.3934 | 1000 | 2.0300          |
-| 2.0299        | 18.0328 | 1100 | 2.0270          |
-| 2.0231        | 19.6721 | 1200 | 2.0248          |
-| 2.0165        | 21.3115 | 1300 | 2.0233          |
-| 2.0221        | 22.9508 | 1400 | 2.0226          |
-
-
-### Framework versions
-
-- PEFT 0.10.0
-- Transformers 4.40.1
-- Pytorch 2.1.0.post0+cxx11.abi
-- Datasets 2.19.0
-- Tokenizers 0.19.1
+</details>