Sadiah
/

Go-Gourmet

@@ -1,199 +1,91 @@
 ---
 library_name: transformers
-tags: []
 ---
-# 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 is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **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]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## 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.
-## 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:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
 library_name: transformers
+license: cc-by-nc-4.0
+datasets:
+- Sadiah/Go-Gourmet
+language:
+- en
 ---
+# Go-Gourmet Fine-Tuned Mistral 7B Model
+<img src="https://cdn-uploads.huggingface.co/production/uploads/6564e76de6b20bc37e494589/e7-63vc6Rxq6HAMmHXZ5p.png" width="600" alt="Gollum Tonality Fine-Tuned LLAMA-2 7B Model inference code">
+## Overview
+The Go-Gourmet model is a fine-tuned version of the `mistralai/Mistral-7B-Instruct-v0.2` base model with 32k context window, specifically trained to generate structured restaurant cards based on an input of a restaurant name and location. The model has been fine-tuned using a custom dataset of restaurant information to capture relevant details such as cuisine, opening times, location, rating, average price, best dishes, pre-booking requirements, dress code, and website.
 ## Model Details
+* **Base Model**:  `mistralai/Mistral-7B-Instruct-v0.2`.
+* **Fine-Tuning Dataset**: Custom dataset of restaurant information `Sadiah/Go-Gourmet`.
+* **Fine-Tuning Approach**: `QLoRA` and `SFT Trainer`.
+* **Model Size**: The model retains the same size and architecture as the original Mistral base model.
+## Intended Use
+The Go-Gourmet Fine-Tuned Mistral Model is designed to generate structured restaurant cards based on an input of a restaurant name and location. It can be used for various purposes, such as:
+* Generating informative restaurant cards for food and travel applications
+* Providing quick and structured information about restaurants to users
+* Enhancing natural language processing applications related to the food and hospitality industry
+## Limitations and Considerations
+* The model's outputs are generated based on patterns and characteristics learned from the fine-tuning dataset. While it aims to provide accurate and relevant information, the generated restaurant cards may not always be perfect or up-to-date.
+* The model relies on the quality and comprehensiveness of the fine-tuning dataset. If certain details or categories are missing from the dataset, the model may not be able to generate them accurately.
+* The generated restaurant cards should be used as a starting point and should be verified with official sources or the restaurants themselves for the most accurate and current information.
+## Inference Code
+To test and interact with the Go-Gourmet Fine-Tuned Mistral Model, you can use the following inference code:
+```python
+# Load the fine-tuned model from hugging face
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer
+tokenizer_new = AutoTokenizer.from_pretrained("Sadiah/Go-Gourmet")
+model_new = AutoModelForCausalLM.from_pretrained(
+    "Sadiah/Go-Gourmet",
+    trust_remote_code=True,
+    torch_dtype=torch.float16,
+    device_map= {"": 0},
+)
+input_text = '''[INST]Olives, Delhi [/INST]''' #Define instruction
+input_ids = tokenizer_new(input_text, return_tensors="pt") #Tokenize instruction
+input_ids = input_ids.to("cuda") #Move instruction to GPU
+outputs = model_new.generate(**input_ids, max_length=300, num_return_sequences=1, temperature=0) #Generate response
+generated_text = tokenizer_new.decode(outputs[0]) #Decode generated response
+# Find the index of the closing instruction tag and remove the instruction
+instruction_end_index = generated_text.find("[/INST]")
+if instruction_end_index != -1:
+    generated_text = generated_text[instruction_end_index + len("[/INST]"):].strip()
+# Find the index of "Website:" and the end of the website address
+website_start_index = generated_text.find("Website:")
+if website_start_index != -1:
+    website_end_index = generated_text.find("\n", website_start_index)
+    if website_end_index == -1:
+        website_end_index = len(generated_text)
+    truncated_text = generated_text[:website_end_index]
+    print(truncated_text.strip())
+else:
+    print(generated_text)
+```
+```
+Name: Olives, Delhi
+Cuisine: Mediterranean
+Opening Times: Mon-Sun: 12:30pm-3:30pm, 7pm-11:30pm
+Location: 1, Kalka Das Marg, New Delhi, Delhi 110001, India (28.7031, 77.1123)
+Rating: 4.3 (Source: Zomato)
+Average Price Per Person: Moderate
+Three Best Dishes:
+1. Grilled Halloumi Cheese: A popular Mediterranean cheese, grilled to perfection.
+2. Falafel Platter: A selection of crispy, flavorful falafel balls served with hummus and pita bread.
+3. Lamb Shank Tagine: Slow-cooked lamb shank in a rich, aromatic sauce.
+Pre-Booking Needed: Recommended, especially for dinner
+Dress Code: Casual
+Website: http://www.olivesdelhi.com/
+```
+This code snippet allows you to provide an input of a restaurant name and location and generate a structured restaurant card using the Go-Gourmet Fine-Tuned Mistral Model.
+## Contact and Feedback
+If you have any questions, feedback, or concerns regarding the Go-Gourmet Fine-Tuned Mistral Model, please contact me at https://www.sadiahzahoor.com/contact .