Skip to content

Commit ac2e109

Browse files
committed
misc: Finish docstring for MemoryEstimate
1 parent ac47866 commit ac2e109

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

devito/tools/data_structures.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -662,10 +662,16 @@ def __hash__(self):
662662

663663
class MemoryEstimate(frozendict):
664664
"""
665-
An immutable wrapper for a memory estimate, showing the
666-
various values.
665+
An immutable mapper for a memory estimate, providing the estimated memory
666+
consumption across host, device, and so forth.
667667
668-
TODO: Finish this docstring
668+
Properties
669+
----------
670+
name: str
671+
The name of the Operator for which this estimate was generated
672+
human_readable: frozendict
673+
The mapper, albeit with human-readable memory usage (MB, GB, etc)
674+
rather than raw bytes.
669675
"""
670676

671677
def __init__(self, *args, **kwargs):

0 commit comments

Comments
 (0)