- add BatchedStreamCallback sink type: TaskManager resolves a decode step's (task_id, token) events under one lock and delivers each sink a single list instead of one call per token - keep the plain Callable[[str]] callback contract: per-token callbacks still receive one call per event, and invoke_callback/cancel_task wrap single events for batched sinks - collect aborted, text, and finish STOP events in the scheduler decode loop and dispatch once per step instead of once per token - register one _ResultSink per generate call (replacing per-task closures) so GenerateResult takes its lock and wakes waiters once per step, with late-bind replay for tasks that start decoding before add_task returns their id - apply GenerateResult batches under a single condition hold via append_batch; append delegates to it - update engine test fakes to the batched contract and add coverage for event grouping, single-event dispatch, cancel STOP, and late-bind replay Benchmark: NVIDIA L20 (idle), CUDA 12.8, torch 2.11.0+cu128, 1.2B bf16 checkpoint, prompt 512, 256 greedy tokens, CUDA graph on, serving-level decode, 3 trials - batch 32: 7.808 -> 7.506 ms/token (4098 -> 4263 batch tok/s, +4.0%) - batch 1/8: unchanged within noise (3.768 -> 3.797 / 4.699 -> 4.607 ms/token) - full suite: 896 passed
409 lines
12 KiB
Python
409 lines
12 KiB
Python
"""Unit tests for GenerateResult accumulator and InferenceEngine.generate()."""
|
|
|
|
import asyncio
|
|
import itertools
|
|
import threading
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
import pytest
|
|
|
|
from astrai.extension import TorchNativeBackend, attn_backend
|
|
from astrai.inference import STOP
|
|
from astrai.inference.engine import (
|
|
GenerateResult,
|
|
InferenceEngine,
|
|
_ResultSink,
|
|
build_engine,
|
|
)
|
|
from tests.helpers import FakeTokenizer, make_model
|
|
|
|
|
|
def _make_engine_mocks(decode=None):
|
|
"""Build the standard mock model/tokenizer pair used by engine tests."""
|
|
mock_model = MagicMock()
|
|
mock_tokenizer = MagicMock()
|
|
mock_tokenizer.encode.return_value = [1, 2, 3]
|
|
mock_tokenizer.stop_ids = [0]
|
|
if decode is not None:
|
|
mock_tokenizer.decode.return_value = decode
|
|
return mock_model, mock_tokenizer
|
|
|
|
|
|
def test_result_append_multiple_tasks():
|
|
r = GenerateResult(count=3)
|
|
r.append("a", 0)
|
|
r.append("b", 1)
|
|
r.append("c", 2)
|
|
assert r.results[0] == "a"
|
|
assert r.results[1] == "b"
|
|
assert r.results[2] == "c"
|
|
|
|
|
|
def test_result_stop_marks_complete():
|
|
r = GenerateResult(count=2)
|
|
r.append("text", 0)
|
|
r.append(STOP, 0)
|
|
r.append("more", 1)
|
|
assert r._done[0] is True
|
|
assert r._done[1] is False
|
|
assert r._completed == 1
|
|
|
|
|
|
def test_result_stop_does_not_double_count():
|
|
r = GenerateResult(count=1)
|
|
r.append(STOP, 0)
|
|
r.append(STOP, 0)
|
|
assert r._completed == 1
|
|
|
|
|
|
def test_result_append_batch_updates_state_in_one_commit():
|
|
r = GenerateResult(count=2)
|
|
r.append_batch([(0, "he"), (1, "wo"), (0, "llo"), (1, "rld")])
|
|
r.append_batch([(0, STOP), (1, STOP)])
|
|
assert r.results == ["hello", "world"]
|
|
assert r._completed == 2
|
|
assert r.pop_all() == [
|
|
(0, "he"),
|
|
(1, "wo"),
|
|
(0, "llo"),
|
|
(1, "rld"),
|
|
(0, STOP),
|
|
(1, STOP),
|
|
]
|
|
|
|
|
|
def test_result_sink_replays_events_arriving_before_bind():
|
|
r = GenerateResult(count=1)
|
|
sink = _ResultSink(r)
|
|
sink([("t0", "he")]) # task id not bound yet: buffered, not applied
|
|
assert r.results == [""]
|
|
sink.bind("t0", 0)
|
|
sink([("t0", "llo"), ("t0", STOP)])
|
|
assert r.results == ["hello"]
|
|
assert r._completed == 1
|
|
|
|
|
|
def test_result_pop_all_returns_and_clears():
|
|
r = GenerateResult(count=2)
|
|
r.append("a", 0)
|
|
r.append("b", 1)
|
|
out = r.pop_all()
|
|
assert len(out) == 2
|
|
assert out[0] == (0, "a")
|
|
assert out[1] == (1, "b")
|
|
assert r.pop_all() == []
|
|
|
|
|
|
def test_result_wait_blocks_until_data():
|
|
r = GenerateResult(count=1)
|
|
|
|
def delayed_append():
|
|
import time
|
|
|
|
time.sleep(0.05)
|
|
r.append("delayed", 0)
|
|
|
|
t = threading.Thread(target=delayed_append)
|
|
t.start()
|
|
ok = r.wait(timeout=5.0)
|
|
t.join()
|
|
assert ok
|
|
assert r.results[0] == "delayed"
|
|
|
|
|
|
def test_result_wait_timeout():
|
|
r = GenerateResult(count=1)
|
|
ok = r.wait(timeout=0.01)
|
|
assert not ok
|
|
|
|
|
|
def test_result_wait_completion_non_streaming():
|
|
r = GenerateResult(count=2)
|
|
|
|
def finish_later():
|
|
import time
|
|
|
|
time.sleep(0.05)
|
|
r.append(STOP, 0)
|
|
time.sleep(0.05)
|
|
r.append(STOP, 1)
|
|
|
|
t = threading.Thread(target=finish_later)
|
|
t.start()
|
|
r.wait_completion()
|
|
t.join()
|
|
assert r._completed == 2
|
|
|
|
|
|
def test_result_get_results():
|
|
r = GenerateResult(count=2)
|
|
r.append("hello", 0)
|
|
r.append("world", 1)
|
|
results = r.get_results()
|
|
assert results == ["hello", "world"]
|
|
|
|
|
|
def test_engine_generate_non_streaming_single():
|
|
mock_model, mock_tokenizer = _make_engine_mocks(decode="response")
|
|
|
|
with patch("astrai.inference.engine.InferenceScheduler") as MockSched:
|
|
instance = MockSched.return_value
|
|
|
|
def fake_add(prompt, **kw):
|
|
cb = kw["stream_callback"]
|
|
cb([("task-1", "response"), ("task-1", STOP)])
|
|
return "task-1"
|
|
|
|
instance.add_task.side_effect = fake_add
|
|
instance.remove_task.return_value = []
|
|
|
|
eng = InferenceEngine(mock_model, mock_tokenizer, max_batch_size=1)
|
|
result = eng.generate("hello")
|
|
assert result == "response"
|
|
|
|
|
|
def test_engine_generate_streaming_yields_tokens():
|
|
mock_model, mock_tokenizer = _make_engine_mocks(decode="tok")
|
|
|
|
callbacks_saved = []
|
|
|
|
def capture_cb(prompt, **kw):
|
|
callbacks_saved.append(kw.get("stream_callback"))
|
|
return "task-0"
|
|
|
|
with patch("astrai.inference.engine.InferenceScheduler") as MockSched:
|
|
instance = MockSched.return_value
|
|
instance.add_task.side_effect = capture_cb
|
|
instance.remove_task.return_value = []
|
|
|
|
eng = InferenceEngine(mock_model, mock_tokenizer, max_batch_size=1)
|
|
gen = eng.generate("hello", stream=True)
|
|
|
|
cb = callbacks_saved[0]
|
|
cb([("task-0", "t1")])
|
|
cb([("task-0", "t2")])
|
|
cb([("task-0", STOP)])
|
|
|
|
tokens = list(gen)
|
|
assert tokens == ["t1", "t2"]
|
|
|
|
|
|
def test_engine_stream_close_cancels_unfinished_task():
|
|
mock_model, mock_tokenizer = _make_engine_mocks(decode="tok")
|
|
callbacks_saved = []
|
|
|
|
def capture_cb(prompt, **kwargs):
|
|
callbacks_saved.append(kwargs["stream_callback"])
|
|
return "task-1"
|
|
|
|
with patch("astrai.inference.engine.InferenceScheduler") as MockSched:
|
|
instance = MockSched.return_value
|
|
instance.add_task.side_effect = capture_cb
|
|
|
|
engine = InferenceEngine(mock_model, mock_tokenizer, max_batch_size=1)
|
|
stream = engine.generate("hello", stream=True)
|
|
|
|
callbacks_saved[0]([("task-1", "t1")])
|
|
assert next(stream) == "t1"
|
|
stream.close()
|
|
|
|
instance.cancel_task.assert_called_once_with("task-1")
|
|
|
|
|
|
def test_engine_generate_async_yields_tokens_until_stop():
|
|
mock_model, mock_tokenizer = _make_engine_mocks(decode="tok")
|
|
callbacks_saved = []
|
|
|
|
def capture_cb(prompt, **kw):
|
|
callbacks_saved.append(kw.get("stream_callback"))
|
|
return "task-0"
|
|
|
|
with patch("astrai.inference.engine.InferenceScheduler") as MockSched:
|
|
instance = MockSched.return_value
|
|
instance.add_task.side_effect = capture_cb
|
|
instance.remove_task.return_value = []
|
|
|
|
eng = InferenceEngine(mock_model, mock_tokenizer, max_batch_size=1)
|
|
agen = eng.generate_async("hello")
|
|
|
|
async def collect():
|
|
out = []
|
|
async for token in agen:
|
|
out.append(token)
|
|
return out
|
|
|
|
cb = callbacks_saved[0]
|
|
cb([("task-0", "t1")])
|
|
cb([("task-0", "t2")])
|
|
cb([("task-0", STOP)])
|
|
|
|
assert asyncio.run(collect()) == ["t1", "t2"]
|
|
|
|
|
|
def test_engine_async_close_cancels_unfinished_task():
|
|
mock_model, mock_tokenizer = _make_engine_mocks(decode="tok")
|
|
callbacks_saved = []
|
|
|
|
def capture_cb(prompt, **kwargs):
|
|
callbacks_saved.append(kwargs["stream_callback"])
|
|
return "task-1"
|
|
|
|
with patch("astrai.inference.engine.InferenceScheduler") as MockSched:
|
|
instance = MockSched.return_value
|
|
instance.add_task.side_effect = capture_cb
|
|
|
|
engine = InferenceEngine(mock_model, mock_tokenizer, max_batch_size=1)
|
|
stream = engine.generate_async("hello")
|
|
callbacks_saved[0]([("task-1", "t1")])
|
|
|
|
async def consume_then_close():
|
|
assert await anext(stream) == "t1"
|
|
await stream.aclose()
|
|
|
|
asyncio.run(consume_then_close())
|
|
|
|
instance.cancel_task.assert_called_once_with("task-1")
|
|
|
|
|
|
def test_engine_generate_non_streaming_batch():
|
|
mock_model, mock_tokenizer = _make_engine_mocks(decode="r")
|
|
|
|
counter = itertools.count()
|
|
task_ids = []
|
|
|
|
def fake_add(prompt, **kw):
|
|
cb = kw["stream_callback"]
|
|
tid = f"task-{next(counter)}"
|
|
task_ids.append(tid)
|
|
cb([(tid, "r"), (tid, STOP)])
|
|
return tid
|
|
|
|
with patch("astrai.inference.engine.InferenceScheduler") as MockSched:
|
|
instance = MockSched.return_value
|
|
instance.add_task.side_effect = fake_add
|
|
instance.remove_task.return_value = []
|
|
|
|
eng = InferenceEngine(mock_model, mock_tokenizer, max_batch_size=2)
|
|
results = eng.generate(["hello", "world"])
|
|
assert results == ["r", "r"]
|
|
assert task_ids == ["task-0", "task-1"]
|
|
|
|
|
|
def test_engine_generate_zero_max_tokens_returns_empty():
|
|
mock_model, mock_tokenizer = _make_engine_mocks()
|
|
|
|
with patch("astrai.inference.engine.InferenceScheduler") as MockSched:
|
|
instance = MockSched.return_value
|
|
instance.remove_task.return_value = []
|
|
|
|
eng = InferenceEngine(mock_model, mock_tokenizer, max_batch_size=2)
|
|
assert eng.generate(["hello", "world"], max_tokens=0) == ["", ""]
|
|
instance.add_task.assert_not_called()
|
|
|
|
|
|
def test_engine_generate_zero_max_tokens_stream_is_empty():
|
|
mock_model, mock_tokenizer = _make_engine_mocks()
|
|
|
|
with patch("astrai.inference.engine.InferenceScheduler") as MockSched:
|
|
instance = MockSched.return_value
|
|
eng = InferenceEngine(mock_model, mock_tokenizer, max_batch_size=1)
|
|
assert list(eng.generate("hello", stream=True, max_tokens=0)) == []
|
|
instance.add_task.assert_not_called()
|
|
|
|
|
|
def test_engine_passes_backend_to_scheduler():
|
|
mock_model, mock_tokenizer = _make_engine_mocks()
|
|
|
|
with patch("astrai.inference.engine.InferenceScheduler") as MockSched:
|
|
InferenceEngine(
|
|
mock_model,
|
|
mock_tokenizer,
|
|
max_batch_size=1,
|
|
backend="torch_native",
|
|
)
|
|
|
|
assert MockSched.call_args.kwargs["backend"] == "torch_native"
|
|
|
|
|
|
def test_generate_captures_calling_backend_context():
|
|
mock_model, mock_tokenizer = _make_engine_mocks()
|
|
captured = []
|
|
|
|
with patch("astrai.inference.engine.InferenceScheduler") as MockSched:
|
|
instance = MockSched.return_value
|
|
|
|
def fake_add(prompt, **kwargs):
|
|
captured.append(kwargs["backend"])
|
|
kwargs["stream_callback"]([("task", STOP)])
|
|
return "task"
|
|
|
|
instance.add_task.side_effect = fake_add
|
|
engine = InferenceEngine(mock_model, mock_tokenizer)
|
|
with attn_backend("torch_native"):
|
|
assert engine.generate("hello") == ""
|
|
|
|
assert len(captured) == 1
|
|
assert isinstance(captured[0], TorchNativeBackend)
|
|
|
|
|
|
def test_build_engine_from_live_objects_starts_scheduler():
|
|
model, _ = make_model("cpu", max_position_embeddings=64)
|
|
tokenizer = FakeTokenizer()
|
|
engine = build_engine(
|
|
model=model,
|
|
tokenizer=tokenizer,
|
|
device=None,
|
|
dtype=None,
|
|
max_batch_size=2,
|
|
)
|
|
try:
|
|
assert isinstance(engine, InferenceEngine)
|
|
assert engine.tokenizer is tokenizer
|
|
assert engine.scheduler._stop_event.is_set() is False
|
|
finally:
|
|
engine.shutdown()
|
|
|
|
|
|
def test_build_engine_passes_engine_kwargs_through():
|
|
model, _ = make_model("cpu", max_position_embeddings=64)
|
|
backend = TorchNativeBackend()
|
|
with patch("astrai.inference.engine.InferenceScheduler") as MockSched:
|
|
|
|
def fake_add(*args, **k):
|
|
k["stream_callback"]([("task", STOP)])
|
|
return "task"
|
|
|
|
MockSched.return_value.add_task.side_effect = fake_add
|
|
engine = build_engine(
|
|
model=model,
|
|
tokenizer=FakeTokenizer(),
|
|
device=None,
|
|
dtype=None,
|
|
cache=object(),
|
|
enable_cuda_graph=False,
|
|
backend=backend,
|
|
)
|
|
engine.generate("hi")
|
|
|
|
kwargs = MockSched.call_args.kwargs
|
|
assert kwargs["cache"] is not None
|
|
assert kwargs["enable_cuda_graph"] is False
|
|
assert kwargs["backend"] is backend
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("kwargs", "error", "message"),
|
|
[
|
|
(
|
|
{"param_path": "x", "model": object()},
|
|
ValueError,
|
|
"not both",
|
|
),
|
|
({}, ValueError, "requires param_path"),
|
|
({"param_path": "/nonexistent-dir-xyz"}, FileNotFoundError, "not found"),
|
|
],
|
|
)
|
|
def test_build_engine_rejects_invalid_arguments(kwargs, error, message):
|
|
with pytest.raises(error, match=message):
|
|
build_engine(**kwargs)
|