NexaAIDev
/

octo-net

@@ -1,199 +1,124 @@
 ---
-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: microsoft/Phi-3
+model-index:
+- name: Octopus-V4-3B
+  results: []
+tags:
+- AI agent
+- Graph
+inference: false
+space: false
+spaces: false
+language:
+- en
 ---
+# Octopus V4: Graph of language models
+## Octopus V4
+<p align="center">
+- <a href="https://www.nexa4ai.com/" target="_blank">Nexa AI Website</a>
+- <a href="https://www.nexa4ai.com/" target="_blank">Octopus-v4 Github</a>
+- <a href="https://arxiv.org/abs/2404.01744" target="_blank">ArXiv</a>
+</p>
+<p align="center" width="100%">
+  <a><img src="octopus-v4-logo.png" alt="nexa-octopus" style="width: 40%; min-width: 300px; display: block; margin: auto;"></a>
+</p>
+## Introduction
+Octopus-V4-3B, an advanced open-source language model with 3 billion parameters, serves as the master node in Nexa AI's envisioned graph of language models. Tailored specifically for the MMLU benchmark topics, this model efficiently translates user queries into formats that specialized models can effectively process. It excels at directing these queries to the appropriate specialized model, ensuring precise and effective query handling.
+📱 **Compact Size**: Octopus-V4-3B is compact, enabling it to operate on smart devices efficiently and swiftly.
+🐙 **Accuracy**: Octopus-V4-3B accurately maps user queries to the specialized model using a functional token design, enhancing its precision.
+💪 **Reformat Query**: Octopus-V4-3B assists in converting natural human language into a more professional format, improving query description and resulting in more accurate responses.
+## Example Use Cases
+<p align="center" width="100%">
+<a><img src="tool-usage.png" alt="ondevice" style="width: 80%; min-width: 300px; display: block; margin: auto;"></a>
+</p>
+You can run the model on a GPU using the following code.
+```python
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer
+import time
+import warnings
+warnings.filterwarnings("ignore")
+torch.random.manual_seed(0)
+import json
+model = AutoModelForCausalLM.from_pretrained(
+    "NexaAIDev/Octopus-v4",
+    device_map="cuda:0",
+    torch_dtype=torch.bfloat16,
+    trust_remote_code=True
+)
+tokenizer = AutoTokenizer.from_pretrained("NexaAIDev/octopus-v4-finetuned-v1")
+question = "Tell me the result of derivative of x^3 when x is 2?"
+inputs = f"<|system|>You are a router. Below is the query from the users, please call the correct function and generate the parameters to call the function.<|end|><|user|>{question}<|end|><|assistant|>"
+print(inputs)
+print('\n============= Below is the response ==============\n')
+# You should consider to use early stopping with <nexa_end> token to accelerate
+input_ids = tokenizer(inputs, return_tensors="pt")['input_ids'].to(model.device)
+generated_token_ids = []
+start = time.time()
+# set a large enough number here to avoid insufficient length
+for i in range(200):
+    next_token = model(input_ids).logits[:, -1].argmax(-1)
+    generated_token_ids.append(next_token.item())
+    input_ids = torch.cat([input_ids, next_token.unsqueeze(1)], dim=-1)
+    if "<nexa_end>" in tokenizer.decode(generated_token_ids):
+        break
+print(tokenizer.decode(generated_token_ids))
+end = time.time()
+print(f'Elapsed time: {end - start:.2f}s')
+```
+## License
+This model was trained on commercially viable data. For use of our model, refer to the [license information](https://www.nexa4ai.com/licenses).
+## References
+We thank the Microsoft team for their amazing model!
+```
+@article{abdin2024phi,
+  title={Phi-3 Technical Report: A Highly Capable Language Model Locally on Your Phone},
+  author={Abdin, Marah and Jacobs, Sam Ade and Awan, Ammar Ahmad and Aneja, Jyoti and Awadallah, Ahmed and Awadalla, Hany and Bach, Nguyen and Bahree, Amit and Bakhtiari, Arash and Behl, Harkirat and others},
+  journal={arXiv preprint arXiv:2404.14219},
+  year={2024}
+}
+```
+## Citation
+```
+@misc{chen2024octopus,
+      title={Octopus v2: On-device language model for super agent},
+      author={Wei Chen and Zhiyuan Li},
+      year={2024},
+      eprint={2404.01744},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+```
+## Contact
+Please [contact us](mailto:[email protected]) to reach out for any issues and comments!