Method to_string

python/paddle/base/framework.py:2207–2264

Get debug string. Args: throw_on_error (bool): True if raise an exception when self is not initialized. with_details (bool): more details about variables and parameters (e.g. trainable, optimize_attr, ...) will be printed when with_details is True. Default

(self, throw_on_error, with_details=False)

        return var_str

    def to_string(self, throw_on_error, with_details=False):
        """
        Get debug string.

        Args:

            throw_on_error (bool): True if raise an exception when self is not initialized.

            with_details (bool): more details about variables and parameters (e.g. trainable, optimize_attr, ...) will be printed when with_details is True. Default value is False;

        Returns:
            str: The debug string.

        Examples:
            .. code-block:: pycon

                >>> # doctest: +SKIP("This has diff in xdoctest env")
                >>> import paddle.base as base
                >>> import paddle

                >>> paddle.enable_static()
                >>> cur_program = base.Program()
                >>> cur_block = cur_program.current_block()
                >>> new_variable = cur_block.create_var(
                ...     name="X",
                ...     shape=[-1, 23, 48],
                ...     dtype="float32",
                ... )
                >>> print(new_variable.to_string(True))
                >>> print("=============with detail===============")
                >>> print(new_variable.to_string(True, True))
                name: "X"
                type {
                  type: DENSE_TENSOR
                  lod_tensor {
                    tensor {
                      data_type: FP32
                      dims: -1
                      dims: 23
                      dims: 48
                    }
                  }
                }
                stop_gradient: false
                error_clip: None
        """
        assert isinstance(throw_on_error, bool) and isinstance(
            with_details, bool
        )
        protostr = self.desc.serialize_to_string()
        proto = framework_pb2.VarDesc.FromString(bytes(protostr))
        res_str = _debug_string_(proto, throw_on_error)
        if with_details:
            additional_attr = ("error_clip",)
            for attr_name in additional_attr:
                res_str += f"{attr_name}: {getattr(self, attr_name)}\n"

        return res_str