Update README.md

README.md

@@ -11,21 +11,29 @@ tags: []
 
 ## Model Details
 
-### Model Description
+This model is being made to enhance our work within crewai. We started with a high context length (1048K) version of Llama 3. We then fine-tuned on top of that to get a base agent.
 
-<!-- Provide a longer summary of what this model is. -->
+## Model Description
+
+Built on the following:
+- Models:
+  - [Meta-Llama-3-8B-Instruct](https://huggingface.co/meta-llama/Meta-Llama-3-8B-Instruct)
+  - [Llama-3-8B-Instruct-Gradient-1048k](https://huggingface.co/gradientai/Llama-3-8B-Instruct-Gradient-1048k)
+- Datasets:
+  - m-a-p/CodeFeedback-Filtered-Instruction
+  - RomanTeucher/awesome_topic_code_snippets
+  - dair-ai/emotion
+  - mzbac/function-calling-llama-3-format-v1.1
+  - gretelai/synthetic_text_to_sql
 
 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]
+- **Finetuned from model [Llama-3-8B-Instruct-Gradient-1048k]
 
-### Model Sources [optional]
+## Model Sources [optional]
 
 <!-- Provide the basic links for the model. -->
 
@@ -55,11 +63,6 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 [More Information Needed]
 
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
 
 ### Recommendations
 
@@ -67,133 +70,77 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 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. -->
+## Code Examples
 
-[More Information Needed]
+Use the following format when using the model for inference:
 
-## Evaluation
+```
+<|begin_of_text|><|start_header_id|>system<|end_header_id|>
 
-<!-- This section describes the evaluation protocols and provides the results. -->
+You are the helpful assistant. <|eot_id|><|start_header_id|>user<|end_header_id|>
 
-### Testing Data, Factors & Metrics
+{prompt} <|eot_id|><|start_header_id|>assistant<|end_header_id|>
 
-#### Testing Data
+```
 
-<!-- This should link to a Dataset Card if possible. -->
+Example of multi turn
+```
+<|begin_of_text|><|start_header_id|>system<|end_header_id|>
 
-[More Information Needed]
+You are a helpful AI assistant for travel tips and recommendations<|eot_id|><|start_header_id|>user<|end_header_id|>
 
-#### Factors
+What is France's capital?<|eot_id|><|start_header_id|>assistant<|end_header_id|>
 
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
+Bonjour! The capital of France is Paris!<|eot_id|><|start_header_id|>user<|end_header_id|>
 
-[More Information Needed]
+What can I do there?<|eot_id|><|start_header_id|>assistant<|end_header_id|>
 
-#### Metrics
+Paris, the City of Light, offers a romantic getaway with must-see attractions like the Eiffel Tower and Louvre Museum, romantic experiences like river cruises and charming neighborhoods, and delicious food and drink options, with helpful tips for making the most of your trip.<|eot_id|><|start_header_id|>user<|end_header_id|>
 
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
+Give me a detailed list of the attractions I should visit, and time it takes in each one, to plan my trip accordingly.<|eot_id|><|start_header_id|>assistant<|end_header_id|>
+```
 
-### 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]
+## How to Get Started with the Model
 
-## Model Card Contact
+Use the code below to get started with the model.
 
-[More Information Needed]
+```
+import transformers
+import torch
+
+model_id = "meta-llama/Meta-Llama-3-70B-Instruct"
+
+pipeline = transformers.pipeline(
+    "text-generation",
+    model=model_id,
+    model_kwargs={"torch_dtype": torch.bfloat16},
+    device_map="auto",
+)
+
+messages = [
+    {"role": "system", "content": "You are a pirate chatbot who always responds in pirate speak!"},
+    {"role": "user", "content": "Who are you?"},
+]
+
+prompt = pipeline.tokenizer.apply_chat_template(
+        messages, 
+        tokenize=False, 
+        add_generation_prompt=True
+)
+
+terminators = [
+    pipeline.tokenizer.eos_token_id,
+    pipeline.tokenizer.convert_tokens_to_ids("<|eot_id|>")
+]
+
+outputs = pipeline(
+    prompt,
+    max_new_tokens=256,
+    eos_token_id=terminators,
+    do_sample=True,
+    temperature=0.6,
+    top_p=0.9,
+)
+print(outputs[0]["generated_text"][len(prompt):])
+
+```