src/HOL/Tools/Sledgehammer/sledgehammer_mash.ML
author blanchet
Fri, 20 Jul 2012 22:19:46 +0200
changeset 49421 b002cc16aa99
parent 49419 0a261b4aa093
child 49422 47fe0ca12fc2
permissions -rw-r--r--
honor suggested MaSh weights
     1 (*  Title:      HOL/Tools/Sledgehammer/sledgehammer_mash.ML
     2     Author:     Jasmin Blanchette, TU Muenchen
     3 
     4 Sledgehammer's machine-learning-based relevance filter (MaSh).
     5 *)
     6 
     7 signature SLEDGEHAMMER_MASH =
     8 sig
     9   type stature = ATP_Problem_Generate.stature
    10   type fact = Sledgehammer_Fact.fact
    11   type fact_override = Sledgehammer_Fact.fact_override
    12   type params = Sledgehammer_Provers.params
    13   type relevance_fudge = Sledgehammer_Provers.relevance_fudge
    14   type prover_result = Sledgehammer_Provers.prover_result
    15 
    16   val trace : bool Config.T
    17   val MaShN : string
    18   val mepoN : string
    19   val mashN : string
    20   val meshN : string
    21   val unlearnN : string
    22   val learn_isarN : string
    23   val learn_atpN : string
    24   val relearn_isarN : string
    25   val relearn_atpN : string
    26   val fact_filters : string list
    27   val escape_meta : string -> string
    28   val escape_metas : string list -> string
    29   val unescape_meta : string -> string
    30   val unescape_metas : string -> string list
    31   val extract_query : string -> string * (string * real) list
    32   val nickname_of : thm -> string
    33   val suggested_facts :
    34     (string * 'a) list -> ('b * thm) list -> (('b * thm) * 'a) list
    35   val mesh_facts :
    36     int -> ((('a * thm) * real) list * ('a * thm) list) list -> ('a * thm) list
    37   val theory_ord : theory * theory -> order
    38   val thm_ord : thm * thm -> order
    39   val goal_of_thm : theory -> thm -> thm
    40   val run_prover_for_mash :
    41     Proof.context -> params -> string -> fact list -> thm -> prover_result
    42   val features_of :
    43     Proof.context -> string -> theory -> stature -> term list -> string list
    44   val isar_dependencies_of : unit Symtab.table -> thm -> string list option
    45   val atp_dependencies_of :
    46     Proof.context -> params -> string -> int -> fact list -> unit Symtab.table
    47     -> thm -> string list option
    48   val mash_CLEAR : Proof.context -> unit
    49   val mash_ADD :
    50     Proof.context -> bool
    51     -> (string * string list * string list * string list) list -> unit
    52   val mash_REPROVE :
    53     Proof.context -> bool -> (string * string list) list -> unit
    54   val mash_QUERY :
    55     Proof.context -> bool -> int -> string list * string list
    56     -> (string * real) list
    57   val mash_unlearn : Proof.context -> unit
    58   val mash_could_suggest_facts : unit -> bool
    59   val mash_can_suggest_facts : Proof.context -> bool
    60   val mash_suggested_facts :
    61     Proof.context -> params -> string -> int -> term list -> term
    62     -> ('a * thm) list -> (('a * thm) * real) list * ('a * thm) list
    63   val mash_learn_proof :
    64     Proof.context -> params -> string -> term -> ('a * thm) list -> thm list
    65     -> unit
    66   val mash_learn :
    67     Proof.context -> params -> fact_override -> thm list -> bool -> unit
    68   val relevant_facts :
    69     Proof.context -> params -> string -> int -> fact_override -> term list
    70     -> term -> fact list -> fact list
    71   val kill_learners : unit -> unit
    72   val running_learners : unit -> unit
    73 end;
    74 
    75 structure Sledgehammer_MaSh : SLEDGEHAMMER_MASH =
    76 struct
    77 
    78 open ATP_Util
    79 open ATP_Problem_Generate
    80 open Sledgehammer_Util
    81 open Sledgehammer_Fact
    82 open Sledgehammer_Provers
    83 open Sledgehammer_Minimize
    84 open Sledgehammer_MePo
    85 
    86 val trace =
    87   Attrib.setup_config_bool @{binding sledgehammer_mash_trace} (K false)
    88 fun trace_msg ctxt msg = if Config.get ctxt trace then tracing (msg ()) else ()
    89 
    90 val MaShN = "MaSh"
    91 
    92 val mepoN = "mepo"
    93 val mashN = "mash"
    94 val meshN = "mesh"
    95 
    96 val fact_filters = [meshN, mepoN, mashN]
    97 
    98 val unlearnN = "unlearn"
    99 val learn_isarN = "learn_isar"
   100 val learn_atpN = "learn_atp"
   101 val relearn_isarN = "relearn_isar"
   102 val relearn_atpN = "relearn_atp"
   103 
   104 fun mash_home () = getenv "MASH_HOME"
   105 fun mash_model_dir () =
   106   getenv "ISABELLE_HOME_USER" ^ "/mash"
   107   |> tap (Isabelle_System.mkdir o Path.explode)
   108 val mash_state_dir = mash_model_dir
   109 fun mash_state_path () = mash_state_dir () ^ "/state" |> Path.explode
   110 
   111 
   112 (*** Isabelle helpers ***)
   113 
   114 fun meta_char c =
   115   if Char.isAlphaNum c orelse c = #"_" orelse c = #"." orelse c = #"(" orelse
   116      c = #")" orelse c = #"," then
   117     String.str c
   118   else
   119     (* fixed width, in case more digits follow *)
   120     "%" ^ stringN_of_int 3 (Char.ord c)
   121 
   122 fun unmeta_chars accum [] = String.implode (rev accum)
   123   | unmeta_chars accum (#"%" :: d1 :: d2 :: d3 :: cs) =
   124     (case Int.fromString (String.implode [d1, d2, d3]) of
   125        SOME n => unmeta_chars (Char.chr n :: accum) cs
   126      | NONE => "" (* error *))
   127   | unmeta_chars _ (#"%" :: _) = "" (* error *)
   128   | unmeta_chars accum (c :: cs) = unmeta_chars (c :: accum) cs
   129 
   130 val escape_meta = String.translate meta_char
   131 val escape_metas = map escape_meta #> space_implode " "
   132 val unescape_meta = String.explode #> unmeta_chars []
   133 val unescape_metas =
   134   space_explode " " #> filter_out (curry (op =) "") #> map unescape_meta
   135 
   136 fun extract_node line =
   137   case space_explode ":" line of
   138     [name, parents] => (unescape_meta name, unescape_metas parents)
   139   | _ => ("", [])
   140 
   141 fun extract_suggestion sugg =
   142   case space_explode "=" sugg of
   143     [name, weight] =>
   144     SOME (unescape_meta name, Real.fromString weight |> the_default 0.0)
   145   | _ => NONE
   146 
   147 fun extract_query line =
   148   case space_explode ":" line of
   149     [goal, suggs] =>
   150     (unescape_meta goal,
   151      map_filter extract_suggestion (space_explode " " suggs))
   152   | _ => ("", [])
   153 
   154 fun parent_of_local_thm th =
   155   let
   156     val thy = th |> Thm.theory_of_thm
   157     val facts = thy |> Global_Theory.facts_of
   158     val space = facts |> Facts.space_of
   159     fun id_of s = #id (Name_Space.the_entry space s)
   160     fun max_id (s', _) (s, id) =
   161       let val id' = id_of s' in if id > id' then (s, id) else (s', id') end
   162   in ("", ~1) |> Facts.fold_static max_id facts |> fst end
   163 
   164 val local_prefix = "local" ^ Long_Name.separator
   165 
   166 fun nickname_of th =
   167   if Thm.has_name_hint th then
   168     let val hint = Thm.get_name_hint th in
   169       (* FIXME: There must be a better way to detect local facts. *)
   170       case try (unprefix local_prefix) hint of
   171         SOME suf =>
   172         parent_of_local_thm th ^ Long_Name.separator ^ Long_Name.separator ^ suf
   173       | NONE => hint
   174     end
   175   else
   176     backquote_thm th
   177 
   178 fun suggested_facts suggs facts =
   179   let
   180     fun add_fact (fact as (_, th)) = Symtab.default (nickname_of th, fact)
   181     val tab = Symtab.empty |> fold add_fact facts
   182     fun find_sugg (name, weight) =
   183       Symtab.lookup tab name |> Option.map (rpair weight)
   184   in map_filter find_sugg suggs end
   185 
   186 fun sum_avg [] = 0
   187   | sum_avg xs = Real.ceil (100000.0 * fold (curry (op +)) xs 0.0) div length xs
   188 
   189 fun normalize_scores [] = []
   190   | normalize_scores ((fact, score) :: tail) =
   191     (fact, 1.0) :: map (apsnd (curry Real.* (1.0 / score))) tail
   192 
   193 fun mesh_facts max_facts [(sels, unks)] =
   194     map fst (take max_facts sels) @ take (max_facts - length sels) unks
   195   | mesh_facts max_facts mess =
   196     let
   197       val mess = mess |> map (apfst (normalize_scores #> `length))
   198       val fact_eq = Thm.eq_thm o pairself snd
   199       fun score_at sels = try (nth sels) #> Option.map snd
   200       fun score_in fact ((sel_len, sels), unks) =
   201         case find_index (curry fact_eq fact o fst) sels of
   202           ~1 => (case find_index (curry fact_eq fact) unks of
   203                    ~1 => score_at sels sel_len
   204                  | _ => NONE)
   205         | rank => score_at sels rank
   206       fun weight_of fact = mess |> map_filter (score_in fact) |> sum_avg
   207       val facts =
   208         fold (union fact_eq o map fst o take max_facts o snd o fst) mess []
   209     in
   210       facts |> map (`weight_of) |> sort (int_ord o swap o pairself fst)
   211             |> map snd |> take max_facts
   212     end
   213 
   214 val thy_feature_name_of = prefix "y"
   215 val const_name_of = prefix "c"
   216 val type_name_of = prefix "t"
   217 val class_name_of = prefix "s"
   218 
   219 fun theory_ord p =
   220   if Theory.eq_thy p then
   221     EQUAL
   222   else if Theory.subthy p then
   223     LESS
   224   else if Theory.subthy (swap p) then
   225     GREATER
   226   else case int_ord (pairself (length o Theory.ancestors_of) p) of
   227     EQUAL => string_ord (pairself Context.theory_name p)
   228   | order => order
   229 
   230 val thm_ord = theory_ord o pairself theory_of_thm
   231 
   232 val freezeT = Type.legacy_freeze_type
   233 
   234 fun freeze (t $ u) = freeze t $ freeze u
   235   | freeze (Abs (s, T, t)) = Abs (s, freezeT T, freeze t)
   236   | freeze (Var ((s, _), T)) = Free (s, freezeT T)
   237   | freeze (Const (s, T)) = Const (s, freezeT T)
   238   | freeze (Free (s, T)) = Free (s, freezeT T)
   239   | freeze t = t
   240 
   241 fun goal_of_thm thy = prop_of #> freeze #> cterm_of thy #> Goal.init
   242 
   243 fun run_prover_for_mash ctxt params prover facts goal =
   244   let
   245     val problem =
   246       {state = Proof.init ctxt, goal = goal, subgoal = 1, subgoal_count = 1,
   247        facts = facts |> map (apfst (apfst (fn name => name ())))
   248                      |> map Untranslated_Fact}
   249   in
   250     get_minimizing_prover ctxt MaSh (K (K ())) prover params (K (K (K "")))
   251                           problem
   252   end
   253 
   254 val bad_types = [@{type_name prop}, @{type_name bool}, @{type_name fun}]
   255 
   256 val logical_consts =
   257   [@{const_name prop}, @{const_name Pure.conjunction}] @ atp_logical_consts
   258 
   259 fun interesting_terms_types_and_classes ctxt prover term_max_depth
   260                                         type_max_depth ts =
   261   let
   262     fun is_bad_const (x as (s, _)) args =
   263       member (op =) logical_consts s orelse
   264       fst (is_built_in_const_for_prover ctxt prover x args)
   265     fun add_classes @{sort type} = I
   266       | add_classes S = union (op =) (map class_name_of S)
   267     fun do_add_type (Type (s, Ts)) =
   268         (not (member (op =) bad_types s) ? insert (op =) (type_name_of s))
   269         #> fold do_add_type Ts
   270       | do_add_type (TFree (_, S)) = add_classes S
   271       | do_add_type (TVar (_, S)) = add_classes S
   272     fun add_type T = type_max_depth >= 0 ? do_add_type T
   273     fun mk_app s args =
   274       if member (op <>) args "" then s ^ "(" ^ space_implode "," args ^ ")"
   275       else s
   276     fun patternify ~1 _ = ""
   277       | patternify depth t =
   278         case strip_comb t of
   279           (Const (x as (s, _)), args) =>
   280           if is_bad_const x args then ""
   281           else mk_app (const_name_of s) (map (patternify (depth - 1)) args)
   282         | _ => ""
   283     fun add_pattern depth t =
   284       case patternify depth t of "" => I | s => insert (op =) s
   285     fun add_term_patterns ~1 _ = I
   286       | add_term_patterns depth t =
   287         add_pattern depth t #> add_term_patterns (depth - 1) t
   288     val add_term = add_term_patterns term_max_depth
   289     fun add_patterns t =
   290       let val (head, args) = strip_comb t in
   291         (case head of
   292            Const (_, T) => add_term t #> add_type T
   293          | Free (_, T) => add_type T
   294          | Var (_, T) => add_type T
   295          | Abs (_, T, body) => add_type T #> add_patterns body
   296          | _ => I)
   297         #> fold add_patterns args
   298       end
   299   in [] |> fold add_patterns ts end
   300 
   301 fun is_exists (s, _) = (s = @{const_name Ex} orelse s = @{const_name Ex1})
   302 
   303 val term_max_depth = 1
   304 val type_max_depth = 1
   305 
   306 (* TODO: Generate type classes for types? *)
   307 fun features_of ctxt prover thy (scope, status) ts =
   308   thy_feature_name_of (Context.theory_name thy) ::
   309   interesting_terms_types_and_classes ctxt prover term_max_depth type_max_depth
   310                                       ts
   311   |> forall is_lambda_free ts ? cons "no_lams"
   312   |> forall (not o exists_Const is_exists) ts ? cons "no_skos"
   313   |> scope <> Global ? cons "local"
   314   |> (case status of
   315         General => I
   316       | Induction => cons "induction"
   317       | Intro => cons "intro"
   318       | Inductive => cons "inductive"
   319       | Elim => cons "elim"
   320       | Simp => cons "simp"
   321       | Def => cons "def")
   322 
   323 (* Too many dependencies is a sign that a decision procedure is at work. There
   324    isn't much too learn from such proofs. *)
   325 val max_dependencies = 10
   326 val atp_dependency_default_max_fact = 50
   327 
   328 fun trim_dependencies deps =
   329   if length deps <= max_dependencies then SOME deps else NONE
   330 
   331 fun isar_dependencies_of all_names =
   332   thms_in_proof (SOME all_names) #> trim_dependencies
   333 
   334 fun atp_dependencies_of ctxt (params as {verbose, max_facts, ...}) prover
   335                         auto_level facts all_names th =
   336   case isar_dependencies_of all_names th of
   337     SOME [] => NONE
   338   | isar_deps =>
   339     let
   340       val thy = Proof_Context.theory_of ctxt
   341       val goal = goal_of_thm thy th
   342       val (_, hyp_ts, concl_t) = ATP_Util.strip_subgoal ctxt goal 1
   343       val facts = facts |> filter (fn (_, th') => thm_ord (th', th) = LESS)
   344       fun fix_name ((_, stature), th) = ((fn () => nickname_of th, stature), th)
   345       fun is_dep dep (_, th) = nickname_of th = dep
   346       fun add_isar_dep facts dep accum =
   347         if exists (is_dep dep) accum then
   348           accum
   349         else case find_first (is_dep dep) facts of
   350           SOME ((name, status), th) => accum @ [((name, status), th)]
   351         | NONE => accum (* shouldn't happen *)
   352       val facts =
   353         facts |> mepo_suggested_facts ctxt params prover
   354                      (max_facts |> the_default atp_dependency_default_max_fact)
   355                      NONE hyp_ts concl_t
   356               |> fold (add_isar_dep facts) (these isar_deps)
   357               |> map fix_name
   358     in
   359       if verbose andalso auto_level = 0 then
   360         let val num_facts = length facts in
   361           "MaSh: " ^ quote prover ^ " on " ^ quote (nickname_of th) ^
   362           " with " ^ string_of_int num_facts ^ " fact" ^ plural_s num_facts ^
   363           "."
   364           |> Output.urgent_message
   365         end
   366       else
   367         ();
   368       case run_prover_for_mash ctxt params prover facts goal of
   369         {outcome = NONE, used_facts, ...} =>
   370         (if verbose andalso auto_level = 0 then
   371            let val num_facts = length used_facts in
   372              "Found proof with " ^ string_of_int num_facts ^ " fact" ^
   373              plural_s num_facts ^ "."
   374              |> Output.urgent_message
   375            end
   376          else
   377            ();
   378          used_facts |> map fst |> trim_dependencies)
   379       | _ => NONE
   380     end
   381 
   382 
   383 (*** Low-level communication with MaSh ***)
   384 
   385 (* more friendly than "try o File.rm" for those who keep the files open in their
   386    text editor *)
   387 fun wipe_out file = File.write file ""
   388 
   389 fun write_file (xs, f) file =
   390   let val path = Path.explode file in
   391     wipe_out path;
   392     xs |> chunk_list 500
   393        |> List.app (File.append path o space_implode "" o map f)
   394   end
   395 
   396 fun run_mash_tool ctxt overlord save max_suggs write_cmds read_suggs =
   397   let
   398     val (temp_dir, serial) =
   399       if overlord then (getenv "ISABELLE_HOME_USER", "")
   400       else (getenv "ISABELLE_TMP", serial_string ())
   401     val log_file = if overlord then temp_dir ^ "/mash_log" else "/dev/null"
   402     val err_file = temp_dir ^ "/mash_err" ^ serial
   403     val sugg_file = temp_dir ^ "/mash_suggs" ^ serial
   404     val cmd_file = temp_dir ^ "/mash_commands" ^ serial
   405     val core =
   406       "--inputFile " ^ cmd_file ^ " --predictions " ^ sugg_file ^
   407       " --numberOfPredictions " ^ string_of_int max_suggs ^
   408       (if save then " --saveModel" else "")
   409     val command =
   410       mash_home () ^ "/mash --quiet --outputDir " ^ mash_model_dir () ^
   411       " --log " ^ log_file ^ " " ^ core ^ " >& " ^ err_file
   412   in
   413     write_file ([], K "") sugg_file;
   414     write_file write_cmds cmd_file;
   415     trace_msg ctxt (fn () => "Running " ^ command);
   416     Isabelle_System.bash command;
   417     read_suggs (fn () => try File.read_lines (Path.explode sugg_file) |> these)
   418     |> tap (fn _ => trace_msg ctxt (fn () =>
   419            case try File.read (Path.explode err_file) of
   420              NONE => "Done"
   421            | SOME "" => "Done"
   422            | SOME s => "Error: " ^ elide_string 1000 s))
   423     |> not overlord
   424        ? tap (fn _ => List.app (wipe_out o Path.explode)
   425                                [err_file, sugg_file, cmd_file])
   426   end
   427 
   428 fun str_of_add (name, parents, feats, deps) =
   429   "! " ^ escape_meta name ^ ": " ^ escape_metas parents ^ "; " ^
   430   escape_metas feats ^ "; " ^ escape_metas deps ^ "\n"
   431 
   432 fun str_of_reprove (name, deps) =
   433   "p " ^ escape_meta name ^ ": " ^ escape_metas deps ^ "\n"
   434 
   435 fun str_of_query (parents, feats) =
   436   "? " ^ escape_metas parents ^ "; " ^ escape_metas feats ^ "\n"
   437 
   438 fun mash_CLEAR ctxt =
   439   let val path = mash_model_dir () |> Path.explode in
   440     trace_msg ctxt (K "MaSh CLEAR");
   441     File.fold_dir (fn file => fn _ =>
   442                       try File.rm (Path.append path (Path.basic file)))
   443                   path NONE;
   444     ()
   445   end
   446 
   447 fun mash_ADD _ _ [] = ()
   448   | mash_ADD ctxt overlord adds =
   449     (trace_msg ctxt (fn () => "MaSh ADD " ^
   450          elide_string 1000 (space_implode " " (map #1 adds)));
   451      run_mash_tool ctxt overlord true 0 (adds, str_of_add) (K ()))
   452 
   453 fun mash_REPROVE _ _ [] = ()
   454   | mash_REPROVE ctxt overlord reps =
   455     (trace_msg ctxt (fn () => "MaSh REPROVE " ^
   456          elide_string 1000 (space_implode " " (map #1 reps)));
   457      run_mash_tool ctxt overlord true 0 (reps, str_of_reprove) (K ()))
   458 
   459 fun mash_QUERY ctxt overlord max_suggs (query as (_, feats)) =
   460   (trace_msg ctxt (fn () => "MaSh QUERY " ^ space_implode " " feats);
   461    run_mash_tool ctxt overlord false max_suggs
   462        ([query], str_of_query)
   463        (fn suggs =>
   464            case suggs () of
   465              [] => []
   466            | suggs => snd (extract_query (List.last suggs)))
   467    handle List.Empty => [])
   468 
   469 
   470 (*** High-level communication with MaSh ***)
   471 
   472 fun try_graph ctxt when def f =
   473   f ()
   474   handle Graph.CYCLES (cycle :: _) =>
   475          (trace_msg ctxt (fn () =>
   476               "Cycle involving " ^ commas cycle ^ " when " ^ when); def)
   477        | Graph.DUP name =>
   478          (trace_msg ctxt (fn () =>
   479               "Duplicate fact " ^ quote name ^ " when " ^ when); def)
   480        | Graph.UNDEF name =>
   481          (trace_msg ctxt (fn () =>
   482               "Unknown fact " ^ quote name ^ " when " ^ when); def)
   483        | exn =>
   484          if Exn.is_interrupt exn then
   485            reraise exn
   486          else
   487            (trace_msg ctxt (fn () =>
   488                 "Internal error when " ^ when ^ ":\n" ^
   489                 ML_Compiler.exn_message exn); def)
   490 
   491 fun graph_info G =
   492   string_of_int (length (Graph.keys G)) ^ " node(s), " ^
   493   string_of_int (fold (Integer.add o length o snd) (Graph.dest G) 0) ^
   494   " edge(s), " ^
   495   string_of_int (length (Graph.minimals G)) ^ " minimal, " ^
   496   string_of_int (length (Graph.maximals G)) ^ " maximal"
   497 
   498 type mash_state = {fact_G : unit Graph.T}
   499 
   500 val empty_state = {fact_G = Graph.empty}
   501 
   502 local
   503 
   504 val version = "*** MaSh 0.0 ***"
   505 
   506 fun load _ (state as (true, _)) = state
   507   | load ctxt _ =
   508     let val path = mash_state_path () in
   509       (true,
   510        case try File.read_lines path of
   511          SOME (version' :: node_lines) =>
   512          let
   513            fun add_edge_to name parent =
   514              Graph.default_node (parent, ()) #> Graph.add_edge (parent, name)
   515            fun add_node line =
   516              case extract_node line of
   517                ("", _) => I (* shouldn't happen *)
   518              | (name, parents) =>
   519                Graph.default_node (name, ()) #> fold (add_edge_to name) parents
   520            val fact_G =
   521              try_graph ctxt "loading state" Graph.empty (fn () =>
   522                  Graph.empty |> version' = version ? fold add_node node_lines)
   523          in
   524            trace_msg ctxt (fn () =>
   525                "Loaded fact graph (" ^ graph_info fact_G ^ ")");
   526            {fact_G = fact_G}
   527          end
   528        | _ => empty_state)
   529     end
   530 
   531 fun save ctxt {fact_G} =
   532   let
   533     val path = mash_state_path ()
   534     fun fact_line_for name parents =
   535       escape_meta name ^ ": " ^ escape_metas parents
   536     val append_fact = File.append path o suffix "\n" oo fact_line_for
   537     fun append_entry (name, ((), (parents, _))) () =
   538       append_fact name (Graph.Keys.dest parents)
   539   in
   540     File.write path (version ^ "\n");
   541     Graph.fold append_entry fact_G ();
   542     trace_msg ctxt (fn () => "Saved fact graph (" ^ graph_info fact_G ^ ")")
   543   end
   544 
   545 val global_state =
   546   Synchronized.var "Sledgehammer_MaSh.global_state" (false, empty_state)
   547 
   548 in
   549 
   550 fun mash_map ctxt f =
   551   Synchronized.change global_state (load ctxt ##> (f #> tap (save ctxt)))
   552 
   553 fun mash_get ctxt =
   554   Synchronized.change_result global_state (load ctxt #> `snd)
   555 
   556 fun mash_unlearn ctxt =
   557   Synchronized.change global_state (fn _ =>
   558       (mash_CLEAR ctxt; wipe_out (mash_state_path ()); (true, empty_state)))
   559 
   560 end
   561 
   562 fun mash_could_suggest_facts () = mash_home () <> ""
   563 fun mash_can_suggest_facts ctxt = not (Graph.is_empty (#fact_G (mash_get ctxt)))
   564 
   565 fun queue_of xs = Queue.empty |> fold Queue.enqueue xs
   566 
   567 fun max_facts_in_graph fact_G facts =
   568   let
   569     val facts = [] |> fold (cons o nickname_of o snd) facts
   570     val tab = Symtab.empty |> fold (fn name => Symtab.update (name, ())) facts
   571     fun enqueue_new seen name =
   572       not (member (op =) seen name) ? Queue.enqueue name
   573     fun find_maxes seen maxs names =
   574       case try Queue.dequeue names of
   575         NONE => map snd maxs
   576       | SOME (name, names) =>
   577         if Symtab.defined tab name then
   578           let
   579             val new = (Graph.all_preds fact_G [name], name)
   580             fun is_ancestor (_, x) (yp, _) = member (op =) yp x
   581             val maxs = maxs |> filter (fn max => not (is_ancestor max new))
   582             val maxs =
   583               if exists (is_ancestor new) maxs then maxs
   584               else new :: filter_out (fn max => is_ancestor max new) maxs
   585           in find_maxes (name :: seen) maxs names end
   586         else
   587           find_maxes (name :: seen) maxs
   588                      (Graph.Keys.fold (enqueue_new seen)
   589                                       (Graph.imm_preds fact_G name) names)
   590   in find_maxes [] [] (queue_of (Graph.maximals fact_G)) end
   591 
   592 (* Generate more suggestions than requested, because some might be thrown out
   593    later for various reasons and "meshing" gives better results with some
   594    slack. *)
   595 fun max_suggs_of max_facts = max_facts + Int.min (200, max_facts)
   596 
   597 fun is_fact_in_graph fact_G (_, th) =
   598   can (Graph.get_node fact_G) (nickname_of th)
   599 
   600 fun mash_suggested_facts ctxt ({overlord, ...} : params) prover max_facts hyp_ts
   601                          concl_t facts =
   602   let
   603     val thy = Proof_Context.theory_of ctxt
   604     val fact_G = #fact_G (mash_get ctxt)
   605     val parents = max_facts_in_graph fact_G facts
   606     val feats = features_of ctxt prover thy (Local, General) (concl_t :: hyp_ts)
   607     val suggs =
   608       if Graph.is_empty fact_G then []
   609       else mash_QUERY ctxt overlord (max_suggs_of max_facts) (parents, feats)
   610     val selected = facts |> suggested_facts suggs
   611     val unknown = facts |> filter_out (is_fact_in_graph fact_G)
   612   in (selected, unknown) end
   613 
   614 fun add_to_fact_graph ctxt (name, parents, feats, deps) (adds, graph) =
   615   let
   616     fun maybe_add_from from (accum as (parents, graph)) =
   617       try_graph ctxt "updating graph" accum (fn () =>
   618           (from :: parents, Graph.add_edge_acyclic (from, name) graph))
   619     val graph = graph |> Graph.default_node (name, ())
   620     val (parents, graph) = ([], graph) |> fold maybe_add_from parents
   621     val (deps, graph) = ([], graph) |> fold maybe_add_from deps
   622   in ((name, parents, feats, deps) :: adds, graph) end
   623 
   624 val learn_timeout_slack = 2.0
   625 
   626 fun launch_thread timeout task =
   627   let
   628     val hard_timeout = time_mult learn_timeout_slack timeout
   629     val birth_time = Time.now ()
   630     val death_time = Time.+ (birth_time, hard_timeout)
   631     val desc = ("machine learner for Sledgehammer", "")
   632   in Async_Manager.launch MaShN birth_time death_time desc task end
   633 
   634 fun freshish_name () =
   635   Date.fmt ".%Y_%m_%d_%H_%M_%S__" (Date.fromTimeLocal (Time.now ())) ^
   636   serial_string ()
   637 
   638 fun mash_learn_proof ctxt ({overlord, timeout, ...} : params) prover t facts
   639                      used_ths =
   640   if is_smt_prover ctxt prover then
   641     ()
   642   else
   643     launch_thread timeout (fn () =>
   644         let
   645           val thy = Proof_Context.theory_of ctxt
   646           val name = freshish_name ()
   647           val feats = features_of ctxt prover thy (Local, General) [t]
   648           val deps = used_ths |> map nickname_of
   649           val {fact_G} = mash_get ctxt
   650           val parents = max_facts_in_graph fact_G facts
   651         in
   652           mash_ADD ctxt overlord [(name, parents, feats, deps)]; (true, "")
   653         end)
   654 
   655 fun sendback sub =
   656   Markup.markup Isabelle_Markup.sendback (sledgehammerN ^ " " ^ sub)
   657 
   658 val commit_timeout = seconds 30.0
   659 
   660 (* The timeout is understood in a very slack fashion. *)
   661 fun mash_learn_facts ctxt (params as {debug, verbose, overlord, ...}) prover
   662                      auto_level atp learn_timeout facts =
   663   let
   664     val timer = Timer.startRealTimer ()
   665     fun next_commit_time () =
   666       Time.+ (Timer.checkRealTimer timer, commit_timeout)
   667     val {fact_G} = mash_get ctxt
   668     val (old_facts, new_facts) =
   669       facts |> List.partition (is_fact_in_graph fact_G)
   670             ||> sort (thm_ord o pairself snd)
   671   in
   672     if null new_facts andalso (not atp orelse null old_facts) then
   673       if auto_level < 2 then
   674         "No new " ^ (if atp then "ATP" else "Isar") ^ " proofs to learn." ^
   675         (if auto_level = 0 andalso not atp then
   676            "\n\nHint: Try " ^ sendback learn_atpN ^ " to learn from ATP proofs."
   677          else
   678            "")
   679       else
   680         ""
   681     else
   682       let
   683         val all_names =
   684           facts |> map snd
   685                 |> filter_out is_likely_tautology_or_too_meta
   686                 |> map (rpair () o nickname_of)
   687                 |> Symtab.make
   688         val deps_of =
   689           if atp then
   690             atp_dependencies_of ctxt params prover auto_level facts all_names
   691           else
   692             isar_dependencies_of all_names
   693         fun do_commit [] [] state = state
   694           | do_commit adds reps {fact_G} =
   695             let
   696               val (adds, fact_G) =
   697                 ([], fact_G) |> fold (add_to_fact_graph ctxt) adds
   698             in
   699               mash_ADD ctxt overlord (rev adds);
   700               mash_REPROVE ctxt overlord reps;
   701               {fact_G = fact_G}
   702             end
   703         fun commit last adds reps =
   704           (if debug andalso auto_level = 0 then
   705              Output.urgent_message "Committing..."
   706            else
   707              ();
   708            mash_map ctxt (do_commit (rev adds) reps);
   709            if not last andalso auto_level = 0 then
   710              let val num_proofs = length adds + length reps in
   711                "Learned " ^ string_of_int num_proofs ^ " " ^
   712                (if atp then "ATP" else "Isar") ^ " proof" ^
   713                plural_s num_proofs ^ " in the last " ^
   714                string_from_time commit_timeout ^ "."
   715                |> Output.urgent_message
   716              end
   717            else
   718              ())
   719         fun learn_new_fact _ (accum as (_, (_, _, _, true))) = accum
   720           | learn_new_fact ((_, stature), th)
   721                            (adds, (parents, n, next_commit, _)) =
   722             let
   723               val name = nickname_of th
   724               val feats =
   725                 features_of ctxt prover (theory_of_thm th) stature [prop_of th]
   726               val deps = deps_of th |> these
   727               val n = n |> not (null deps) ? Integer.add 1
   728               val adds = (name, parents, feats, deps) :: adds
   729               val (adds, next_commit) =
   730                 if Time.> (Timer.checkRealTimer timer, next_commit) then
   731                   (commit false adds []; ([], next_commit_time ()))
   732                 else
   733                   (adds, next_commit)
   734               val timed_out = Time.> (Timer.checkRealTimer timer, learn_timeout)
   735             in (adds, ([name], n, next_commit, timed_out)) end
   736         val n =
   737           if null new_facts then
   738             0
   739           else
   740             let
   741               val last_th = new_facts |> List.last |> snd
   742               (* crude approximation *)
   743               val ancestors =
   744                 old_facts
   745                 |> filter (fn (_, th) => thm_ord (th, last_th) <> GREATER)
   746               val parents = max_facts_in_graph fact_G ancestors
   747               val (adds, (_, n, _, _)) =
   748                 ([], (parents, 0, next_commit_time (), false))
   749                 |> fold learn_new_fact new_facts
   750             in commit true adds []; n end
   751         fun relearn_old_fact _ (accum as (_, (_, _, true))) = accum
   752           | relearn_old_fact (_, th) (reps, (n, next_commit, _)) =
   753             let
   754               val name = nickname_of th
   755               val (n, reps) =
   756                 case deps_of th of
   757                   SOME deps => (n + 1, (name, deps) :: reps)
   758                 | NONE => (n, reps)
   759               val (reps, next_commit) =
   760                 if Time.> (Timer.checkRealTimer timer, next_commit) then
   761                   (commit false [] reps; ([], next_commit_time ()))
   762                 else
   763                   (reps, next_commit)
   764               val timed_out = Time.> (Timer.checkRealTimer timer, learn_timeout)
   765             in (reps, (n, next_commit, timed_out)) end
   766         val n =
   767           if null old_facts then
   768             n
   769           else
   770             let
   771               fun priority_of (_, th) =
   772                 random_range 0 (1000 * max_dependencies)
   773                 - 500 * (th |> isar_dependencies_of all_names
   774                             |> Option.map length
   775                             |> the_default max_dependencies)
   776               val old_facts =
   777                 old_facts |> map (`priority_of)
   778                           |> sort (int_ord o pairself fst)
   779                           |> map snd
   780               val (reps, (n, _, _)) =
   781                 ([], (n, next_commit_time (), false))
   782                 |> fold relearn_old_fact old_facts
   783             in commit true [] reps; n end
   784       in
   785         if verbose orelse auto_level < 2 then
   786           "Learned " ^ string_of_int n ^ " nontrivial " ^
   787           (if atp then "ATP" else "Isar") ^ " proof" ^ plural_s n ^
   788           (if verbose then
   789              " in " ^ string_from_time (Timer.checkRealTimer timer)
   790            else
   791              "") ^ "."
   792         else
   793           ""
   794       end
   795   end
   796 
   797 fun mash_learn ctxt (params as {provers, timeout, ...}) fact_override chained
   798                atp =
   799   let
   800     val css = Sledgehammer_Fact.clasimpset_rule_table_of ctxt
   801     val ctxt = ctxt |> Config.put instantiate_inducts false
   802     val facts =
   803       nearly_all_facts ctxt false fact_override Symtab.empty css chained []
   804                        @{prop True}
   805     val num_facts = length facts
   806     val prover = hd provers
   807     fun learn auto_level atp =
   808       mash_learn_facts ctxt params prover auto_level atp infinite_timeout facts
   809       |> Output.urgent_message
   810   in
   811     (if atp then
   812        ("MaShing through " ^ string_of_int num_facts ^ " fact" ^
   813         plural_s num_facts ^ " for ATP proofs (" ^ quote prover ^ " timeout: " ^
   814         string_from_time timeout ^ ").\n\nCollecting Isar proofs first..."
   815         |> Output.urgent_message;
   816         learn 1 false;
   817         "Now collecting ATP proofs. This may take several hours. You can \
   818         \safely stop the learning process at any point."
   819         |> Output.urgent_message;
   820         learn 0 true)
   821      else
   822        ("MaShing through " ^ string_of_int num_facts ^ " fact" ^
   823         plural_s num_facts ^ " for Isar proofs..."
   824         |> Output.urgent_message;
   825         learn 0 false))
   826   end
   827 
   828 (* The threshold should be large enough so that MaSh doesn't kick in for Auto
   829    Sledgehammer and Try. *)
   830 val min_secs_for_learning = 15
   831 
   832 fun relevant_facts ctxt (params as {learn, fact_filter, timeout, ...}) prover
   833         max_facts ({add, only, ...} : fact_override) hyp_ts concl_t facts =
   834   if not (subset (op =) (the_list fact_filter, fact_filters)) then
   835     error ("Unknown fact filter: " ^ quote (the fact_filter) ^ ".")
   836   else if only then
   837     facts
   838   else if max_facts <= 0 orelse null facts then
   839     []
   840   else
   841     let
   842       fun maybe_learn () =
   843         if learn andalso not (Async_Manager.has_running_threads MaShN) andalso
   844            Time.toSeconds timeout >= min_secs_for_learning then
   845           let val timeout = time_mult learn_timeout_slack timeout in
   846             launch_thread timeout
   847                 (fn () => (true, mash_learn_facts ctxt params prover 2 false
   848                                                   timeout facts))
   849           end
   850         else
   851           ()
   852       val fact_filter =
   853         case fact_filter of
   854           SOME ff => (() |> ff <> mepoN ? maybe_learn; ff)
   855         | NONE =>
   856           if is_smt_prover ctxt prover then mepoN
   857           else if mash_can_suggest_facts ctxt then (maybe_learn (); meshN)
   858           else if mash_could_suggest_facts () then (maybe_learn (); mepoN)
   859           else mepoN
   860       val add_ths = Attrib.eval_thms ctxt add
   861       fun prepend_facts ths accepts =
   862         ((facts |> filter (member Thm.eq_thm_prop ths o snd)) @
   863          (accepts |> filter_out (member Thm.eq_thm_prop ths o snd)))
   864         |> take max_facts
   865       fun mepo () =
   866         facts |> mepo_suggested_facts ctxt params prover max_facts NONE hyp_ts
   867                                       concl_t
   868               |> weight_mepo_facts
   869       fun mash () =
   870         mash_suggested_facts ctxt params prover max_facts hyp_ts concl_t facts
   871       val mess =
   872         [] |> (if fact_filter <> mashN then cons (mepo (), []) else I)
   873            |> (if fact_filter <> mepoN then cons (mash ()) else I)
   874     in
   875       mesh_facts max_facts mess
   876       |> not (null add_ths) ? prepend_facts add_ths
   877     end
   878 
   879 fun kill_learners () = Async_Manager.kill_threads MaShN "learner"
   880 fun running_learners () = Async_Manager.running_threads MaShN "learner"
   881 
   882 end;