Giter Club home page Giter Club logo

Comments (6)

Pratyush avatar Pratyush commented on September 27, 2024 3

Hmm I disagree somewhat. See, for example: https://doc-internal.dalek.rs/bulletproofs/notes/index.html

from algebra.

Pratyush avatar Pratyush commented on September 27, 2024

I have some in-progress documentation for the curve constants, but more information about the underlying constants would definitely be useful!

I think it would be best to add these as doc-comments, because this should show up in documentation generated by cargo doc.

from algebra.

jon-chuang avatar jon-chuang commented on September 27, 2024

To give an example of what I have in mind, check out spinning up's docs, e.g. for PPO. As you can see, there is fairly lengthy exposition which is not suitable for doc-comments. I think doc-comments are more suitable for API documentation.

Perhaps I should add a docs folder, I'll see what nice tools there are to generate suitable docs.

from algebra.

jon-chuang avatar jon-chuang commented on September 27, 2024

Actually, those docs are generated by files in a docs folder, see https://doc-internal.dalek.rs/src/bulletproofs/lib.rs.html. Nevertheless, I like the dalek docs too.

Where can they be hosted? https://docs.rs/ is available only if you are on crates.io. Apparently one can use Travis CI + github pages

from algebra.

UlrichHaboeck75 avatar UlrichHaboeck75 commented on September 27, 2024

I double-checked the constants for (almost all) Zexe implemented curves using Wolfram Mathematica. I plan to translate these to either sage or Magma in near future, and can add the files to the Zexe repo, too.

from algebra.

Pratyush avatar Pratyush commented on September 27, 2024

Cool, that would be greatly appreciated =)

from algebra.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.