Method to_string

python/paddle/base/framework.py:6471–6534

To debug string. Args: throw_on_error (bool): raise Value error when any of required fields is not set. with_details (bool): True if more details about variables and parameters, e.g., :code:`trainable`, :code:`optimize_attr`, need to print. Return

(self, throw_on_error, with_details=False)

        return program_str

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

        Args:

            throw_on_error (bool): raise Value error when any of required fields is not set.

            with_details (bool): True if more details about variables and parameters, e.g., :code:`trainable`, :code:`optimize_attr`, need to print.

        Returns:
            str: The debug string describe current Program.

        Raises:
            ValueError: If any of required fields is not set and throw_on_error is True.

        Examples:
            .. code-block:: pycon

                >>> import paddle
                >>> import paddle.static as static

                >>> paddle.enable_static()

                >>> prog = static.default_main_program()
                >>> x = static.data(name="X", shape=[2, 3], dtype="float32")
                >>> pred = static.nn.fc(x, size=3)
                >>> prog_string = prog.to_string(throw_on_error=True, with_details=False)
                >>> prog_string_with_details = prog.to_string(throw_on_error=False, with_details=True)
                >>> print("program string without detail: {}".format(prog_string))
                >>> print("program string with detail: {}".format(prog_string_with_details))
        """
        assert isinstance(throw_on_error, bool), (
            f"The type of throw_on_error parameter is wrong, expected bool, but received {type(throw_on_error)}."
        )
        assert isinstance(with_details, bool), (
            f"The type of with_details parameter is wrong, expected bool, but received {type(with_details)}."
        )

        if with_details:
            res_str = ""
            for block in self.blocks:
                res_str += block.to_string(throw_on_error, with_details)
            protostr = self.desc.serialize_to_string()
            proto = framework_pb2.ProgramDesc.FromString(bytes(protostr))
            res_str += (
                "version {\n  "
                + textwrap.indent(
                    _debug_string_(proto.version, throw_on_error), "  "
                )
                + "}\n"
            )
            res_str += (
                "op_version_map {\n  "
                + textwrap.indent(
                    _debug_string_(proto.op_version_map, throw_on_error), "  "
                )
                + "}\n"