Coverage for  / home / jenkins / .local / lib / python3.10 / site-packages / hyper_parallel / distributed_data / external_step.py: 100%

1# Copyright 2026 Huawei Technologies Co., Ltd 

2# 

3# Licensed under the Apache License, Version 2.0 (the "License"); 

4# you may not use this file except in compliance with the License. 

5# You may obtain a copy of the License at 

6# 

7# http://www.apache.org/licenses/LICENSE-2.0 

8# 

9# Unless required by applicable law or agreed to in writing, software 

10# distributed under the License is distributed on an "AS IS" BASIS, 

11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 

12# See the License for the specific language governing permissions and 

13# limitations under the License. 

14# ============================================================================ 

15"""Contract for externally selected, complete local steps.""" 

16 

17from __future__ import annotations 

18 

19from collections.abc import Iterator, Sequence 

20from typing import Any, Protocol 

21 

22 

23class ExternalStepSource(Protocol): 

24 """Emit one complete local step of raw-sample bins at a time. 

25 

26 The caller owns source recovery. HP forwards an optional ``set_epoch`` 

27 hook but requires no checkpoint or Reader lifecycle methods. 

28 """ 

29 

30 def __iter__(self) -> Iterator[Sequence[Sequence[Any]]]: 

31 """Return an iterator over complete local steps.""" 

32 

33 

34__all__ = ["ExternalStepSource"]