From ad9c85742769d6fe84def7c9bfa4525da8e33c6a Mon Sep 17 00:00:00 2001 From: Alejandro Saucedo Date: Fri, 7 May 2021 16:54:08 +0100 Subject: [PATCH 1/3] Updated memory ownership of sharedptr of Tensor to also be refcounted by numpy array returned in data --- python/src/main.cpp | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/python/src/main.cpp b/python/src/main.cpp index 84d874594..e05e19320 100644 --- a/python/src/main.cpp +++ b/python/src/main.cpp @@ -95,18 +95,17 @@ PYBIND11_MODULE(kp, m) { py::class_>(m, "Tensor", DOC(kp, Tensor)) .def("data", [](kp::Tensor& self) { // Non-owning container exposing the underlying pointer - py::str dummyDataOwner; // Explicitly request data to not be owned by np switch (self.dataType()) { case kp::Tensor::TensorDataTypes::eFloat: - return py::array(self.size(), self.data(), dummyDataOwner); + return py::array(self.size(), self.data(), py::cast(&self)); case kp::Tensor::TensorDataTypes::eUnsignedInt: - return py::array(self.size(), self.data(), dummyDataOwner); + return py::array(self.size(), self.data(), py::cast(&self)); case kp::Tensor::TensorDataTypes::eInt: - return py::array(self.size(), self.data(), dummyDataOwner); + return py::array(self.size(), self.data(), py::cast(&self)); case kp::Tensor::TensorDataTypes::eDouble: - return py::array(self.size(), self.data(), dummyDataOwner); + return py::array(self.size(), self.data(), py::cast(&self)); case kp::Tensor::TensorDataTypes::eBool: - return py::array(self.size(), self.data(), dummyDataOwner); + return py::array(self.size(), self.data(), py::cast(&self)); default: throw std::runtime_error("Kompute Python data type not supported"); } From d9090eeb64462d172a061fab14235d2cd41bd5da Mon Sep 17 00:00:00 2001 From: Alejandro Saucedo Date: Fri, 7 May 2021 16:59:21 +0100 Subject: [PATCH 2/3] Added test to ensure ownership by numpy array --- python/test/test_tensor_types.py | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/python/test/test_tensor_types.py b/python/test/test_tensor_types.py index fb11083fd..ee645d850 100644 --- a/python/test/test_tensor_types.py +++ b/python/test/test_tensor_types.py @@ -207,3 +207,26 @@ def test_type_unsigned_int(): assert np.all(tensor_out.data() == arr_in_a * arr_in_b) +def test_tensor_numpy_ownership(): + + arr_in = np.array([1, 2, 3]) + + m = kp.Manager() + + t = m.tensor(arr_in) + + # This should increment refcount for tensor sharedptr + td = t.data() + + assert td.base.is_init() == True + assert np.all(td == arr_in) + + del t + + assert td.base.is_init() == True + assert np.all(td == arr_in) + + m.destroy() + + assert td.base.is_init() == False + From 12f6ad5a442e94275602d4d2284dbe9a92e3da6b Mon Sep 17 00:00:00 2001 From: Alejandro Saucedo Date: Fri, 14 May 2021 13:31:33 +0100 Subject: [PATCH 3/3] Added documentation for tensor memory management --- docs/overview/python-package.rst | 33 ++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/docs/overview/python-package.rst b/docs/overview/python-package.rst index db9593219..3186d26ec 100644 --- a/docs/overview/python-package.rst +++ b/docs/overview/python-package.rst @@ -52,6 +52,39 @@ More specifically, it can be through the following functions: * mgr.eval_async__def - Runs operation asynchronously under a new anonymous sequence * seq.record_ - Records operation in sequence (requires sequence to be in recording mode) +Tensor Component +------------------ + +The `kp.Tensor` component provides utilities to load and manage data into GPU memory. + +The primary interface to the GPU image leverage `np.array` containers which wrap the GPU memory. + +One of the key things to take into consideration is the GPU memory and resource management that is provided by Kompute - namely the `kp.Tensor` allows for the memory to be managed until the python object refcount goes down to zero or is explicitly destroyed with the `destroy()` function. + +Another thing to bare in mind is that when the `.data()` function is called, the numpy array would add an extra refcount, and the underlying resources won't be destroyed until that object is destroyed. This is shown more intuitively in the example below: + +.. code-block:: python + :linenos: + + m = kp.Manager() + + t = m.tensor([1,2,3]) + + td = t.data() + + del t + + td + # this is OK + + assert td.base.is_init() == True # OK + + m.destroy() # Frees all memory inside tensors + + assert td.base.is_init() == False # Consistent to expected setup + + del td # Now this calls tensor destructor as refcount reaches 0 + Log Level Configuration ^^^^^^