NexaAIDev
/

Squid

@@ -1,199 +1,89 @@
 ---
-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: cc-by-nc-4.0
+base_model: Qwen/Qwen2-7B-Instruct
+model-index:
+- name: Dolphin
+  results: []
+tags:
+- RAG
+- on-device language model
+- Retrieval Augmented Generation
+inference: false
+space: false
+spaces: false
+language:
+- en
 ---
+# Dolphin: Long Context as a New Modality for Energy-Efficient On-Device Language Models
+<p align="center">
+- <a href="https://www.nexaai.com/models" target="_blank">Nexa Model Hub</a>
+- <a href="https://arxiv.org/abs/2404.01744" target="_blank">ArXiv</a>
+</p>
+<p align="center" width="100%">
+  <a><img src="logo.png" alt="nexa-octopus" style="width: 30%; min-width: 300px; display: block; margin: auto;"></a>
+</p>
+## Overview
+Dolphin is a novel approach to accelerate language model inference by treating long context as a new modality, similar to image, audio, and video modalities in vision-language models. This innovative method incorporates a language encoder model to encode context information into embeddings, applying multimodal model concepts to enhance the efficiency of language model inference。 Below are model highlights:
+- 🧠 Context as a distinct modality
+- 🗜️ Language encoder for context compression
+- 🔗 Multimodal techniques applied to language processing
+- ⚡ Optimized for energy efficiency and on-device use
+- 📜 Specialized for long context understanding
+## Model Architecture
+Dolphin employs a decoder-decoder framework with two main components:
+1. A smaller decoder (0.5B parameters) for transforming information from extensive contexts
+2. A larger decoder (7B parameters) for comprehending and generating responses to current queries
+3. The architecture also includes a projector to align embeddings between the text encoder and the main decoder.
+![Model Architecture](modelstructure.jpg)
+## Running the Model
+```python
+from transformers import AutoTokenizer
+from configuration_dolphin import DolphinForCausalLM
+import time
+tokenizer = AutoTokenizer.from_pretrained('nexa-collaboration/dolphin_instruct_1M_0805', trust_remote_code=True)
+model = DolphinForCausalLM.from_pretrained('nexa-collaboration/dolphin_instruct_1M_0805', trust_remote_code=True)
+def inference(input_text):
+    inputs = tokenizer(input_text, return_tensors="pt")
+    outputs = model.generate(**inputs, max_new_tokens=100)
+    return tokenizer.decode(outputs[0], skip_special_tokens=True)
+input_text = "Take a selfie for me with front camera"
+nexa_query = f"Below is the query from the users, please call the correct function and generate the parameters to call the function.\n\nQuery: {input_text} \n\nResponse:"
+start_time = time.time()
+result = inference(nexa_query)
+print("Dolphin model result:\n", result)
+print("Latency:", time.time() - start_time, "s")
+```
+## Training Process
+Dolphin's training involves three stages:
+1. Restoration Training: Reconstructing original context from compressed embeddings
+2. Continual Training: Generating context continuations from partial compressed contexts
+3. Instruction Fine-tuning: Generating responses to queries given compressed contexts
+This multi-stage approach progressively enhances the model's ability to handle long contexts and generate appropriate responses.
+## Citation
+If you use Dolphin in your research, please cite our paper:
+```bibtex
+@article{dolphin2024,
+  title={Dolphin: Long Context as a New Modality for Energy-Efficient On-Device Language Models},
+  author={[Author Names]},
+  journal={arXiv preprint arXiv:[paper_id]},
+  year={2024}
+}
+```
+## Contact
+For questions or feedback, please [contact us]([email protected])

logo.png ADDED Viewed

modelstructure.jpg ADDED Viewed