TokenSwift
/

TokenSwift-Qwen2.5-7B

@@ -1,199 +1,104 @@
 ---
 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
+pipeline_tag: text-generation
+license: apache-2.0
+tags: [long-sequence-generation, ultra-long-sequence, lossless-acceleration]
 ---
+# Model Card for TokenSwift Models
+TokenSwift is a novel framework designed to substantially accelerate the generation process of ultra-long sequences (up to 100K tokens) while maintaining the target model's inherent quality. This model significantly reduces generation time, offering lossless acceleration for long sequences. It's based on the research presented in [From Hours to Minutes: Lossless Acceleration of Ultra Long Sequence Generation up to 100K Tokens](https://hf.co/papers/2502.18890).
 ## Model Details
+This model is a framework for accelerating ultra-long sequence generation. It is designed to be compatible with various Large Language Models (LLMs) via the HuggingFace Transformers library.
+- **Developed by:** BIGAI-NLCO
+- **Model type:** Long Sequence Generation Accelerator
+- **Language(s) (NLP):** Multiple (supports models trained on various languages)
+- **License:** Apache-2.0
+- **Finetuned from model [optional]:** (Model-specific; varies based on the base model used)
+### Model Sources
+- **Repository:** https://github.com/bigai-nlco/TokenSwift
+- **Paper:** https://arxiv.org/abs/2502.18890
 ## Uses
+TokenSwift is designed to accelerate the generation of ultra-long sequences (up to 100K tokens) for various LLMs. Its key benefit is lossless acceleration, meaning that the generated text quality is identical to that of the underlying LLM.
+### Direct Use
+TokenSwift acts as a wrapper around existing LLMs, speeding up their generation process. It's designed to be easily integrated into existing workflows.  See examples below.
 ## How to Get Started with the Model
+1. **Install:** Follow the installation instructions in the [GitHub repository](https://github.com/bigai-nlco/TokenSwift).
+2. **Download:** Choose a pre-trained TokenSwift model from the Hugging Face Model Hub ([link to models on HuggingFace]).
+3. **Inference:** Use the provided inference script in the repository, adapting the parameters to your needs. See the [GitHub README](https://github.com/bigai-nlco/TokenSwift) for detailed instructions and examples.
+**Example using transformers:**
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+import torch
+model_path = "TokenSwift/TokenSwift-Llama-3.1-8B" # Replace with the actual model path
+tokenizer = AutoTokenizer.from_pretrained(model_path, trust_remote_code=True)
+model = AutoModelForCausalLM.from_pretrained(model_path, torch_dtype=torch.bfloat16, device_map="auto", trust_remote_code=True)
+prompt = "The key to success is"
+input_ids = tokenizer(prompt, return_tensors="pt").input_ids.cuda()
+generated_ids = model.generate(
+    input_ids,
+    max_new_tokens=100,
+    # Add other generation parameters as needed
+)
+generated_text = tokenizer.decode(generated_ids[0], skip_special_tokens=True)
+print(generated_text)
+```
+**Example using TokenSwift command line:**
+```bash
+torchrun  --master-port 1111 --nproc_per_node=1 main.py \
+    --model_type llama3_1 \
+    --ckpt_path your_checkpoint_path \
+    --prefill_len 4096 \
+    --retrival_max_budget 4096 \
+    --gen_len 102400 \
+    --gamma 4 \
+    --min_p 0.1 \
+    --temperature 1.0 \
+    --tree_decoding \
+    --ngram_topk 20 \
+    --penalty 1.2 \
+    --penalty_length 1024 \
+    --prompt_id 0
+  <NOTE: Modify the data and model path>
+```
+## Citation
 **BibTeX:**
+```bibtex
+@misc{tokenswift,
+      title={From Hours to Minutes: Lossless Acceleration of Ultra Long Sequence Generation up to 100K Tokens},
+      author={Tong Wu and Junzhe Shen and Zixia Jia and Yuxuan Wang and Zilong Zheng},
+      year={2025},
+      eprint={2502.18890},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2502.18890},
+}
+```
 **APA:**
+Wu, T., Shen, J., Jia, Z., Wang, Y., & Zheng, Z. (2025). From Hours to Minutes: Lossless Acceleration of Ultra Long Sequence Generation up to 100K Tokens. *arXiv preprint arXiv:2502.18890*.