Files
Model-Optimizer/tests/examples/speculative_decoding/test_eagle.py
T
h-guo18 bc52b6cf12 Feat: Support VLLM one-model eagle ckpt; Add unit tests; (#573)
## What does this PR do?

**Type of change:** New feature, new tests; <!-- Use one of the
following: Bug fix, new feature, new example, new tests, documentation.
-->

**Overview:** 
- Add conversion scripts for eagle3 llm-compressor style checkpoint
  - Jira Ticket: https://jirasw.nvidia.com/browse/OMNIML-2866

- Add unit tests for `ar_validate.py`, `export_hf_checkpoint.py`, and
`convert_to_vllm_ckpt.py`.

## Usage
<!-- You can potentially add a usage example below. -->

```python
python scripts/convert_to_vllm_ckpt.py --input <eagle3 ckpt> --verifier <base model> --output <path>
```

## Testing
<!-- Mention how have you tested your change if applicable. -->

## Before your PR is "*Ready for review*"
<!-- If you haven't finished some of the above items you can still open
`Draft` PR. -->

- **Make sure you read and follow [Contributor
guidelines](https://github.com/NVIDIA/TensorRT-Model-Optimizer/blob/main/CONTRIBUTING.md)**
and your commits are signed.
- **Is this change backward compatible?**: Yes/No <!--- If No, explain
why. -->
- **Did you write any new necessary tests?**: Yes/No
- **Did you add or update any necessary documentation?**: Yes/No
- **Did you update
[Changelog](https://github.com/NVIDIA/TensorRT-Model-Optimizer/blob/main/CHANGELOG.rst)?**:
Yes/No <!--- Only for new features, API changes, critical bug fixes or
bw breaking changes. -->

## Additional Information
<!-- E.g. related issue. -->

---------

Signed-off-by: h-guo18 <67671475+h-guo18@users.noreply.github.com>
2025-11-19 14:26:39 -08:00

121 lines
4.3 KiB
Python

# SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import json
import pytest
import safetensors.torch
from _test_utils.examples.run_command import run_example_command
from modelopt.torch.export.plugins.hf_spec_export import EAGLE_MODELOPT_TO_OFFICIAL
@pytest.fixture(scope="module")
def eagle_output_dir(tmp_path_factory):
"""Eagle output directory shared in this module."""
return tmp_path_factory.mktemp("eagle_output_dir")
# fmt: off
def test_llama_eagle3(tiny_llama_path, num_gpus, tiny_daring_anteater_path, tmp_path, eagle_output_dir):
"""Test Eagle3 training with a tiny llama model."""
# Create an ultra-tiny EAGLE config for testing to reduce memory usage
tiny_eagle_config = {
"max_position_embeddings": 128,
"num_hidden_layers": 1,
"intermediate_size": 64,
"num_attention_heads": 2,
"num_key_value_heads": 2,
"head_dim": 64,
}
# Write the tiny config to a temporary file
config_file = tmp_path / "tiny_eagle_config.json"
with open(config_file, "w") as f:
json.dump(tiny_eagle_config, f)
run_example_command(
[
"./launch_train.sh",
"--model", tiny_llama_path,
"--data", tiny_daring_anteater_path,
"--num_epochs", "1",
"--lr", "1e-5",
"--num_gpu", str(num_gpus),
"--mode", "eagle3",
"--eagle_config", str(config_file),
"--output_dir", eagle_output_dir / "eagle-tinyllama",
"--training_seq_len", "128", # Match max_position_embeddings
],
"speculative_decoding",
)
def test_ar_validate(eagle_output_dir):
"""Test in-framework AR evaluation."""
run_example_command(
[
"python", "./scripts/ar_validate.py",
"--model_path", eagle_output_dir / "eagle-tinyllama",
"--osl", "20",
"--num_samples", "10",
"--steps", "3"
],
"speculative_decoding",
)
def test_export_hf_checkpoint(eagle_output_dir):
"""Test export of Eagle3 checkpoint."""
run_example_command(
[
"python", "./scripts/export_hf_checkpoint.py",
"--model_path", eagle_output_dir / "eagle-tinyllama",
"--export_path", eagle_output_dir / "eagle-tinyllama-export",
],
"speculative_decoding",
)
# Check the exported checkpoints have required keys
state_dict = safetensors.torch.load_file(eagle_output_dir / "eagle-tinyllama-export" / "model.safetensors")
for required_key in EAGLE_MODELOPT_TO_OFFICIAL["required"].values():
assert required_key in state_dict, f"Missing key '{required_key}' in state_dict"
def test_convert_to_vllm_ckpt(tiny_llama_path, eagle_output_dir):
"""Test conversion of Eagle3 checkpoint to VLLM one-model checkpoint."""
run_example_command(
[
"python", "./scripts/convert_to_vllm_ckpt.py",
"--input", eagle_output_dir / "eagle-tinyllama-export",
"--verifier", tiny_llama_path,
"--output", eagle_output_dir / "eagle-tinyllama-export-vllm-one-ckpt",
],
"speculative_decoding",
)
@pytest.mark.skip(reason="Needs dataset conversion to role-content format; consolidate data loading first.")
def test_calibrate_draft_vocab(tiny_llama_path, tiny_daring_anteater_path,tmp_path):
"""Test calibration of draft vocabulary."""
run_example_command(
[
"python", "./scripts/calibrate_draft_vocab.py",
"--model", tiny_llama_path,
"--data", tiny_daring_anteater_path,
"--draft_vocab_size", "100",
"--save_dir", tmp_path / "draft_vocab_cache",
],
"speculative_decoding",
)