Source file `owl_algodiff_graph_convert_sig.ml`

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 1 "src/base/algodiff/owl_algodiff_graph_convert_sig.ml"
(*
 * OWL - OCaml Scientific and Engineering Computing
 * Copyright (c) 2016-2020 Liang Wang <liang.wang@cl.cam.ac.uk>
 *)

module type Sig = sig
  type t

  val to_trace : t list -> string
  (** ``to_trace [t0; t1; ...]`` outputs the trace of computation graph on the terminal
      in a human-readable format. *)

  val to_dot : t list -> string
  (** ``to_dot [t0; t1; ...]`` outputs the trace of computation graph in the dot file
      format which you can use other tools further visualisation, such as Graphviz. *)

  val pp_num : Format.formatter -> t -> unit
    [@@ocaml.toplevel_printer]
  (** ``pp_num t`` pretty prints the abstract number used in ``Algodiff``. *)
end