awels
/

merlinLLM-4b-128k

@@ -1,199 +1,83 @@
 ---
-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]

 ---
+license: mit
+base_model: microsoft/Phi-3-mini-128k-instruct
+library_name: adapters
+datasets:
+- awels/druidai_admin_dataset
+language:
+- en
+widget:
+- text: Who are you, Merlin ?
+tags:
+- awels
+- druidai
 ---
+# Merlin Model Card
 ## Model Details
+**Model Name:** Merlin
+**Model Type:** Transformer-based leveraging Microsoft Phi 3b 128k tokens
+**Publisher:** Awels Engineering
+**License:** MIT
+**Model Description:**
+Merlin is a sophisticated model designed to help as an AI agent focusing on the Druid AI Conversational platform. It leverages advanced machine learning techniques to provide efficient and accurate solutions. It has been trained on the full docments corpus of Druid 7.14.
+## Dataset
+**Dataset Name:** [awels/druidai_admin_dataset](https://huggingface.co/datasets/awels/druidai_admin_dataset)
+**Dataset Source:** Hugging Face Datasets
+**Dataset License:** MIT
+**Dataset Description:**
+The dataset used to train Merlin consists of all the public documents available on the Druid AI Conversational Platform. This dataset is curated to ensure a comprehensive representation of typical administrative and development scenarios encountered in Druid AI Platform.
 ## Training Details
+**Training Data:**
+The training data includes 33,000 Questions and Answers generated by the [Bonito LLM](https://github.com/BatsResearch/bonito). The dataset is split into 3 sets of data (training, test and validation) to ensure robust model performance.
+**Training Procedure:**
+Thready was trained using supervised learning with cross-entropy loss and the Adam optimizer. The training involved 1 epoch, a batch size of 4, a learning rate of 5.0e-06, and a cosine learning rate scheduler with gradient checkpointing for memory efficiency.
+**Hardware:**
+The model was trained on a single NVIDIA RTX 4090 graphic card.
+**Framework:**
+The training was conducted using PyTorch.
 ## Evaluation
+**Evaluation Metrics:**
+Thready was evaluated on the training dataset:
+> epoch                    =        1.0
+  total_flos               = 33926962GF
+  train_loss               =     2.8776
+  train_runtime            = 0:19:34.86
+  train_samples_per_second =     21.546
+  train_steps_per_second   =      5.387
+**Performance:**
+The model achieved the following results on the evaluation dataset:
+> epoch                   =        1.0
+  eval_loss               =     2.3814
+  eval_runtime            = 0:01:04.90
+  eval_samples            =       5298
+  eval_samples_per_second =     98.718
+  eval_steps_per_second   =     24.683
+## Intended Use
+**Primary Use Case:**
+Merlin is intended to be used locally in an agent swarm to colleborate together to solve Druid AI Conversational platform related problems.
+**Limitations:**
+While Merlin is highly effective, it may have limitations due to the model size. An 8b model based on Llama 3 is used internally at Awels Engineering.