pytorch

1
"""Adds docstrings to Storage functions"""
2

3
import torch._C
4
from torch._C import _add_docstr as add_docstr
5

6

7
storage_classes = [
8
    "StorageBase",
9
]
10

11

12
def add_docstr_all(method, docstr):
13
    for cls_name in storage_classes:
14
        cls = getattr(torch._C, cls_name)
15
        try:
16
            add_docstr(getattr(cls, method), docstr)
17
        except AttributeError:
18
            pass
19

20

21
add_docstr_all(
22
    "from_file",
23
    """
24
from_file(filename, shared=False, size=0) -> Storage
25

26
Creates a CPU storage backed by a memory-mapped file.
27

28
If ``shared`` is ``True``, then memory is shared between all processes.
29
All changes are written to the file. If ``shared`` is ``False``, then the changes on
30
the storage do not affect the file.
31

32
``size`` is the number of elements in the storage. If ``shared`` is ``False``,
33
then the file must contain at least ``size * sizeof(Type)`` bytes
34
(``Type`` is the type of storage, in the case of an ``UnTypedStorage`` the file must contain at
35
least ``size`` bytes). If ``shared`` is ``True`` the file will be created if needed.
36

37
Args:
38
    filename (str): file name to map
39
    shared (bool): whether to share memory (whether ``MAP_SHARED`` or ``MAP_PRIVATE`` is passed to the
40
                    underlying `mmap(2) call <https://man7.org/linux/man-pages/man2/mmap.2.html>`_)
41
    size (int): number of elements in the storage
42
""",
43
)
44