| # This base template ("datapipe.pyi.in") is generated from mypy stubgen with minimal editing for code injection | |
| # The output file will be "datapipe.pyi". This is executed as part of torch/CMakeLists.txt | |
| # Note that, for mypy, .pyi file takes precedent over .py file, such that we must define the interface for other | |
| # classes/objects here, even though we are not injecting extra code into them at the moment. | |
| from typing import Any, Callable, Dict, Generic, Iterator, List, Literal, Optional, TypeVar, Union | |
| from torch.utils.data import Dataset, default_collate, IterableDataset | |
| from torch.utils.data.datapipes._hook_iterator import _SnapshotState | |
| from torch.utils.data.datapipes._typing import _DataPipeMeta, _IterDataPipeMeta | |
| T_co = TypeVar("T_co", covariant=True) | |
| T = TypeVar("T") | |
| UNTRACABLE_DATAFRAME_PIPES: Any | |
| class MapDataPipe(Dataset[T_co], metaclass=_DataPipeMeta): | |
| functions: Dict[str, Callable] = ... | |
| reduce_ex_hook: Optional[Callable] = ... | |
| getstate_hook: Optional[Callable] = ... | |
| str_hook: Optional[Callable] = ... | |
| repr_hook: Optional[Callable] = ... | |
| def __getattr__(self, attribute_name: Any): ... | |
| @classmethod | |
| def register_function(cls, function_name: Any, function: Any) -> None: ... | |
| @classmethod | |
| def register_datapipe_as_function( | |
| cls, | |
| function_name: Any, | |
| cls_to_register: Any, | |
| ): ... | |
| def __getstate__(self): ... | |
| def __reduce_ex__(self, *args: Any, **kwargs: Any): ... | |
| @classmethod | |
| def set_getstate_hook(cls, hook_fn: Any) -> None: ... | |
| @classmethod | |
| def set_reduce_ex_hook(cls, hook_fn: Any) -> None: ... | |
| ${MapDataPipeMethods} | |
| class IterDataPipe(IterableDataset[T_co], metaclass=_IterDataPipeMeta): | |
| functions: Dict[str, Callable] = ... | |
| reduce_ex_hook: Optional[Callable] = ... | |
| getstate_hook: Optional[Callable] = ... | |
| str_hook: Optional[Callable] = ... | |
| repr_hook: Optional[Callable] = ... | |
| _number_of_samples_yielded: int = ... | |
| _snapshot_state: _SnapshotState = _SnapshotState.Iterating | |
| _fast_forward_iterator: Optional[Iterator] = ... | |
| def __getattr__(self, attribute_name: Any): ... | |
| @classmethod | |
| def register_function(cls, function_name: Any, function: Any) -> None: ... | |
| @classmethod | |
| def register_datapipe_as_function( | |
| cls, | |
| function_name: Any, | |
| cls_to_register: Any, | |
| enable_df_api_tracing: bool = ..., | |
| ): ... | |
| def __getstate__(self): ... | |
| def __reduce_ex__(self, *args: Any, **kwargs: Any): ... | |
| @classmethod | |
| def set_getstate_hook(cls, hook_fn: Any) -> None: ... | |
| @classmethod | |
| def set_reduce_ex_hook(cls, hook_fn: Any) -> None: ... | |
| ${IterDataPipeMethods} | |
| class DFIterDataPipe(IterDataPipe): | |
| def _is_dfpipe(self): ... | |
| class _DataPipeSerializationWrapper: | |
| def __init__(self, datapipe): ... | |
| def __getstate__(self): ... | |
| def __setstate__(self, state): ... | |
| def __len__(self): ... | |
| class _IterDataPipeSerializationWrapper(_DataPipeSerializationWrapper, IterDataPipe): | |
| def __iter__(self): ... | |
| class _MapDataPipeSerializationWrapper(_DataPipeSerializationWrapper, MapDataPipe): | |
| def __getitem__(self, idx): ... | |
| class DataChunk(list, Generic[T]): | |
| def __init__(self, items): | |
| super().__init__(items) | |
| self.items = items | |
| def as_str(self, indent: str = "") -> str: | |
| res = indent + "[" + ", ".join(str(i) for i in iter(self)) + "]" | |
| return res | |
| def __iter__(self) -> Iterator[T]: | |
| yield from super().__iter__() | |
| def raw_iterator(self) -> T: # type: ignore[misc] | |
| yield from self.items |