Merge branch 'main' into kalman-filter-benchmarks

Author: AYadrov

AGENT.md

@@ -0,0 +1,45 @@
+
+# Testing
+
+- Run `make fmt` to format the code before presentingcode. This is
+  mandatory and PRs that don't follow the coding style are rejected.
+- Run `racket src/main.rkt report bench/tutorial.fpcore tmp` to test
+  that your changes work; this should take about 5-10 seconds and all
+  of the tests should pass, getting basically perfect accuracy.
+- You can also run the unit tests with `raco test <file>`, when unit
+  tests exist. Often they don't.
+
+# Profiling
+
+- Herbie generates a profile by default; run the `report` command
+  above and look at `tmp/<benchmark>/profile.json`.
+- You can also run with `--enable dump:trace` to output
+  `dump-trace.json` in chrome://tracing format
+- Additionally `--enable dump:rival` outputs all Rival commands it
+  executes, which can be useful for debugging Rival &
+  arbitrary-precision code.
+  
+# Timeline
+
+- The timeline is Herbie's observability tooling. Timeline information
+  goes into `timeline.json` and `timeline.html`.
+- A timeline is a list of phases, each of which is a hash table from
+  key to "table", where a table is a list of rows each of which is a
+  fixed-length array. Define new timeline types in
+  `src/utils/timeline.rkt` and add/change HTML generation in
+  `src/reports/timeline.rkt`.
+- Add to the timeline with `(timeline-push! 'type val1 val2 ...)`. The
+  `val`s must be JSON-compatible; this mostly means you have to
+  convert symbols to strings.
+
+# Documentation
+
+- Documentation lives in `www/doc/2.3/` and is HTML-formatted. Update
+  it if you change any user-visible options.
+
+# PRs
+
+- PR descriptions should be 1-3 paragraphs in length. Describe the
+  current behavior and why you changed it. Avoid bullet points.
+- Be explicit about the expected impact: "should be faster", "should
+  be more accurate", "pure refactor, no changes", and so on.

AGENTS.md

@@ -236,7 +236,7 @@
      job-id]
     [(list 'count) (hash-count queued-jobs)]
     [(list 'improve)
-     (for/list ([(job-id result) (in-hash completed-jobs)]
+     (for/list ([result (in-hash-values completed-jobs)]
                 #:when (equal? (hash-ref result 'command) "improve"))
        result)]
     [(list 'forget job-id)
@@ -368,7 +368,7 @@
        ; Retrieve the improve results for results.json
        [(list 'improve handler)
         (define improved-list
-          (for/list ([(job-id result) (in-hash completed-jobs)]
+          (for/list ([result (in-hash-values completed-jobs)]
                      #:when (equal? (hash-ref result 'command) "improve"))
             result))
         (place-channel-put handler improved-list)]

src/api/server.rkt

@@ -180,12 +180,10 @@
                  (λ (brf recurse)
                    (define node (deref brf))
                    (define node* (f node))
-                   (define brf*
-                     (let loop ([node* node*])
-                       (match node*
-                         [(? batchref? brf) (recurse brf)]
-                         [_ (batch-push! out (expr-recurse node* (compose batchref-idx loop)))])))
-                   brf*)))
+                   (let loop ([node* node*])
+                     (match node*
+                       [(? batchref? brf) (recurse brf)]
+                       [_ (batch-push! out (expr-recurse node* (compose batchref-idx loop)))])))))
 
 ;; Allocates new batch
 (define (batch-apply b brfs f)

src/core/batch.rkt

@@ -666,10 +666,11 @@
         (vector-set! id->eclass id (cons enode* (vector-ref id->eclass id)))
         (match enode*
           [(list _ ids ...)
-           (if (null? ids)
-               (vector-set! id->leaf? id #t)
-               (for ([child-id (in-list ids)])
-                 (vector-set! id->parents child-id (cons id (vector-ref id->parents child-id)))))]
+           #:when (null? ids)
+           (vector-set! id->leaf? id #t)]
+          [(list _ ids ...)
+           (for ([child-id (in-list ids)])
+             (vector-set! id->parents child-id (cons id (vector-ref id->parents child-id))))]
           [(? symbol?) (vector-set! id->leaf? id #t)]
           [(? number?) (vector-set! id->leaf? id #t)]))))
 
@@ -1108,7 +1109,11 @@
 
 ;; Is fractional with odd denominator.
 (define (fraction-with-odd-denominator? frac)
-  (and (rational? frac) (let ([denom (denominator frac)]) (and (> denom 1) (odd? denom)))))
+  (cond
+    [(rational? frac)
+     (define denom (denominator frac))
+     (and (> denom 1) (odd? denom))]
+    [else #f]))
 
 ;; Decompose an e-node representing an impl of `(pow b e)`.
 ;; Returns either `#f` or the `(cons b e)`

src/core/egg-herbie.rkt

@@ -94,6 +94,13 @@
                  machine
                  dump-file))
 
+(define (bigfloat->readable-string x)
+  (define real (bigfloat->real x)) ; Exact rational unless inf/nan
+  (define float (real->double-flonum real))
+  (if (= real float)
+      (format "#i~a" float) ; The #i explicitly means nearest float
+      (number->string real))) ; Backup is print as rational
+
 ;; Runs a Rival machine on an input point.
 (define (real-apply compiler pt [hint #f])
   (match-define (real-compiler _ vars var-reprs _ _ machine dump-file) compiler)
@@ -104,9 +111,8 @@
                  [repr (in-vector var-reprs)])
       ((representation-repr->bf repr) val)))
   (when dump-file
-    (define args (map bigfloat->rational (vector->list pt*)))
-    ;; convert to rational, because Rival reads as exact
-    (pretty-print `(eval f ,@args) dump-file 1))
+    (define args (map bigfloat->readable-string (vector->list pt*)))
+    (fprintf dump-file "(eval f ~a)\n" (string-join args " ")))
   (define-values (status value)
     (with-handlers ([exn:rival:invalid? (lambda (e) (values 'invalid #f))]
                     [exn:rival:unsamplable? (lambda (e) (values 'exit #f))])
@@ -128,11 +134,15 @@
     (define name (symbol->string (execution-name execution)))
     (define precision
       (- (execution-precision execution) (remainder (execution-precision execution) prec-threshold)))
-    (timeline-push!/unsafe 'mixsample (execution-time execution) name precision))
+    (timeline-push!/unsafe 'mixsample
+                           (execution-time execution)
+                           name
+                           precision
+                           (execution-memory execution)))
   (timeline-push!/unsafe 'outcomes
                          (- (current-inexact-milliseconds) start)
                          (rival-profile machine 'iterations)
-                         (~a status)
+                         (symbol->string status)
                          1)
   (values status value))