Skip to content
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ examples/csharp/ModelChat/models
!test/test_models/qwen3-vl-vision-preprocessing/*.onnx
!test/test_models/qwen35-hybrid-preprocessing/
!test/test_models/qwen35-hybrid-preprocessing/*.onnx
!test/test_models/webgpu/
!test/test_models/webgpu/tiny-graph-capture-gqa/
!test/test_models/webgpu/tiny-graph-capture-gqa/*.onnx

.ipynb_checkpoints/
/src/java/.gradle
Expand Down
55 changes: 41 additions & 14 deletions src/models/position_inputs.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -380,23 +380,50 @@ void DefaultPositionInputs::InitializeSequenceLengths(std::array<int64_t, 2> sha
}

void DefaultPositionInputs::RewindMask(size_t index) {
Comment thread
qjia7 marked this conversation as resolved.
if (state_.params_->use_graph_capture) {
throw std::runtime_error("PositionInputs::RewindMask - Static buffer is not supported for continuous decoding.");
#if 0 // TODO: Fix implementation, cudaMemsetAsync of 1 is setting bytes of 1 vs int32's of 1
int past_length = static_cast<int>(index);
int max_length = static_cast<int>(state_.params_->search.max_length);
cudaMemsetAsync(attention_mask_->GetTensorMutableRawData(),
0,
(type_ == Ort::TypeToTensorType<int32_t> ? sizeof(int32_t) : sizeof(int64_t)) * max_length,
model_.cuda_stream_);
cudaMemsetAsync(attention_mask_->GetTensorMutableRawData(),
1,
(type_ == Ort::TypeToTensorType<int32_t> ? sizeof(int32_t) : sizeof(int64_t)) * past_length,
model_.cuda_stream_);
#endif
if (ShouldUseStaticMaskHandling()) {
// Static mask layout: [batch_beam_size, max_length]
// Rewind to index: write 1s for [0, index), 0s for [index, max_length)
Comment thread
qjia7 marked this conversation as resolved.
size_t max_len = static_cast<size_t>(state_.params_->search.max_length);
if (index > max_len) {
throw std::runtime_error("RewindMask: index exceeds max_length");
}
size_t batch_beam_size = static_cast<size_t>(attention_mask_shape_[0]);
auto byte_span = attention_mask_->GetByteSpan();
auto cpu_data = byte_span.CpuSpan();
if (type_ == Ort::TypeToTensorType<int32_t>) {
auto* data = reinterpret_cast<int32_t*>(cpu_data.data());
Comment thread
baijumeswani marked this conversation as resolved.
for (size_t i = 0; i < batch_beam_size; i++) {
std::fill_n(data + i * max_len, index, static_cast<int32_t>(1));
std::fill_n(data + i * max_len + index, max_len - index, static_cast<int32_t>(0));
}
Comment thread
qjia7 marked this conversation as resolved.
} else {
auto* data = reinterpret_cast<int64_t*>(cpu_data.data());
Comment thread
baijumeswani marked this conversation as resolved.
for (size_t i = 0; i < batch_beam_size; i++) {
std::fill_n(data + i * max_len, index, static_cast<int64_t>(1));
std::fill_n(data + i * max_len + index, max_len - index, static_cast<int64_t>(0));
}
}
byte_span.CopyCpuToDevice();
return;
}

// Dynamic mask: adjust shape so the next Update() creates the correct-sized tensor.
// For batch_beam_size == 1 (the only case RewindTo supports), the CPU UpdateAttentionMask
// fills the entire next mask with 1s, so no data fixup is needed - just the shape.
attention_mask_shape_[1] = static_cast<int64_t>(index);
}

// Returns true when the attention mask is a fixed-size [batch_beam_size, max_length] buffer
// that must be updated in-place (write 1s/0s) rather than re-created per step.
// Currently triggered by:
// - DML (always uses graph capture, see IsGraphCaptureEnabled in config.cpp)
// - WebGPU with enableGraphCapture=1 in provider options
// - NvTensorRtRtx with past-present shared buffers
// Not yet using this path:
// - CUDA: graph capture is currently disabled in GenAI due to bugs
// (IsGraphCaptureEnabled throws for CUDA). Once re-enabled, RewindMask's
// static path will work for CUDA as well since it uses device-agnostic
// CpuSpan/CopyCpuToDevice.
bool DefaultPositionInputs::ShouldUseStaticMaskHandling() const {
return state_.params_->use_graph_capture ||
(state_.params_->IsPastPresentShareBufferEnabled(model_.config_->model.type) &&
Expand Down
43 changes: 43 additions & 0 deletions src/webgpu/interface.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,11 @@ struct InterfaceImpl : DeviceInterface {
private:
Ort::Allocator* ort_allocator_{};
const OrtMemoryInfo* ort_memory_info_{};
// Reusable CPU staging buffers for UpdateAttentionMask, pre-filled with 1s.
// Content is always all 1s so sharing across generators is safe; only upload_bytes
// worth of data is copied each call, regardless of buffer capacity.
std::vector<int32_t> mask_staging_buffer_i32_;
std::vector<int64_t> mask_staging_buffer_i64_;
Comment thread
qjia7 marked this conversation as resolved.

Comment thread
qjia7 marked this conversation as resolved.
public:
Ort::Allocator& GetAllocator() override {
Expand All @@ -190,6 +195,44 @@ struct InterfaceImpl : DeviceInterface {

void Synchronize() override {} // Nothing to do?

bool UpdateAttentionMask(void* next_mask_data, void* mask_data, int batch_beam_size, int new_kv_length, int total_length, int max_length, bool update_only, ONNXTensorElementDataType type) override {
Comment thread
kunal-vaishnavi marked this conversation as resolved.
Outdated
if (batch_beam_size != 1 || !update_only) {
return false; // Fall back to CPU for multi-beam or non-static mask
}
// For batch_beam_size == 1 with static mask (update_only=true, no padding),
// the mask is always all 1s for attended positions.
size_t num_elements = static_cast<size_t>(total_length);
size_t upload_bytes;
void* staging_data;

// Use the correctly typed staging buffer. Each grows monotonically and
// only newly extended positions need to be filled with 1.
if (type == Ort::TypeToTensorType<int32_t>) {
if (mask_staging_buffer_i32_.size() < num_elements) {
mask_staging_buffer_i32_.resize(num_elements, static_cast<int32_t>(1));
}
staging_data = mask_staging_buffer_i32_.data();
upload_bytes = num_elements * sizeof(int32_t);
} else {
if (mask_staging_buffer_i64_.size() < num_elements) {
mask_staging_buffer_i64_.resize(num_elements, static_cast<int64_t>(1));
}
staging_data = mask_staging_buffer_i64_.data();
upload_bytes = num_elements * sizeof(int64_t);
}

int64_t shape_val = static_cast<int64_t>(upload_bytes);
std::span<const int64_t> shape{&shape_val, 1};
auto cpu_mem_info = OrtMemoryInfo::CreateCpu(OrtDeviceAllocator, OrtMemTypeDefault);
auto src_tensor = OrtValue::CreateTensor(*cpu_mem_info, staging_data, upload_bytes, shape, ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8);
auto dst_tensor = OrtValue::CreateTensor(*ort_memory_info_, mask_data, upload_bytes, shape, ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8);
Comment thread
qjia7 marked this conversation as resolved.
const std::vector<const OrtValue*> src_ptrs = {src_tensor.get()};
const std::vector<OrtValue*> dst_ptrs = {dst_tensor.get()};
Comment thread
qjia7 marked this conversation as resolved.
Outdated
GetOrtEnv().CopyTensors(src_ptrs, dst_ptrs, nullptr);

return true;
}

bool Cast(void* input, void* output, ONNXTensorElementDataType input_type, ONNXTensorElementDataType output_type, size_t element_count) override {
if (!ort_allocator_) {
throw std::runtime_error("WebGPU allocator not initialized");
Expand Down
102 changes: 102 additions & 0 deletions test/c_api_tests.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1334,6 +1334,108 @@ TEST(CAPITests, RewindGptFp32CAPI) {
}
#endif

// Test RewindTo with static mask handling via NvTensorRtRtx past-present share buffer.
// Skipped when the phi3-fp16-nvtrt model is not available (CI-only model).
TEST(CAPITests, RewindGraphCaptureNvTensorRtRtxCAPI) {
std::string nvtrt_path = MODEL_PATH "hf-internal-testing/phi3-fp16-nvtrt";
if (!std::filesystem::exists(nvtrt_path)) {
GTEST_SKIP() << "NvTensorRtRtx model not available at " << nvtrt_path;
}

auto config = OgaConfig::Create(nvtrt_path.c_str());
config->ClearProviders();
config->AppendProvider("NvTensorRtRtx");

int max_length = 20;

auto model = OgaModel::Create(*config);
auto params = OgaGeneratorParams::Create(*model);
params->SetSearchOption("max_length", max_length);

std::vector<int32_t> input_ids{1, 15043, 29892, 920};

auto generator = OgaGenerator::Create(*model, *params);
generator->AppendTokens(input_ids.data(), input_ids.size());
while (!generator->IsDone()) {
generator->GenerateNextToken();
}

auto seq_len = generator->GetSequenceCount(0);
std::vector<int32_t> first_output(seq_len);
std::memcpy(first_output.data(), generator->GetSequenceData(0), seq_len * sizeof(int32_t));

generator->RewindTo(0);
generator->AppendTokens(input_ids.data(), input_ids.size());
while (!generator->IsDone()) {
generator->GenerateNextToken();
}

auto seq_len2 = generator->GetSequenceCount(0);
ASSERT_EQ(seq_len2, seq_len);
EXPECT_TRUE(0 == std::memcmp(first_output.data(), generator->GetSequenceData(0), seq_len * sizeof(int32_t)));

generator->RewindTo(6);
while (!generator->IsDone()) {
generator->GenerateNextToken();
}

seq_len2 = generator->GetSequenceCount(0);
ASSERT_EQ(seq_len2, seq_len);
EXPECT_TRUE(0 == std::memcmp(first_output.data(), generator->GetSequenceData(0), seq_len * sizeof(int32_t)));
}

// Test RewindTo with a tiny GQA model configured for graph capture.
// Uses a checked-in 1-layer model with GroupQueryAttention, enableGraphCapture=1,
// and past_present_share_buffer=true. This exercises ShouldUseStaticMaskHandling()
// without requiring a specific GPU or large model download.
#if USE_WEBGPU
TEST(CAPITests, RewindGraphCaptureGqaCAPI) {
std::string model_path = MODEL_PATH "webgpu/tiny-graph-capture-gqa";
if (!std::filesystem::exists(model_path)) {
GTEST_SKIP() << "tiny-graph-capture-gqa model not found at " << model_path;
}

int max_length = 20;
std::vector<int32_t> input_ids{10, 20, 30, 40, 50};

auto model = OgaModel::Create(model_path.c_str());
auto params = OgaGeneratorParams::Create(*model);
params->SetSearchOption("max_length", max_length);

auto generator = OgaGenerator::Create(*model, *params);
generator->AppendTokens(input_ids.data(), input_ids.size());
while (!generator->IsDone()) {
generator->GenerateNextToken();
}

// Save first-run output
auto seq_len = generator->GetSequenceCount(0);
std::vector<int32_t> first_output(seq_len);
std::memcpy(first_output.data(), generator->GetSequenceData(0), seq_len * sizeof(int32_t));

// RewindTo(0) — full rewind with static mask handling
generator->RewindTo(0);
generator->AppendTokens(input_ids.data(), input_ids.size());
while (!generator->IsDone()) {
generator->GenerateNextToken();
}

auto seq_len2 = generator->GetSequenceCount(0);
ASSERT_EQ(seq_len2, seq_len);
EXPECT_TRUE(0 == std::memcmp(first_output.data(), generator->GetSequenceData(0), seq_len * sizeof(int32_t)));

// RewindTo(7) — partial rewind, continue generating
generator->RewindTo(7);
while (!generator->IsDone()) {
generator->GenerateNextToken();
}

seq_len2 = generator->GetSequenceCount(0);
ASSERT_EQ(seq_len2, seq_len);
EXPECT_TRUE(0 == std::memcmp(first_output.data(), generator->GetSequenceData(0), seq_len * sizeof(int32_t)));
}
#endif // USE_WEBGPU

#ifndef STREAMING_ASR_PATH
#define STREAMING_ASR_PATH MODEL_PATH "nemotron-speech-streaming"
#endif
Expand Down
49 changes: 49 additions & 0 deletions test/python/test_onnxruntime_genai_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,55 @@ def test_rewind(test_data_path, relative_model_path):
assert np.array_equal(expected_sequence, generator.get_sequence(0))


@pytest.mark.skipif(
not og.is_webgpu_available(),
reason="WebGPU EP not available, graph capture RewindTo test requires WebGPU",
)
@pytest.mark.parametrize(
"relative_model_path",
([Path("webgpu") / "tiny-graph-capture-gqa"]),
)
def test_rewind_graph_capture(test_data_path, relative_model_path):
"""Test RewindTo with graph capture enabled (static mask handling via GQA model)."""
model_path = os.fspath(Path(test_data_path) / relative_model_path)
if not os.path.exists(model_path):
pytest.skip(f"Graph capture test model not found at {model_path}")

try:
model = og.Model(model_path)
except RuntimeError as e:
if "not supported in this build" in str(e):
pytest.skip(f"WebGPU EP not functional in this build: {e}")
raise
max_length = 20
input_ids = np.array([[10, 20, 30, 40, 50]], dtype=np.int32)

search_params = og.GeneratorParams(model)
search_params.set_search_options(do_sample=False, max_length=max_length, batch_size=1)

generator = og.Generator(model, search_params)
generator.append_tokens(input_ids)
while not generator.is_done():
generator.generate_next_token()

first_output = generator.get_sequence(0).copy()

# Full rewind with static mask handling
generator.rewind_to(0)
generator.append_tokens(input_ids)
while not generator.is_done():
generator.generate_next_token()

assert np.array_equal(first_output, generator.get_sequence(0))

# Partial rewind
generator.rewind_to(7)
while not generator.is_done():
generator.generate_next_token()

assert np.array_equal(first_output, generator.get_sequence(0))


# Test Model Loading with No Chat Template


Expand Down
Loading
Loading