Skip to content

Documentation #65

Open
Open

Description

@nicholas-leonard

Each function should be documented in the README, instead of just inline. There should also be a link for each optimization function to the original paper.

Activity

  1. scabi commented on Dec 9, 2015

    @scabi
    Contributor

    Made some small progress on documentation. Let me know what you think and what is missing.

  2. nicholas-leonard commented on Dec 9, 2015

    @nicholas-leonard
    MemberAuthor

    @scabi That looks awesome! Wouldn't call it small.

  3. scabi commented on Dec 9, 2015

    @scabi
    Contributor

    Thanks! It was mostly copy paste from the code though. Any more ideas to improve the documentation? I am willing to help in the next few months.

  4. nicholas-leonard commented on Dec 9, 2015

    @nicholas-leonard
    MemberAuthor

    @scabi The next thing would be more examples. You could add an examples/ folder and put some concrete examples in there.

  5. scabi commented on Dec 9, 2015

    @scabi
    Contributor

    I think some iTorch notebooks would be the best option for examples. Torch roadmap document says "Tutorials: provide guidelines and basic framework/standard to write and publish tutorials?" Is there any progress on this?

  6. nicholas-leonard commented on Dec 9, 2015

    @nicholas-leonard
    MemberAuthor

    Nope. Which means you can pretty much do it as you want, subject to the constraint that your PR gets merged XD

  7. scabi commented on Dec 9, 2015

    @scabi
    Contributor

    Got it. I'll look into it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions