Merge pull request #166 from uwplse/develop

Release Herbie 1.1

Author: pavpanchekha

.travis.yml

@@ -15,25 +15,29 @@ env:
       HERBIE_SEED="#(2749829514 1059579101 312104142 915324965 966790849 1349306526)"
     - RACKET_VERSION="6.5"
       HERBIE_SEED="#(2749829514 1059579101 312104142 915324965 966790849 1349306526)"
-    - RACKET_VERSION="6.5"
+    - RACKET_VERSION="6.6"
+      HERBIE_SEED="#(2749829514 1059579101 312104142 915324965 966790849 1349306526)"
+    - RACKET_VERSION="6.7"
+      HERBIE_SEED="#(2749829514 1059579101 312104142 915324965 966790849 1349306526)"
+    - RACKET_VERSION="6.7"
       HERBIE_SEED="#f"
 matrix:
   allow_failures:
-    - env: RACKET_VERSION="6.5"
+    - env: RACKET_VERSION="6.7"
            HERBIE_SEED="#f"
 before_install:
   - git clone https://github.com/greghendershott/travis-racket.git ../travis-racket
   - cat ../travis-racket/install-racket.sh | bash
   - export PATH="${RACKET_DIR}/bin:${PATH}"
-  - docker load -i docker-images/herbie.image || true
+# - docker load -i docker-images/herbie.image || true
 install:
   - raco pkg install --auto $TRAVIS_BUILD_DIR/src
-  - docker build -t herbie .
+# - docker build -t herbie .
 script:
   - raco test src
   - racket $TRAVIS_BUILD_DIR/infra/travis.rkt --seed "${HERBIE_SEED}" bench/tutorial.fpcore bench/hamming/
-before_cache:
-  - docker save -o docker-images/herbie.image herbie
+#before_cache:
+# - docker save -o docker-images/herbie.image herbie
 notifications:
   slack:
     secure: QB8ib/gxZWZ8rY9H54BktIgx8LfjdqabSAkmWip0VHlUhrh2ULG566XgmB5h75eNzCil2cw76ma5wfSC0MNIQ1iDHKCxAgTE0+gcPcZAYGfucQ28sKGBG2wcuJfvBLG6lVDxj+luGUh3XohouTLYI9cg509JBgTgpcrXVexYAaE=

Dockerfile

