[Misc Utils] New module

deepchem/utils/__init__.py

@@ -6,6 +6,9 @@
 
 logger = logging.getLogger(__name__)
 
+from deepchem.utils.misc_utils import indent
+from deepchem.utils.misc_utils import shape2str
+
 from deepchem.utils.batch_utils import batch_coulomb_matrix_features
 
 from deepchem.utils.attribute_utils import set_attr

deepchem/utils/differentiation_utils/linop.py

@@ -5,10 +5,8 @@
 from abc import abstractmethod
 from contextlib import contextmanager
 from scipy.sparse.linalg import LinearOperator as spLinearOperator
-from deepchem.utils.differentiation_utils import EditableModule
-from deepchem.utils.differentiation_utils import get_bcasted_dims
-from deepchem.utils.differentiation_utils import shape2str
-from deepchem.utils.differentiation_utils import indent
+from deepchem.utils.differentiation_utils import EditableModule, get_bcasted_dims
+from deepchem.utils import shape2str, indent
 
 __all__ = ["LinearOperator"]
 

deepchem/utils/differentiation_utils/misc.py

@@ -131,43 +131,3 @@ def assert_runtime(cond, msg=""):
     """
     if not cond:
         raise RuntimeError(msg)
-
-
-# repr helper functions
-def indent(s, nspace):
-    """give indentation of the second line and next lines
-
-    Parameters
-    ----------
-    s: str
-        The string to be indented.
-    nspace: int
-        The number of spaces to be indented.
-
-    Returns
-    -------
-    str
-        The indented string.
-
-    """
-    spaces = " " * nspace
-    lines = [spaces + c if i > 0 else c for i, c in enumerate(s.split("\n"))]
-    return "\n".join(lines)
-
-
-def shape2str(shape):
-    """Convert the shape to string representation.
-    It also nicely formats the shape to be readable.
-
-    Parameters
-    ----------
-    shape: Sequence[int]
-        The shape to be converted to string representation.
-
-    Returns
-    -------
-    str
-        The string representation of the shape.
-
-    """
-    return "(%s)" % (", ".join([str(s) for s in shape]))

deepchem/utils/misc_utils.py

@@ -0,0 +1,45 @@
+"""
+Utilities for miscellaneous tasks.
+"""
+
+
+def indent(s, nspace):
+    """Gives indentation of the second line and next lines.
+    It is used to format the string representation of an object.
+    Which might be containing multiples objects in it.
+    Usage: LinearOperator
+
+    Parameters
+    ----------
+    s: str
+        The string to be indented.
+    nspace: int
+        The number of spaces to be indented.
+
+    Returns
+    -------
+    str
+        The indented string.
+
+    """
+    spaces = " " * nspace
+    lines = [spaces + c if i > 0 else c for i, c in enumerate(s.split("\n"))]
+    return "\n".join(lines)
+
+
+def shape2str(shape):
+    """Convert the shape to string representation.
+    It also nicely formats the shape to be readable.
+
+    Parameters
+    ----------
+    shape: Sequence[int]
+        The shape to be converted to string representation.
+
+    Returns
+    -------
+    str
+        The string representation of the shape.
+
+    """
+    return "(%s)" % (", ".join([str(s) for s in shape]))

docs/source/api_reference/utils.rst

@@ -419,4 +419,14 @@ for additional information regarding equivariance and Deepchem's support for equ
 
 .. autofunction:: deepchem.utils.equivariance_utils.change_basis_real_to_complex
 
-.. autofunction:: deepchem.utils.equivariance_utils.wigner_D
+.. autofunction:: deepchem.utils.equivariance_utils.wigner_D
+
+Miscellaneous Utilities
+-----------------------
+
+The utilities here are used for miscellaneous purposes.
+Initial usecases are for improving the printing format of __repr__.
+
+.. autofunction:: deepchem.utils.misc_utils.indent
+
+.. autofunction:: deepchem.utils.equivariance_utils.shape2str