Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs/everything: add documentation guidelines and apply it to the whole library #24

Merged
merged 10 commits into from Nov 10, 2015
Merged

docs/everything: add documentation guidelines and apply it to the whole library #24

merged 10 commits into from Nov 10, 2015

Conversation

hobofan
Copy link
Member

@hobofan hobofan commented Nov 9, 2015

CLOSES #13

hobofan and others added 6 commits November 4, 2015 10:37
@hobofan
fix(typo): broken link in contribution guide
0f5cc1f 
Thank you to @ehiggs for reporting!
@hobofan
feat(solver): started fleshing out sgd solver
38c7cfb
@hobofan
feat(solver): calculation of learning rate
edfbbdf 
from config

In Caffe the learning rate is calculated by the solver;
I moved the calculation into the SolverConfig because it only depends on the
current variation of the solver (which can easily be supplied) and on a lot of
config variables.
docs(all): add library documentation following new doc guides
7aa05dd 
The new Documentation and Communication Guidelines can be found here:
https://medium.com/@autumn_eng/increasing-open-source-engagement-with-structural-communication-guidelines-for-code-documentation-e72533de8e45

REFERENCE #13
REFERENCE #17

SQUASH of 11 commits
docs(layers): add documentation for layers
05580fc 
CLOSE #21
docs(lib): add project philosophie
a26e885
@GitCop
Copy link

GitCop commented Nov 9, 2015

There were the following issues with your Pull Request

  • Commit: 0f5cc1f
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 38c7cfb
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: edfbbdf
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 7aa05dd
    • Your commit message body contains a line that is longer than 100 characters
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 05580fc
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: a26e885
    • Commits must be in the following format: %{type}/%{scope}: %{description}

Guidelines are available at https://github.com/autumnai/leaf/blob/develop/CONTRIBUTING.md#git-commit-guidelines

This message was auto-generated by https://gitcop.com

@MichaelHirn
Copy link
Member

@hobofan Not acceptable. There are a lot of crucial parts missing. We need at least the following, in order to close this PR.

  • A high-level description of the Layer module (about it's architecture). Take a look to at the layers or network module
  • A high-level description for the Solver module.
  • A high-level description for the Solvers module -> similar to layers module.
  • Move Glossary from network to crate page.
  • WAY better description on how to implement new Layers, Solver (ILayer, ISolver trait). We need to make this easy.

Also

  • no TODOs in the Doc. Rather link to a issue, this allows to really keep track of things.
  • The Solver struct description in the Solver mod is broken.
  • The LRPolicy is pretty unclear in general. Needs definitly a fix.

@GitCop
Copy link

GitCop commented Nov 9, 2015

There were the following issues with your Pull Request

  • Commit: 0f5cc1f
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 38c7cfb
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: edfbbdf
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 7aa05dd
    • Your commit message body contains a line that is longer than 100 characters
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 05580fc
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: a26e885
    • Commits must be in the following format: %{type}/%{scope}: %{description}

Guidelines are available at https://github.com/autumnai/leaf/blob/develop/CONTRIBUTING.md#git-commit-guidelines

This message was auto-generated by https://gitcop.com

@GitCop
Copy link

GitCop commented Nov 10, 2015

There were the following issues with your Pull Request

  • Commit: 0f5cc1f
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 38c7cfb
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: edfbbdf
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 7aa05dd
    • Your commit message body contains a line that is longer than 100 characters
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 05580fc
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: a26e885
    • Commits must be in the following format: %{type}/%{scope}: %{description}

Guidelines are available at https://github.com/autumnai/leaf/blob/develop/CONTRIBUTING.md#git-commit-guidelines

This message was auto-generated by https://gitcop.com

@hobofan
feature/solver: implement solver and sgd
83db20d 
Set up structure for solvers; Documentation is still lacking
@GitCop
Copy link

GitCop commented Nov 10, 2015

There were the following issues with your Pull Request

  • Commit: 0f5cc1f
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 38c7cfb
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: edfbbdf
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 7aa05dd
    • Your commit message body contains a line that is longer than 100 characters
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 05580fc
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: a26e885
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 83db20d
    • Invalid type. Valid types are feat, fix, docs, style, refactor, perf, test, chore, revert

Guidelines are available at https://github.com/autumnai/leaf/blob/develop/CONTRIBUTING.md#git-commit-guidelines

This message was auto-generated by https://gitcop.com

1 similar comment
@GitCop
Copy link

GitCop commented Nov 10, 2015

There were the following issues with your Pull Request

  • Commit: 0f5cc1f
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 38c7cfb
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: edfbbdf
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 7aa05dd
    • Your commit message body contains a line that is longer than 100 characters
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 05580fc
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: a26e885
    • Commits must be in the following format: %{type}/%{scope}: %{description}
  • Commit: 83db20d
    • Invalid type. Valid types are feat, fix, docs, style, refactor, perf, test, chore, revert

Guidelines are available at https://github.com/autumnai/leaf/blob/develop/CONTRIBUTING.md#git-commit-guidelines

This message was auto-generated by https://gitcop.com

@hobofan
Copy link
Member Author

hobofan commented Nov 10, 2015

@homu r+

@homu
Copy link
Collaborator

homu commented Nov 10, 2015

📌 Commit 58bfa92 has been approved by hobofan

@homu
Copy link
Collaborator

homu commented Nov 10, 2015

⌛ Testing commit 58bfa92 with merge dcea61d...

homu added a commit that referenced this pull request Nov 10, 2015
@homu
Auto merge of #24 - autumnai:docs, r=hobofan
dcea61d 
docs/everything: add documentation guidelines and apply it to the whole library

CLOSES #13
@homu
Copy link
Collaborator

homu commented Nov 10, 2015

☀️ Test successful - status

@homu homu merged commit 58bfa92 into master Nov 10, 2015
@hobofan hobofan deleted the docs branch December 8, 2015 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@hobofan @GitCop @MichaelHirn @homu