@@ -1,8 +1,8 @@
-FROM jackfirth/racket
+FROM jackfirth/racket:6.8
 MAINTAINER Pavel Panchekha <[email protected]>
 RUN apt-get update \
  && apt-get install -y libcairo2-dev libjpeg62 libpango1.0-dev \
  && rm -rf /var/lib/apt/lists/*
 ADD src /src/herbie
 RUN raco pkg install --auto /src/herbie
-ENTRYPOINT ["raco", "herbie"]
+ENTRYPOINT ["racket", "/src/herbie/herbie.rkt"]

Makefile

@@ -2,10 +2,18 @@
 
 all:
 	@echo "Type 'make install' to install Herbie as a Racket package,"
-	@echo "just run 'racket src/herbie.rkt' to run Herbie."
+	@echo "Run 'racket src/herbie.rkt shell' to run Herbie."
 
 install:
-	raco pkg install --auto $TRAVIS_BUILD_DIR/src
+	raco pkg install --name herbie src/
+
+update:
+	raco pkg update --name herbie src/
+
+herbie.zip herbie.zip.CHECKSUM:
+	raco pkg create src/
+	mv src.zip herbie.zip
+	mv src.zip.CHECKSUM herbie.zip.CHECKSUM
 
 clean:
 	rm -f cost
@@ -16,7 +24,10 @@ publish:
 	bash infra/publish.sh index
 
 start-server:
-	racket src/web/demo.rkt >> infra/server.log
+	racket src/herbie.rkt web --seed '#(2775764126 3555076145 3898259844 1891440260 2599947619 1948460636)' --timeout 60 --demo --prefix /demo/ --port 4053 --save-session www/demo/ --log infra/server.log --quiet 2>&1
+
+package:
+	raco pkg 
 
 loc:
 	find herbie/ -type f -exec cat {} \; | wc -l

README.md

@@ -2,113 +2,107 @@
 
 Herbie synthesizes floating-point programs from real-number programs,
 automatically handling simple numerical instabilities.
+Visit [our website](https://herbie.uwplse.org) for tutorials,
+documentation, and an online demo.
 
 Current Status
 --------------
 
 [![Build Status](https://travis-ci.org/uwplse/herbie.svg?branch=master)](https://travis-ci.org/uwplse/herbie)
 
-Herbie can improve the accuracy of many real-world programs,
-and is used by scientists in many disciplines.
-It has lead to two patches
-(for complex [square roots](https://github.com/josdejong/mathjs/pull/208)
-and [trigonometric functions](https://github.com/josdejong/mathjs/pull/247)),
+Herbie can improve the accuracy of many real-world programs, and is
+used by scientists in many disciplines. It has lead to two patches
+(for
+complex [square roots](https://github.com/josdejong/mathjs/pull/208)
+and
+[trigonometric functions](https://github.com/josdejong/mathjs/pull/247)),
 in [math.js](http://mathjs.org/) an open-source mathematics library.
+Herbie has semi-regular releases twice a year, maintains backwards
+compatibility, and uses standardized formats.
 
 Helping Out
 -----------
 
-Herbie is organized on
-[Github](https://github.com/uwplse/herbie) and
-[Trello](https://trello.com/b/lh7b33Dr/herbie).
-We also have a
+Herbie development is organized on our
 [mailing list](https://mailman.cs.washington.edu/mailman/listinfo/herbie)
-where we discuss Herbie's development and announce major improvements.
-Our test results are on
-[uwplse.org](http://herbie.uwplse.org/reports/).
+where we discuss work in progress and announce major improvements.
+[Email us](mailto:[email protected]) to get involved!
 
-Email [Zach Tatlock](mailto:[email protected]) to get involved.
-He’ll set you up with access to these tools.
+We use [Github](https://github.com/uwplse/herbie)
+and [Trello](https://trello.com/b/lh7b33Dr/herbie) to organize some
+development goals Our test results
+are [archived](http://herbie.uwplse.org/reports/).
 
 Installing
 ----------
 
-Herbie requires Racket 6.3 or later, and works best on Linux.
+For full details on installing Herbie, please see the
+[tutorial](http://herbie.uwplse.org/doc/latest/installing-herbie.html).
 
-No installation is needed; just download the source code and you're
-ready to go.
+Herbie requires Racket 6.3 or later, and supports Linux and OS X.
+Install it with:
 
-Upgrading
----------
+    raco pkg install herbie
 
-Herbie 1.0 differs from previous versions by having a new input
-format. Herbie now uses the FPCore standard for floating point tools.
-To convert existing files to the new format, use:
-
-    racket infra/convert.rkt [file].rkt > [file].fpcore
+This will install a `herbie` binary to somewhere in your home
+directory. You can also run `src/herbie.rkt` directly instead of using
+the `herbie` command, for example if you'd like to download the source
+directly instead of through the package manager.
 
 Running Herbie
 --------------
 
-For details on how to run Herbie, please see the
-[tutorial](http://herbie.uwplse.org/doc/latest/using-herbie.html).
+For full details on running Herbie, please see the
+[tutorial](http://herbie.uwplse.org/doc/latest/using-web.html).
 
-The format of input files is a Scheme-based language;
-you can find several examples in `bench/`.
-For example, consider this simple cancellation test
+Herbie's input is a Scheme-based language called [FPCore](http://fpbench.org/spec/fpcore-1.0.html);
+you can several examples in `bench/`.
+For example, consider this simple expression:
 
     (FPCore (x)
       (- (+ 1 x) x))
 
-Run Herbie from the top-level directory of the repo:
+Run Herbie from the top-level directory of the repo, and enter the
+cancellation test:
 
-    $ racket src/herbie.rkt
+    $ herbie shell
     Seed: #(1046809171 2544984934 1871826185 4237421819 4093186437 162666889)
+    herbie> (FPCore (x) (- (+ 1 x) x))
+    (FPCore (x) 1)
 
-You can now enter the cancellation test:
-
-    $ racket src/herbie.rkt
-    Seed: #(1046809171 2544984934 1871826185 4237421819 4093186437 162666889)
-    (FPCore (x)
-      (- (+ 1 x) x))
-    [ 1673.401ms]   (29→ 0) Cancel like terms
-    (λ (x) 1)
-
-The final is Herbie's improved, more-accurate expression, in this case
+The output is Herbie's improved, more-accurate expression, in this case
 the constant `1`.
 
-You can also save expressions to a file and run them with
-
-    racket src/herbie.rkt [file]
+Besides the `shell`, Herbie also has a `web` interface, and can run on
+files of FPCore expressions with the `improve` and `report` commands.
+Consult the
+[documentation](http://herbie.uwplse.org/doc/latest/options.html).
+for more.
 
 Running Tests
 -------------
 
-Herbie draws its test suite from open source projects, examples emailed
-to the developers, and from numerical analysis textbooks. Whenever
-possible, we try to *extract all possible tests* from a source, to
-avoid biasing our selection of tests. To run the tests, go to the
-project root and run
+Herbie contains unit tests to test basic functionality, though
+coverage is far from complete. You can run the test suite with:
 
-    racket infra/travis.rkt [file]
+    raco test src/
 
-Herbie's main tests are integration tests that test Herbie end-to-end.
-They are the benchmarks that ship in the `bench/` directory.
+Herbie also contains a large integration suite from open source
+projects, examples emailed to the developers, and from numerical
+analysis textbooks. This suite is found in `bench/`. The full test can
+be run with
 
-We often test Herbie on basic but representative examples with:
+    herbie report bench/
 
-    racket infra/travis.rkt bench/hamming/
+This full test can take several hours to run. We often test Herbie on
+basic but representative examples with:
 
-This takes approximately 15 minutes.
-To run all of the default benchmarks, use:
+    herbie report bench/hamming/
 
-    racket infra/travis.rkt bench/
-
-This can take a few hours or more.
+This takes approximately 15 minutes.
 
 Test results are collected on
-[uwplse.org](http://herbie.uwplse.org/reports/).
-If you have an account on this server, you can publish your test
-report with
+[uwplse.org](http://herbie.uwplse.org/reports/). If you have an
+account on this server, you can publish your test results with
 
     make publish

bench/hamming/machine-decide.fpcore

@@ -1,9 +1,10 @@
-(FPCore
- (a x)
- :name
- "NMSE section 3.5"
+; -*- mode: scheme -*-
+
+(FPCore (a x)
+ :name "expax (section 3.5)"
  :target
  (if (< (fabs (* a x)) 1/10)
    (* (* a x) (+ 1 (+ (/ (* a x) 2) (/ (sqr (* a x)) 6))))
    (- (exp (* a x)) 1))
+
  (- (exp (* a x)) 1))

bench/hamming/machine-decide.rkt

@@ -1,7 +1,8 @@
-(FPCore
- (x)
- :name
- "NMSE section 3.11"
+; -*- mode: scheme -*-
+
+(FPCore (x)
+ :name "expq2 (section 3.11)"
  :target
  (/ 1 (- 1 (exp (- x))))
+
  (/ (exp x) (- (exp x) 1)))

bench/hamming/overflow-underflow.fpcore

@@ -1,28 +1,32 @@
-(FPCore
- (a b c)
- :name
- "NMSE p42, positive"
+; -*- mode: scheme -*-
+
+(FPCore (a b c)
+ :name "quadp (p42, positive)"
  :target
- (let ((d (sqrt (- (sqr b) (* 4 (* a c))))))
-   (let ((r1 (/ (+ (- b) d) (* 2 a))))
-     (let ((r2 (/ (- (- b) d) (* 2 a)))) (if (< b 0) r1 (/ c (* a r2))))))
- (let ((d (sqrt (- (sqr b) (* 4 (* a c)))))) (/ (+ (- b) d) (* 2 a))))
-(FPCore
- (a b c)
- :name
- "NMSE p42, negative"
+ (let ([d (sqrt (- (sqr b) (* 4 (* a c))))])
+   (let ([r1 (/ (+ (- b) d) (* 2 a))]
+         [r2 (/ (- (- b) d) (* 2 a))])
+     (if (< b 0) r1 (/ c (* a r2)))))
+
+ (let ([d (sqrt (- (sqr b) (* 4 (* a c))))])
+   (/ (+ (- b) d) (* 2 a))))
+
+(FPCore (a b c)
+ :name "quadm (p42, negative)"
  :target
  (let ((d (sqrt (- (sqr b) (* 4 (* a c))))))
-   (let ((r1 (/ (+ (- b) d) (* 2 a))))
-     (let ((r2 (/ (- (- b) d) (* 2 a)))) (if (< b 0) (/ c (* a r1)) r2))))
- (let ((d (sqrt (- (sqr b) (* 4 (* a c)))))) (/ (- (- b) d) (* 2 a))))
-(FPCore
- (a b/2 c)
- :name
- "NMSE problem 3.2.1, negative"
- (let ((d (sqrt (- (sqr b/2) (* a c))))) (/ (- (- b/2) d) a)))
-(FPCore
- (a b/2 c)
- :name
- "NMSE problem 3.2.1, positive"
- (let ((d (sqrt (- (sqr b/2) (* a c))))) (/ (+ (- b/2) d) a)))
+   (let ([r1 (/ (+ (- b) d) (* 2 a))] [r2 (/ (- (- b) d) (* 2 a))])
+     (if (< b 0) (/ c (* a r1)) r2)))
+
+ (let ([d (sqrt (- (sqr b) (* 4 (* a c))))])
+   (/ (- (- b) d) (* 2 a))))
+
+(FPCore (a b/2 c)
+ :name "quad2m (problem 3.2.1, negative)"
+ (let ([d (sqrt (- (sqr b/2) (* a c)))])
+   (/ (- (- b/2) d) a)))
+
+(FPCore (a b/2 c)
+ :name "quad2p (problem 3.2.1, positive)"
+ (let ([d (sqrt (- (sqr b/2) (* a c)))])
+   (/ (+ (- b/2) d) a)))