search

Mikolaj / horde-ad

Higher Order Reverse Derivatives Efficiently - Automatic Differentiation library based on the paper "Provably correct, asymptotically efficient, higher-order reverse-mode automatic differentiation"
BSD 3-Clause "New" or "Revised" License
33 stars 6 forks source link

Piece together a new README from Andrew's version and other's comments #75

Closed Mikolaj closed 1 year ago

Mikolaj commented 2 years ago

Edit2: The ugly code bits are subdued enough that the README is not a lie any more. Ready for review.

Edit: Rendered version of the new REAMDE is at https://github.com/Mikolaj/horde-ad/tree/Andrews-README-NG

The code has mostly caught up with your aspirational vision and with the fine comments in #53 and #64 (both of which are meant to be by superseded by this PR), but ugly bits are still showing up, so this PR is a draft until the relevant code is finalized and then the review loop will start for the current user interface and its presentation in the README.

Mikolaj commented 1 year ago

@awf, @tomjaguarpaw, @goldfirere and everybody, please kindly review.

This README rewrite is based on Andrew's #53 draft, @tomjaguarpaw's adaptors, @goldfirere's StaticNat (#56) and, I think, it addresses all your comments in #53 and #64.

Mikolaj commented 1 year ago

I'm going to merge, for the sake of new users, but please do review. I hope a closed PR does not prevent leaving review comments.