jina-ai · hanxiao · Jun 15, 2021 · Jun 7, 2021 · Jun 9, 2021 · Jun 12, 2021
@@ -37,7 +37,7 @@
 
 # do not change this line manually
 # this is managed by proto/build-proto.sh and updated on every execution
-__proto_version__ = '0.0.81'
+__proto_version__ = '0.0.82'
 
 __uptime__ = _datetime.datetime.now().isoformat()
 

diff --git a/jina/proto/jina.proto b/jina/proto/jina.proto
@@ -52,8 +52,8 @@ message SparseNdArrayProto {
     // A 1-D tensor of any type and shape [N], which supplies the values for each element in indices.
     DenseNdArrayProto values = 2;
 
-    // A 1-D int64 tensor of shape [ndims], which specifies the dense_shape of the sparse tensor.
-    repeated int64 dense_shape = 3;
+    // A 1-D int64 tensor of shape [ndims], which specifies the shape of the sparse tensor.
+    repeated uint32 shape = 3;
 }
 
 /**

diff --git a/jina/proto/jina_pb2.py b/jina/proto/jina_pb2.py
diff --git a/jina/types/ndarray/sparse/__init__.py b/jina/types/ndarray/sparse/__init__.py
@@ -21,12 +21,19 @@ class BaseSparseNdArray(BaseNdArray):
     """
 
     def __init__(self, *args, **kwargs):
-        """Set constructor method."""
+        """Set constructor method.
+
+        :param args: args passed to super().
+        :param kwargs: kwargs passed to super().
+        """
         super().__init__(*args, **kwargs)
         self.is_sparse = True
 
-    def null_proto(self):
-        """Get the new protobuf representation."""
+    def null_proto(self) -> 'jina_pb2.SparseNdArrayProto':
+        """Get the new protobuf representation.
+
+        :return: An empty `SparseNdArrayProto`
+        """
         return jina_pb2.SparseNdArrayProto()
 
     def sparse_constructor(
@@ -39,6 +46,8 @@ def sparse_constructor(
         :param values: the values of the sparse array
         :param shape: the shape of the sparse array
         :return: Sparse NdArray
+
+        .. # noqa: DAR202
         """
         raise NotImplementedError
 
@@ -50,23 +59,31 @@ def sparse_parser(
 
         :param value: the sparse ndarray
         :return: a Dict with three entries {'indices': ..., 'values':..., 'shape':...}
+
+        .. # noqa: DAR202
         """
         raise NotImplementedError
 
     @property
     def value(self) -> AnySparseNdArray:
-        """Get the value of protobuf message in :class:`SparseNdArray`."""
+        """Get the value of protobuf message in :class:`SparseNdArray`.
+
+        :return: A :class:`SparseNdArray`.
+        """
         idx = DenseNdArray(self._pb_body.indices).value
         val = DenseNdArray(self._pb_body.values).value
-        shape = self._pb_body.dense_shape
+        shape = self._pb_body.shape
         if idx is not None and val is not None and shape:
             return self.sparse_constructor(idx, val, shape)
 
     @value.setter
     def value(self, value: AnySparseNdArray):
-        """Set the value of protobuf message with :param:`value` in :class:`SparseNdArray`."""
+        """Set the value of protobuf message with :param:`value` in :class:`SparseNdArray`.
+
+        :param value: The :class:`SparseNdArray` to be set as the value of the cls.
+        """
         r = self.sparse_parser(value)
         DenseNdArray(self._pb_body.indices).value = r['indices']
         DenseNdArray(self._pb_body.values).value = r['values']
-        self._pb_body.ClearField('dense_shape')
-        self._pb_body.dense_shape.extend(r['shape'])
+        self._pb_body.ClearField('shape')
+        self._pb_body.shape.extend(r['shape'])