提交 30669a3c authored 作者: Brandon T. Willard's avatar Brandon T. Willard 提交者: Brandon T. Willard

Fix Type and TensorType docstrings

上级 07832d35
......@@ -229,18 +229,6 @@ class Type(MetaObject):
"""
return cls.values_eq(a, b)
# def get_shape_info(self, obj):
"""
Optional function. See TensorType().get_shape_info for definition.
"""
# def get_size(self, shape_info):
"""
Optional function. See TensorType().get_size for definition.
"""
class CType(Type, CLinkerType):
"""Convenience wrapper combining `Type` and `CLinkerType`.
......
......@@ -550,19 +550,19 @@ class TensorType(CType):
return np.zeros(shape, dtype=self.dtype)
def get_shape_info(self, obj):
"""Return the information needed to compute the memory size of ``obj``.
"""Return the information needed to compute the memory size of `obj`.
The memory size is only the data, so this excludes the container.
For an ndarray, this is the data, but not the ndarray object and
other data structures such as shape and strides.
``get_shape_info()`` and ``get_size()`` work in tandem for the memory
`get_shape_info` and `get_size` work in tandem for the memory
profiler.
``get_shape_info()`` is called during the execution of the function.
`get_shape_info` is called during the execution of the function.
So it is better that it is not too slow.
``get_size()`` will be called on the output of this function
`get_size` will be called on the output of this function
when printing the memory profile.
Parameters
......@@ -573,7 +573,7 @@ class TensorType(CType):
Returns
-------
object
Python object that ``self.get_size()`` understands.
Python object that can be passed to `get_size`.
"""
return obj.shape
......@@ -584,7 +584,7 @@ class TensorType(CType):
Parameters
----------
shape_info
The output of the call to get_shape_info().
The output of the call to `get_shape_info`.
Returns
-------
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论